bittorrent

type AddressFamily ¶

type AddressFamily uint8

AddressFamily is the address family of an IP address.

const (
	IPv4 AddressFamily = iota
	IPv6
)

type AnnounceRequest ¶

type AnnounceRequest struct {
	Event           string
	InfoHash        InfoHash
	Compact         bool
	EventProvided   bool
	NumWantProvided bool
	IPProvided      bool
	NumWant         uint32
	Left            uint64
	Downloaded      uint64
	Uploaded        uint64
	NoPeerId        bool
	Expiry          int64
	IsIPv6          bool
	Peer
}

AnnounceRequest represents the parsed parameters from an announce request.

type AnnounceResponse ¶

type AnnounceResponse struct {
	Compact     bool
	Complete    uint32
	Incomplete  uint32
	Interval    time.Duration
	MinInterval time.Duration
	IPv4Peers   []Peer
	IPv6Peers   []Peer
}

AnnounceResponse represents the parameters used to create an announce response.

type ClientError ¶

type ClientError string

ClientError represents an error that should be exposed to the client over the BitTorrent protocol implementation.

func (c ClientError) Error() string

type ClientID ¶

type ClientID [6]byte

ClientID represents the part of a PeerID that identifies a Peer's client software.

func NewClientID(pid PeerID) ClientID

type IP ¶

type IP struct {
	IP string
	AddressFamily
}

IP is a net.IP with an AddressFamily.

type InfoHash ¶

type InfoHash [20]byte

InfoHash represents an infohash.

func InfoHashFromBytes(b []byte) InfoHash

func InfoHashFromString(s string) InfoHash

func (i InfoHash) RawString() string

func (i InfoHash) String() string

type Peer ¶

type Peer struct {
	ID         PeerID
	IP         IP
	Port       uint16
	Complete   bool
	Downloaded uint64
	Uploaded   uint64
}

Peer represents the connection details of a peer that is returned in an announce response.

func (p Peer) Equal(x Peer) bool

func (p Peer) EqualEndpoint(x Peer) bool

func (p Peer) String() string

type PeerID ¶

type PeerID [20]byte

PeerID represents a peer ID.

func PeerIDFromBytes(b []byte) PeerID

func PeerIDFromString(s string) PeerID

func (p PeerID) RawBytes() []byte

func (p PeerID) RawString() string

func (p PeerID) String() string

type Scrape ¶

type Scrape struct {
	InfoHash   InfoHash
	Snatches   uint32
	Complete   uint32
	Incomplete uint32
}

Scrape represents the state of a swarm that is returned in a scrape response.

type ScrapeResponse ¶

type ScrapeResponse struct {
	Files []Scrape
}

ScrapeResponse represents the parameters used to create a scrape response.

The Scrapes must be in the same order as the InfoHashes in the corresponding ScrapeRequest.