doc.go 1.0 KB

12345678910111213141516171819202122
  1. // Package dht implements a Distributed Hash Table (DHT) part of
  2. // the BitTorrent protocol,
  3. // as specified by BEP 5: http://www.bittorrent.org/beps/bep_0005.html
  4. //
  5. // BitTorrent uses a "distributed hash table" (DHT)
  6. // for storing peer contact information for "trackerless" torrents.
  7. // In effect, each peer becomes a tracker.
  8. // The protocol is based on Kademila DHT protocol and is implemented over UDP.
  9. //
  10. // Please note the terminology used to avoid confusion.
  11. // A "peer" is a client/server listening on a TCP port that
  12. // implements the BitTorrent protocol.
  13. // A "node" is a client/server listening on a UDP port implementing
  14. // the distributed hash table protocol.
  15. // The DHT is composed of nodes and stores the location of peers.
  16. // BitTorrent clients include a DHT node, which is used to contact other nodes
  17. // in the DHT to get the location of peers to
  18. // download from using the BitTorrent protocol.
  19. //
  20. // Standard use involves creating a Server, and calling Announce on it with
  21. // the details of your local torrent client and infohash of interest.
  22. package dht