tracker/tracker.go

   1 package tracker
   2
   3 import (
   4         "errors"
   5         "net"
   6         "net/url"
   7 )
   8
   9 // Marshalled as binary by the UDP client, so be careful making changes.
  10 type AnnounceRequest struct {
  11         InfoHash   [20]byte
  12         PeerId     [20]byte
  13         Downloaded int64
  14         Left       uint64
  15         Uploaded   int64
  16         Event      AnnounceEvent
  17         IPAddress  int32
  18         Key        int32
  19         NumWant    int32 // How many peer addresses are desired. -1 for default.
  20         Port       uint16
  21 } // 82 bytes
  22
  23 type AnnounceResponse struct {
  24         Interval int32 // Minimum seconds the local peer should wait before next announce.
  25         Leechers int32
  26         Seeders  int32
  27         Peers    []Peer
  28 }
  29
  30 type AnnounceEvent int32
  31
  32 func (me AnnounceEvent) String() string {
  33         // See BEP 3, "event".
  34         return []string{"empty", "completed", "started", "stopped"}[me]
  35 }
  36
  37 type Peer struct {
  38         IP   net.IP
  39         Port int
  40 }
  41
  42 const (
  43         None      AnnounceEvent = iota
  44         Completed               // The local peer just completed the torrent.
  45         Started                 // The local peer has just resumed this torrent.
  46         Stopped                 // The local peer is leaving the swarm.
  47 )
  48
  49 type Client interface {
  50         // Returns ErrNotConnected if Connect needs to be called.
  51         Announce(*AnnounceRequest) (AnnounceResponse, error)
  52         Connect() error
  53         String() string
  54         URL() string
  55 }
  56
  57 var (
  58         ErrNotConnected = errors.New("not connected")
  59         ErrBadScheme    = errors.New("unknown scheme")
  60
  61         schemes = make(map[string]func(*url.URL) Client)
  62 )
  63
  64 func RegisterClientScheme(scheme string, newFunc func(*url.URL) Client) {
  65         schemes[scheme] = newFunc
  66 }
  67
  68 // Returns ErrBadScheme if the tracker scheme isn't recognised.
  69 func New(rawurl string) (cl Client, err error) {
  70         url_s, err := url.Parse(rawurl)
  71         if err != nil {
  72                 return
  73         }
  74         newFunc, ok := schemes[url_s.Scheme]
  75         if !ok {
  76                 err = ErrBadScheme
  77                 return
  78         }
  79         cl = newFunc(url_s)
  80         return
  81 }