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 // Drop the torrent from the client, and close it. It's always safe to do
65 // this. No data corruption can, or should occur to either the torrent's data,
66 // or connected peers.
67 func (t *Torrent) Drop() {
69 t.cl.dropTorrent(t.infoHash)
73 // Number of bytes of the entire torrent we have completed.
74 func (t *Torrent) BytesCompleted() int64 {
76 defer t.cl.mu.RUnlock()
77 return t.bytesCompleted()
80 // The subscription emits as (int) the index of pieces as their state changes.
81 // A state change is when the PieceState for a piece alters in value.
82 func (t *Torrent) SubscribePieceStateChanges() *pubsub.Subscription {
83 return t.pieceStateChanges.Subscribe()
86 // Returns true if the torrent is currently being seeded. This occurs when the
87 // client is willing to upload without wanting anything in return.
88 func (t *Torrent) Seeding() bool {
90 defer t.cl.mu.Unlock()
94 // Clobbers the torrent display name. The display name is used as the torrent
95 // name if the metainfo is not available.
96 func (t *Torrent) SetDisplayName(dn string) {
98 defer t.cl.mu.Unlock()
102 // The current working name for the torrent. Either the name in the info dict,
103 // or a display name given such as by the dn value in a magnet link, or "".
104 func (t *Torrent) Name() string {
106 defer t.cl.mu.Unlock()
110 // The completed length of all the torrent data, in all its files. This is
111 // derived from the torrent info, when it is available.
112 func (t *Torrent) Length() int64 {
114 panic("not valid until info obtained")
119 // Returns a run-time generated metainfo for the torrent that includes the
120 // info bytes and announce-list as currently known to the client.
121 func (t *Torrent) Metainfo() metainfo.MetaInfo {
123 defer t.cl.mu.Unlock()
124 return t.newMetaInfo()
127 func (t *Torrent) addReader(r *Reader) {
129 defer t.cl.mu.Unlock()
130 if t.readers == nil {
131 t.readers = make(map[*Reader]struct{})
133 t.readers[r] = struct{}{}
137 func (t *Torrent) deleteReader(r *Reader) {
142 func (t *Torrent) DownloadPieces(begin, end int) {
144 defer t.cl.mu.Unlock()
145 t.pendPieceRange(begin, end)
148 func (t *Torrent) CancelPieces(begin, end int) {
150 defer t.cl.mu.Unlock()
151 t.unpendPieceRange(begin, end)
154 // Returns handles to the files in the torrent. This requires the metainfo is
156 func (t *Torrent) Files() (ret []File) {
164 for _, fi := range info.UpvertedFiles() {
165 ret = append(ret, File{
167 strings.Join(append([]string{info.Name}, fi.Path...), "/"),
177 func (t *Torrent) AddPeers(pp []Peer) {
184 // Marks the entire torrent for download. Requires the info first, see
186 func (t *Torrent) DownloadAll() {
188 defer t.cl.mu.Unlock()
189 t.pendPieceRange(0, t.numPieces())
192 func (t *Torrent) String() string {
195 s = fmt.Sprintf("%x", t.infoHash)
200 func (t *Torrent) AddTrackers(urls []string) {
202 defer t.cl.mu.Unlock()
203 t.addTrackers([][]string{urls})