bittorrent

type Client struct {
	// Running reports the status of the underlying libtorrent session.
	// It is set to true after a successfull Start() and set to false when Stop() is called.
	// Using Download() only makes sense when Running equals true.
	Running bool
	// contains filtered or unexported fields
}

type ClientConfig struct {
	// Fingerprint represents information about a client and its version.
	// It is used to encode this information into the client's peer id.
	Fingerprint ClientFingerprint

	// LowerListenPort defines the lowest port on which libtorrent will try to listen.
	LowerListenPort int

	// UpperListenPort defines the highest port on which libtorrent will try to listen.
	UpperListenPort int

	// ConnectionsPerSecond specifies the maximum number of outgoing connections per second
	// libtorrent allows.
	ConnectionsPerSecond int

	// MaxDownloadRate defines the maximun bandwidth (in bytes/s) that libtorrent will use to download
	// torrents. A zero value mean unlimited.
	// Note that it does not apply for peers on the local network, which are not rate limited.
	MaxDownloadRate int

	// MaxUploadRate defines the maximun bandwidth (in bytes/s) that libtorrent will use to upload
	// torrents. A zero value mean unlimited.
	// Note that it does not apply for peers on the local network, which are not rate limited.
	MaxUploadRate int

	// Encryption controls the peer protocol encryption policies.
	Encryption EncryptionMode

	// Debug, when set to true, makes libtorrent output every available alert.
	Debug bool
}

type ClientFingerprint struct {
	// ID represents uniquely a client. It must contains exactly two characters.
	// Unofficial list: https://wiki.theory.org/BitTorrentSpecification#peer_id
	ID string

	// Major represents the major version of the client. It must be within the range [0, 9].
	Major int

	// Minor represents the minor version of the client. It must be within the range [0, 9].
	Minor int

	// Revision represents the revision of the client. It must be within the range [0, 9].
	Revision int

	// Tag represents the version tag of the client. It must be within the range [0, 9].
	Tag int
}

type DownloadConfig struct {
	// SkipWebseed, if set to true, skips the webseed when downloading the torrent.
	SkipWebseed bool

	// CustomTrackers hold the domain names of the custom tracker(s) to use for downloading the
	// torrent.
	// If specified, the default tracker is not used.
	CustomTrackers []string
}

type EncryptionMode int

type Status struct {
	// Name is the torrent's name.
	Name string

	// Status represents the current torrent's state.
	Status TorrentState

	// Progress is download completion percentage.
	Progress float32

	// DownloadRate is the total download rates for all peers for this torrent, expressed in kB/s.
	DownloadRate float32

	// UploadRate is the total upload rates for all peers for this torrent, expressed in kB/s.
	UploadRate float32

	// NumConnectCandidates is the number of peers in this torrent's peer list that is a candidate
	// to be connected to. i.e. It has fewer connect attempts than the max fail count, it is not a
	// seed if we are a seed, it is not banned etc.
	// If this is 0, it means we don't know of any more peers that we can try.
	NumConnectCandidates int

	// NumPeeers is the total number of peer connections this session has. This includes incoming
	// connections that still hasn't sent their handshake or outgoing connections that still hasn't
	// completed the TCP connection.
	NumPeers int

	// NumSeeds is the number of peers that are seeding that this client is currently connected to.
	NumSeeds int
}

type TorrentState string