6 "github.com/anacrolix/missinggo/pubsub"
8 "github.com/anacrolix/torrent/metainfo"
11 // The torrent's infohash. This is fixed and cannot change. It uniquely
12 // identifies a torrent.
13 func (t *Torrent) InfoHash() metainfo.Hash {
17 // Returns a channel that is closed when the info (.Info()) for the torrent
18 // has become available.
19 func (t *Torrent) GotInfo() <-chan struct{} {
21 defer t.cl.mu.Unlock()
22 return t.gotMetainfo.C()
25 // Returns the metainfo info dictionary, or nil if it's not yet available.
26 func (t *Torrent) Info() *metainfo.Info {
28 defer t.cl.mu.Unlock()
32 // Returns a Reader bound to the torrent's data. All read calls block until
33 // the data requested is actually available.
34 func (t *Torrent) NewReader() (ret *Reader) {
38 readahead: 5 * 1024 * 1024,
44 // Returns the state of pieces of the torrent. They are grouped into runs of
45 // same state. The sum of the state run lengths is the number of pieces
47 func (t *Torrent) PieceStateRuns() []PieceStateRun {
49 defer t.cl.mu.Unlock()
50 return t.pieceStateRuns()
53 func (t *Torrent) PieceState(piece int) PieceState {
55 defer t.cl.mu.Unlock()
56 return t.pieceState(piece)
59 // The number of pieces in the torrent. This requires that the info has been
61 func (t *Torrent) NumPieces() int {
65 // Get missing bytes count for specific piece.
66 func (t *Torrent) PieceBytesMissing(piece int) int64 {
68 defer t.cl.mu.Unlock()
70 return int64(t.pieces[piece].bytesLeft())
73 // Drop the torrent from the client, and close it. It's always safe to do
74 // this. No data corruption can, or should occur to either the torrent's data,
75 // or connected peers.
76 func (t *Torrent) Drop() {
78 t.cl.dropTorrent(t.infoHash)
82 // Number of bytes of the entire torrent we have completed.
83 func (t *Torrent) BytesCompleted() int64 {
85 defer t.cl.mu.RUnlock()
86 return t.bytesCompleted()
89 // The subscription emits as (int) the index of pieces as their state changes.
90 // A state change is when the PieceState for a piece alters in value.
91 func (t *Torrent) SubscribePieceStateChanges() *pubsub.Subscription {
92 return t.pieceStateChanges.Subscribe()
95 // Returns true if the torrent is currently being seeded. This occurs when the
96 // client is willing to upload without wanting anything in return.
97 func (t *Torrent) Seeding() bool {
99 defer t.cl.mu.Unlock()
103 // Clobbers the torrent display name. The display name is used as the torrent
104 // name if the metainfo is not available.
105 func (t *Torrent) SetDisplayName(dn string) {
107 defer t.cl.mu.Unlock()
111 // The current working name for the torrent. Either the name in the info dict,
112 // or a display name given such as by the dn value in a magnet link, or "".
113 func (t *Torrent) Name() string {
115 defer t.cl.mu.Unlock()
119 // The completed length of all the torrent data, in all its files. This is
120 // derived from the torrent info, when it is available.
121 func (t *Torrent) Length() int64 {
123 panic("not valid until info obtained")
128 // Returns a run-time generated metainfo for the torrent that includes the
129 // info bytes and announce-list as currently known to the client.
130 func (t *Torrent) Metainfo() metainfo.MetaInfo {
132 defer t.cl.mu.Unlock()
133 return t.newMetaInfo()
136 func (t *Torrent) addReader(r *Reader) {
138 defer t.cl.mu.Unlock()
139 if t.readers == nil {
140 t.readers = make(map[*Reader]struct{})
142 t.readers[r] = struct{}{}
146 func (t *Torrent) deleteReader(r *Reader) {
151 func (t *Torrent) DownloadPieces(begin, end int) {
153 defer t.cl.mu.Unlock()
154 t.pendPieceRange(begin, end)
157 func (t *Torrent) CancelPieces(begin, end int) {
159 defer t.cl.mu.Unlock()
160 t.unpendPieceRange(begin, end)
163 // Returns handles to the files in the torrent. This requires the metainfo is
165 func (t *Torrent) Files() (ret []File) {
171 for _, fi := range info.UpvertedFiles() {
172 ret = append(ret, File{
174 strings.Join(append([]string{info.Name}, fi.Path...), "/"),
184 func (t *Torrent) AddPeers(pp []Peer) {
191 // Marks the entire torrent for download. Requires the info first, see
193 func (t *Torrent) DownloadAll() {
195 defer t.cl.mu.Unlock()
196 t.pendPieceRange(0, t.numPieces())
199 func (t *Torrent) String() string {
202 s = t.infoHash.HexString()
207 func (t *Torrent) AddTrackers(announceList [][]string) {
209 defer t.cl.mu.Unlock()
210 t.addTrackers(announceList)