peer

Documentation

Index

• type Message
• type Peer
  • func New(p *peerconn.Conn, source Source, id [20]byte, extensions [8]byte, ...) *Peer
  • func (p *Peer) CancelPiece(index, begin, length uint32)
  • func (p *Peer) Choke()
  • func (p *Peer) Choking() bool
  • func (p *Peer) Close()
  • func (p *Peer) Done() chan struct{}
  • func (p *Peer) DownloadSpeed() uint
  • func (p *Peer) Interested() bool
  • func (p *Peer) MetadataSize() uint32
  • func (p *Peer) Optimistic() bool
  • func (p *Peer) RequestMetadataPiece(index uint32)
  • func (p *Peer) RequestPiece(index, begin, length uint32)
  • func (p *Peer) ResetSnubTimer()
  • func (p *Peer) Run(messages chan Message, pieces chan interface{}, snubbed, disconnect chan *Peer)
  • func (p *Peer) SetOptimistic(value bool)
  • func (p *Peer) StartPEX(initialPeers map[*Peer]struct{})
  • func (p *Peer) StopSnubTimer()
  • func (p *Peer) Unchoke()
  • func (p *Peer) UploadSpeed() uint
• type PieceMessage
• type Source
  • func (s Source) String() string

Types

type Message

type Message struct {
	*Peer
	Message interface{}
}

type Peer

type Peer struct {
	*peerconn.Conn

	ConnectedAt time.Time

	Source Source

	Bitfield    *bitfield.Bitfield
	AllowedFast pieceset.PieceSet

	ID                [20]byte
	ExtensionsEnabled bool
	FastEnabled       bool
	EncryptionCipher  mse.CryptoMethod

	ClientInterested bool
	ClientChoking    bool
	PeerInterested   bool
	PeerChoking      bool

	OptimisticUnchoked bool

	// Snubbed means peer is sending pieces too slow.
	Snubbed bool

	Downloading bool

	// Messages received while we don't have info yet are saved here.
	Messages []interface{}

	ExtensionHandshake *peerprotocol.ExtensionHandshakeMessage

	PEX *pex
	// contains filtered or unexported fields
}

func New

func New(p *peerconn.Conn, source Source, id [20]byte, extensions [8]byte, cipher mse.CryptoMethod, snubTimeout time.Duration) *Peer

func (*Peer) CancelPiece

func (p *Peer) CancelPiece(index, begin, length uint32)

func (*Peer) Choke

func (p *Peer) Choke()

func (*Peer) Choking

func (p *Peer) Choking() bool

func (*Peer) Close

func (p *Peer) Close()

func (*Peer) Done

func (p *Peer) Done() chan struct{}

func (*Peer) DownloadSpeed

func (p *Peer) DownloadSpeed() uint

func (*Peer) Interested

func (p *Peer) Interested() bool

func (*Peer) MetadataSize

func (p *Peer) MetadataSize() uint32

func (*Peer) Optimistic

func (p *Peer) Optimistic() bool

func (*Peer) RequestMetadataPiece

func (p *Peer) RequestMetadataPiece(index uint32)

func (*Peer) RequestPiece

func (p *Peer) RequestPiece(index, begin, length uint32)

func (*Peer) ResetSnubTimer

func (p *Peer) ResetSnubTimer()

func (*Peer) Run

func (p *Peer) Run(messages chan Message, pieces chan interface{}, snubbed, disconnect chan *Peer)

func (*Peer) SetOptimistic

func (p *Peer) SetOptimistic(value bool)

func (*Peer) StartPEX

func (p *Peer) StartPEX(initialPeers map[*Peer]struct{})

func (*Peer) StopSnubTimer

func (p *Peer) StopSnubTimer()

func (*Peer) Unchoke

func (p *Peer) Unchoke()

func (*Peer) UploadSpeed

func (p *Peer) UploadSpeed() uint

type PieceMessage

type PieceMessage struct {
	*Peer
	Piece peerreader.Piece
}

type Source

type Source int

const (
	SourceTracker Source = iota
	SourceDHT
	SourcePEX
	SourceManual
	SourceIncoming
)

func (Source) String

func (s Source) String() string