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{} {
21 return t.gotMetainfo.C()
24 // Returns the metainfo info dictionary, or nil if it's not yet available.
25 func (t *Torrent) Info() *metainfo.InfoEx {
29 // Returns a Reader bound to the torrent's data. All read calls block until
30 // the data requested is actually available.
31 func (t *Torrent) NewReader() (ret *Reader) {
34 readahead: 5 * 1024 * 1024,
40 // Returns the state of pieces of the torrent. They are grouped into runs of
41 // same state. The sum of the state run lengths is the number of pieces
43 func (t *Torrent) PieceStateRuns() []PieceStateRun {
45 defer t.cl.mu.Unlock()
46 return t.pieceStateRuns()
49 func (t *Torrent) PieceState(piece int) PieceState {
51 defer t.cl.mu.Unlock()
52 return t.pieceState(piece)
55 // The number of pieces in the torrent. This requires that the info has been
57 func (t *Torrent) NumPieces() int {
61 // Drop the torrent from the client, and close it. It's always safe to do
62 // this. No data corruption can, or should occur to either the torrent's data,
63 // or connected peers.
64 func (t *Torrent) Drop() {
66 t.cl.dropTorrent(t.infoHash)
70 // Number of bytes of the entire torrent we have completed.
71 func (t *Torrent) BytesCompleted() int64 {
73 defer t.cl.mu.RUnlock()
74 return t.bytesCompleted()
77 // The subscription emits as (int) the index of pieces as their state changes.
78 // A state change is when the PieceState for a piece alters in value.
79 func (t *Torrent) SubscribePieceStateChanges() *pubsub.Subscription {
80 return t.pieceStateChanges.Subscribe()
83 // Returns true if the torrent is currently being seeded. This occurs when the
84 // client is willing to upload without wanting anything in return.
85 func (t *Torrent) Seeding() bool {
87 defer t.cl.mu.Unlock()
88 return t.cl.seeding(t)
91 // Clobbers the torrent display name. The display name is used as the torrent
92 // name if the metainfo is not available.
93 func (t *Torrent) SetDisplayName(dn string) {
95 defer t.cl.mu.Unlock()
99 // The current working name for the torrent. Either the name in the info dict,
100 // or a display name given such as by the dn value in a magnet link, or "".
101 func (t *Torrent) Name() string {
103 defer t.cl.mu.Unlock()
107 // The completed length of all the torrent data, in all its files. This is
108 // derived from the torrent info, when it is available.
109 func (t *Torrent) Length() int64 {
111 panic("not valid until info obtained")
116 // Returns a run-time generated metainfo for the torrent that includes the
117 // info bytes and announce-list as currently known to the client.
118 func (t *Torrent) Metainfo() *metainfo.MetaInfo {
120 defer t.cl.mu.Unlock()
124 func (t *Torrent) addReader(r *Reader) {
126 defer t.cl.mu.Unlock()
127 if t.readers == nil {
128 t.readers = make(map[*Reader]struct{})
130 t.readers[r] = struct{}{}
134 func (t *Torrent) deleteReader(r *Reader) {
136 defer t.cl.mu.Unlock()
141 func (t *Torrent) DownloadPieces(begin, end int) {
143 defer t.cl.mu.Unlock()
144 t.pendPieceRange(begin, end)
147 func (t *Torrent) CancelPieces(begin, end int) {
149 defer t.cl.mu.Unlock()
150 t.unpendPieceRange(begin, end)
153 // Returns handles to the files in the torrent. This requires the metainfo is
155 func (t *Torrent) Files() (ret []File) {
163 for _, fi := range info.UpvertedFiles() {
164 ret = append(ret, File{
166 strings.Join(append([]string{info.Name}, fi.Path...), "/"),
176 func (t *Torrent) AddPeers(pp []Peer) error {
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)