torrent

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(logger log.Logger) (Client, error)
• type ClientBuilder
• type File
  • func BiggestFileFromTorrent(t Torrent) (biggest File)
• type Priority
• type Stats
• type Torrent

Constants

const MimeBitTorrent = "application/x-bittorrent"

Variables

var ErrTorrentAlreadyAdded = errors.New("torrent already added")

Types

type Client

type Client interface {
	ClientBuilder

	Start() error
	Stop()

	AddURI(uri string) (chan Torrent, error)
	Torrents() []Torrent
	Stats() Stats
	ReadTorrentFiles() error
	OutputDir() string
}

func NewClient

func NewClient(logger log.Logger) (Client, error)

type ClientBuilder

type ClientBuilder interface {
	WithSeed(seed bool) Client
	WithOutput(output string) Client
	WithPublisher(pub stream.Publisher) Client
	WithDownloadLimit(limit int) Client
	WithUploadLimit(limit int) Client
	WithWatchDir(dir string) Client
	WithBiggestFirst(b bool) Client
}

type File

type File interface {
	Priority
	DisplayPath() string
	Path() string
	BytesCompleted() int64
	Length() int64
	Offset() int64
	Name() string
}

func BiggestFileFromTorrent

func BiggestFileFromTorrent(t Torrent) (biggest File)

type Priority

type Priority interface {
	GetPriority() byte
	Now()
	High()
	Normal()
	Zero()
}

type Stats

type Stats struct {
	BytesRead      uint64 `json:"bytesRead"`
	BytesWritten   uint64 `json:"bytesWritten"`
	TotalCount     uint32 `json:"totalCount"`
	CompletedCount uint32 `json:"completedCount"`
}

type Torrent

type Torrent interface {
	Files() []File
	InfoHash() string
	Name() string
	TotalLength() uint64
	URI() string
	BytesCompleted() uint64
	Completed() bool
	MarshalJSON() ([]byte, error)
	String() string
}