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 identifies a torrent.
13 func (t *Torrent) InfoHash() metainfo.Hash {
17 // Returns a channel that is closed when the info (.Info()) for the torrent has become available.
18 func (t *Torrent) GotInfo() <-chan struct{} {
19 // TODO: We shouldn't need to lock to take a channel here, if the event is only ever set.
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 {
32 // Returns a Reader bound to the torrent's data. All read calls block until the data requested is
33 // actually available. Note that you probably want to ensure the Torrent Info is available first.
34 func (t *Torrent) NewReader() Reader {
35 return t.newReader(0, *t.length)
38 func (t *Torrent) newReader(offset, length int64) Reader {
42 readahead: 5 * 1024 * 1024,
50 type PieceStateRuns []PieceStateRun
52 func (me PieceStateRuns) String() (s string) {
54 var sb strings.Builder
55 sb.WriteString(me[0].String())
56 for i := 1; i < len(me); i += 1 {
58 sb.WriteString(me[i].String())
65 // Returns the state of pieces of the torrent. They are grouped into runs of same state. The sum of
66 // the state run-lengths is the number of pieces in the torrent.
67 func (t *Torrent) PieceStateRuns() (runs PieceStateRuns) {
69 runs = t.pieceStateRuns()
74 func (t *Torrent) PieceState(piece pieceIndex) PieceState {
77 return t.pieceState(piece)
80 // The number of pieces in the torrent. This requires that the info has been
82 func (t *Torrent) NumPieces() pieceIndex {
86 // Get missing bytes count for specific piece.
87 func (t *Torrent) PieceBytesMissing(piece int) int64 {
91 return int64(t.pieces[piece].bytesLeft())
94 // Drop the torrent from the client, and close it. It's always safe to do
95 // this. No data corruption can, or should occur to either the torrent's data,
96 // or connected peers.
97 func (t *Torrent) Drop() {
100 t.cl.dropTorrent(t.infoHash)
103 // Number of bytes of the entire torrent we have completed. This is the sum of
104 // completed pieces, and dirtied chunks of incomplete pieces. Do not use this
105 // for download rate, as it can go down when pieces are lost or fail checks.
106 // Sample Torrent.Stats.DataBytesRead for actual file data download rate.
107 func (t *Torrent) BytesCompleted() int64 {
110 return t.bytesCompleted()
113 // The subscription emits as (int) the index of pieces as their state changes.
114 // A state change is when the PieceState for a piece alters in value.
115 func (t *Torrent) SubscribePieceStateChanges() *pubsub.Subscription {
116 return t.pieceStateChanges.Subscribe()
119 // Returns true if the torrent is currently being seeded. This occurs when the
120 // client is willing to upload without wanting anything in return.
121 func (t *Torrent) Seeding() bool {
127 // Clobbers the torrent display name. The display name is used as the torrent
128 // name if the metainfo is not available.
129 func (t *Torrent) SetDisplayName(dn string) {
131 defer t.nameMu.Unlock()
138 // The current working name for the torrent. Either the name in the info dict,
139 // or a display name given such as by the dn value in a magnet link, or "".
140 func (t *Torrent) Name() string {
144 // The completed length of all the torrent data, in all its files. This is
145 // derived from the torrent info, when it is available.
146 func (t *Torrent) Length() int64 {
150 // Returns a run-time generated metainfo for the torrent that includes the
151 // info bytes and announce-list as currently known to the client.
152 func (t *Torrent) Metainfo() metainfo.MetaInfo {
155 return t.newMetaInfo()
158 func (t *Torrent) addReader(r *reader) {
161 if t.readers == nil {
162 t.readers = make(map[*reader]struct{})
164 t.readers[r] = struct{}{}
168 func (t *Torrent) deleteReader(r *reader) {
173 // Raise the priorities of pieces in the range [begin, end) to at least Normal
174 // priority. Piece indexes are not the same as bytes. Requires that the info
175 // has been obtained, see Torrent.Info and Torrent.GotInfo.
176 func (t *Torrent) DownloadPieces(begin, end pieceIndex) {
179 t.downloadPiecesLocked(begin, end)
182 func (t *Torrent) downloadPiecesLocked(begin, end pieceIndex) {
183 for i := begin; i < end; i++ {
184 if t.pieces[i].priority.Raise(PiecePriorityNormal) {
185 t.updatePiecePriority(i)
190 func (t *Torrent) CancelPieces(begin, end pieceIndex) {
193 t.cancelPiecesLocked(begin, end)
196 func (t *Torrent) cancelPiecesLocked(begin, end pieceIndex) {
197 for i := begin; i < end; i++ {
199 if p.priority == PiecePriorityNone {
202 p.priority = PiecePriorityNone
203 t.updatePiecePriority(i)
207 func (t *Torrent) initFiles() {
209 t.files = new([]*File)
210 for _, fi := range t.info.UpvertedFiles() {
212 if len(fi.PathUTF8) != 0 {
218 if len(fi.Path) != 0 {
219 dp = strings.Join(fi.Path, "/")
221 *t.files = append(*t.files, &File{
223 strings.Join(append([]string{t.info.Name}, path...), "/"),
235 // Returns handles to the files in the torrent. This requires that the Info is
237 func (t *Torrent) Files() []*File {
241 func (t *Torrent) AddPeers(pp []PeerInfo) int {
245 return t.addPeers(pp)
248 // Marks the entire torrent for download. Requires the info first, see
249 // GotInfo. Sets piece priorities for historical reasons.
250 func (t *Torrent) DownloadAll() {
251 t.DownloadPieces(0, t.numPieces())
254 func (t *Torrent) String() string {
257 return t.infoHash.HexString()
259 return strconv.Quote(s)
263 func (t *Torrent) AddTrackers(announceList [][]string) {
266 t.addTrackers(announceList)
269 func (t *Torrent) Piece(i pieceIndex) *Piece {
273 func (t *Torrent) PeerConns() []*PeerConn {
276 ret := make([]*PeerConn, 0, len(t.conns))
277 for c := range t.conns {