7 "github.com/anacrolix/missinggo/pubsub"
9 "github.com/anacrolix/torrent/metainfo"
12 // The torrent's infohash. This is fixed and cannot change. It uniquely
13 // identifies a torrent.
14 func (t *Torrent) InfoHash() metainfo.Hash {
18 // Returns a channel that is closed when the info (.Info()) for the torrent
19 // has become available.
20 func (t *Torrent) GotInfo() <-chan struct{} {
22 defer t.cl.mu.Unlock()
23 return t.gotMetainfo.C()
26 // Returns the metainfo info dictionary, or nil if it's not yet available.
27 func (t *Torrent) Info() *metainfo.Info {
31 // Returns a Reader bound to the torrent's data. All read calls block until
32 // the data requested is actually available.
33 func (t *Torrent) NewReader() (ret *Reader) {
37 readahead: 5 * 1024 * 1024,
43 // Returns the state of pieces of the torrent. They are grouped into runs of
44 // same state. The sum of the state run lengths is the number of pieces
46 func (t *Torrent) PieceStateRuns() []PieceStateRun {
48 defer t.cl.mu.Unlock()
49 return t.pieceStateRuns()
52 func (t *Torrent) PieceState(piece int) PieceState {
54 defer t.cl.mu.Unlock()
55 return t.pieceState(piece)
58 // The number of pieces in the torrent. This requires that the info has been
60 func (t *Torrent) NumPieces() int {
64 // Get missing bytes count for specific piece.
65 func (t *Torrent) PieceBytesMissing(piece int) int64 {
67 defer t.cl.mu.Unlock()
69 return int64(t.pieces[piece].bytesLeft())
72 // Drop the torrent from the client, and close it. It's always safe to do
73 // this. No data corruption can, or should occur to either the torrent's data,
74 // or connected peers.
75 func (t *Torrent) Drop() {
77 t.cl.dropTorrent(t.infoHash)
81 // Number of bytes of the entire torrent we have completed.
82 func (t *Torrent) BytesCompleted() int64 {
84 defer t.cl.mu.RUnlock()
85 return t.bytesCompleted()
88 // The subscription emits as (int) the index of pieces as their state changes.
89 // A state change is when the PieceState for a piece alters in value.
90 func (t *Torrent) SubscribePieceStateChanges() *pubsub.Subscription {
91 return t.pieceStateChanges.Subscribe()
94 // Returns true if the torrent is currently being seeded. This occurs when the
95 // client is willing to upload without wanting anything in return.
96 func (t *Torrent) Seeding() bool {
98 defer t.cl.mu.Unlock()
102 // Clobbers the torrent display name. The display name is used as the torrent
103 // name if the metainfo is not available.
104 func (t *Torrent) SetDisplayName(dn string) {
106 defer t.cl.mu.Unlock()
110 // The current working name for the torrent. Either the name in the info dict,
111 // or a display name given such as by the dn value in a magnet link, or "".
112 func (t *Torrent) Name() string {
114 defer t.cl.mu.Unlock()
118 // The completed length of all the torrent data, in all its files. This is
119 // derived from the torrent info, when it is available.
120 func (t *Torrent) Length() int64 {
122 panic("not valid until info obtained")
127 // Returns a run-time generated metainfo for the torrent that includes the
128 // info bytes and announce-list as currently known to the client.
129 func (t *Torrent) Metainfo() metainfo.MetaInfo {
131 defer t.cl.mu.Unlock()
132 return t.newMetaInfo()
135 func (t *Torrent) addReader(r *Reader) {
137 defer t.cl.mu.Unlock()
138 if t.readers == nil {
139 t.readers = make(map[*Reader]struct{})
141 t.readers[r] = struct{}{}
145 func (t *Torrent) deleteReader(r *Reader) {
150 func (t *Torrent) DownloadPieces(begin, end int) {
152 defer t.cl.mu.Unlock()
153 t.pendPieceRange(begin, end)
156 func (t *Torrent) CancelPieces(begin, end int) {
158 defer t.cl.mu.Unlock()
159 t.unpendPieceRange(begin, end)
162 // Returns handles to the files in the torrent. This requires the metainfo is
164 func (t *Torrent) Files() (ret []File) {
172 for _, fi := range info.UpvertedFiles() {
173 ret = append(ret, File{
175 strings.Join(append([]string{info.Name}, fi.Path...), "/"),
185 func (t *Torrent) AddPeers(pp []Peer) {
192 // Marks the entire torrent for download. Requires the info first, see
194 func (t *Torrent) DownloadAll() {
196 defer t.cl.mu.Unlock()
197 t.pendPieceRange(0, t.numPieces())
200 func (t *Torrent) String() string {
203 s = fmt.Sprintf("%x", t.infoHash)
208 func (t *Torrent) AddTrackers(announceList [][]string) {
210 defer t.cl.mu.Unlock()
211 t.addTrackers(announceList)