peer-impl.go

   1 package torrent
   2
   3 import (
   4         "github.com/RoaringBitmap/roaring"
   5         "github.com/anacrolix/torrent/metainfo"
   6 )
   7
   8 // Contains implementation details that differ between peer types, like Webseeds and regular
   9 // BitTorrent protocol connections. Some methods are underlined so as to avoid collisions with
  10 // legacy PeerConn methods.
  11 type peerImpl interface {
  12         // Trigger the actual request state to get updated
  13         handleUpdateRequests()
  14         // Whether the outstanding local request cardinality is low enough to warrant an update.
  15         isLowOnRequests() bool
  16         writeInterested(interested bool) bool
  17
  18         // _cancel initiates cancellation of a request and returns acked if it expects the cancel to be
  19         // handled by a follow-up event.
  20         _cancel(RequestIndex) (acked bool)
  21         _request(Request) bool
  22         connectionFlags() string
  23         onClose()
  24         onGotInfo(*metainfo.Info)
  25         drop()
  26         String() string
  27         connStatusString() string
  28
  29         // All if the peer should have everything, known if we know that for a fact. For example, we can
  30         // guess at how many pieces are in a torrent, and assume they have all pieces based on them
  31         // having sent haves for everything, but we don't know for sure. But if they send a have-all
  32         // message, then it's clear that they do.
  33         peerHasAllPieces() (all, known bool)
  34         peerPieces() *roaring.Bitmap
  35 }