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,
39 ret.pieces = ret.piecesUncached()
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 // Drop the torrent from the client, and close it. It's always safe to do
66 // this. No data corruption can, or should occur to either the torrent's data,
67 // or connected peers.
68 func (t *Torrent) Drop() {
70 t.cl.dropTorrent(t.infoHash)
74 // Number of bytes of the entire torrent we have completed.
75 func (t *Torrent) BytesCompleted() int64 {
77 defer t.cl.mu.RUnlock()
78 return t.bytesCompleted()
81 // The subscription emits as (int) the index of pieces as their state changes.
82 // A state change is when the PieceState for a piece alters in value.
83 func (t *Torrent) SubscribePieceStateChanges() *pubsub.Subscription {
84 return t.pieceStateChanges.Subscribe()
87 // Returns true if the torrent is currently being seeded. This occurs when the
88 // client is willing to upload without wanting anything in return.
89 func (t *Torrent) Seeding() bool {
91 defer t.cl.mu.Unlock()
95 // Clobbers the torrent display name. The display name is used as the torrent
96 // name if the metainfo is not available.
97 func (t *Torrent) SetDisplayName(dn string) {
99 defer t.cl.mu.Unlock()
103 // The current working name for the torrent. Either the name in the info dict,
104 // or a display name given such as by the dn value in a magnet link, or "".
105 func (t *Torrent) Name() string {
107 defer t.cl.mu.Unlock()
111 // The completed length of all the torrent data, in all its files. This is
112 // derived from the torrent info, when it is available.
113 func (t *Torrent) Length() int64 {
115 panic("not valid until info obtained")
120 // Returns a run-time generated metainfo for the torrent that includes the
121 // info bytes and announce-list as currently known to the client.
122 func (t *Torrent) Metainfo() metainfo.MetaInfo {
124 defer t.cl.mu.Unlock()
125 return t.newMetaInfo()
128 func (t *Torrent) addReader(r *Reader) {
130 defer t.cl.mu.Unlock()
131 if t.readers == nil {
132 t.readers = make(map[*Reader]struct{})
134 t.readers[r] = struct{}{}
138 func (t *Torrent) deleteReader(r *Reader) {
140 defer t.cl.mu.Unlock()
145 func (t *Torrent) DownloadPieces(begin, end int) {
147 defer t.cl.mu.Unlock()
148 t.pendPieceRange(begin, end)
151 func (t *Torrent) CancelPieces(begin, end int) {
153 defer t.cl.mu.Unlock()
154 t.unpendPieceRange(begin, end)
157 // Returns handles to the files in the torrent. This requires the metainfo is
159 func (t *Torrent) Files() (ret []File) {
167 for _, fi := range info.UpvertedFiles() {
168 ret = append(ret, File{
170 strings.Join(append([]string{info.Name}, fi.Path...), "/"),
180 func (t *Torrent) AddPeers(pp []Peer) {
187 // Marks the entire torrent for download. Requires the info first, see
189 func (t *Torrent) DownloadAll() {
191 defer t.cl.mu.Unlock()
192 t.pendPieceRange(0, t.numPieces())
195 func (t *Torrent) String() string {
198 s = fmt.Sprintf("%x", t.infoHash)
203 func (t *Torrent) AddTrackers(announceList [][]string) {
205 defer t.cl.mu.Unlock()
206 t.addTrackers(announceList)