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 has become available.
19 func (t *Torrent) GotInfo() <-chan struct{} {
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
33 // the data requested is actually available.
34 func (t *Torrent) NewReader() Reader {
38 readahead: 5 * 1024 * 1024,
45 // Returns the state of pieces of the torrent. They are grouped into runs of
46 // same state. The sum of the state run lengths is the number of pieces
48 func (t *Torrent) PieceStateRuns() []PieceStateRun {
51 return t.pieceStateRuns()
54 func (t *Torrent) PieceState(piece pieceIndex) PieceState {
57 return t.pieceState(piece)
60 // The number of pieces in the torrent. This requires that the info has been
62 func (t *Torrent) NumPieces() pieceIndex {
66 // Get missing bytes count for specific piece.
67 func (t *Torrent) PieceBytesMissing(piece int) int64 {
71 return int64(t.pieces[piece].bytesLeft())
74 // Drop the torrent from the client, and close it. It's always safe to do
75 // this. No data corruption can, or should occur to either the torrent's data,
76 // or connected peers.
77 func (t *Torrent) Drop() {
79 t.cl.dropTorrent(t.infoHash)
83 // Number of bytes of the entire torrent we have completed. This is the sum of
84 // completed pieces, and dirtied chunks of incomplete pieces. Do not use this
85 // for download rate, as it can go down when pieces are lost or fail checks.
86 // Sample Torrent.Stats.DataBytesRead for actual file data download rate.
87 func (t *Torrent) BytesCompleted() int64 {
90 return t.bytesCompleted()
93 // The subscription emits as (int) the index of pieces as their state changes.
94 // A state change is when the PieceState for a piece alters in value.
95 func (t *Torrent) SubscribePieceStateChanges() *pubsub.Subscription {
96 return t.pieceStateChanges.Subscribe()
99 // Returns true if the torrent is currently being seeded. This occurs when the
100 // client is willing to upload without wanting anything in return.
101 func (t *Torrent) Seeding() bool {
107 // Clobbers the torrent display name. The display name is used as the torrent
108 // name if the metainfo is not available.
109 func (t *Torrent) SetDisplayName(dn string) {
111 defer t.nameMu.Unlock()
118 // The current working name for the torrent. Either the name in the info dict,
119 // or a display name given such as by the dn value in a magnet link, or "".
120 func (t *Torrent) Name() string {
124 // The completed length of all the torrent data, in all its files. This is
125 // derived from the torrent info, when it is available.
126 func (t *Torrent) Length() int64 {
130 // Returns a run-time generated metainfo for the torrent that includes the
131 // info bytes and announce-list as currently known to the client.
132 func (t *Torrent) Metainfo() metainfo.MetaInfo {
135 return t.newMetaInfo()
138 func (t *Torrent) addReader(r *reader) {
141 if t.readers == nil {
142 t.readers = make(map[*reader]struct{})
144 t.readers[r] = struct{}{}
148 func (t *Torrent) deleteReader(r *reader) {
153 // Raise the priorities of pieces in the range [begin, end) to at least Normal
154 // priority. Piece indexes are not the same as bytes. Requires that the info
155 // has been obtained, see Torrent.Info and Torrent.GotInfo.
156 func (t *Torrent) DownloadPieces(begin, end pieceIndex) {
159 t.downloadPiecesLocked(begin, end)
162 func (t *Torrent) downloadPiecesLocked(begin, end pieceIndex) {
163 for i := begin; i < end; i++ {
164 if t.pieces[i].priority.Raise(PiecePriorityNormal) {
165 t.updatePiecePriority(i)
170 func (t *Torrent) CancelPieces(begin, end pieceIndex) {
173 t.cancelPiecesLocked(begin, end)
176 func (t *Torrent) cancelPiecesLocked(begin, end pieceIndex) {
177 for i := begin; i < end; i++ {
179 if p.priority == PiecePriorityNone {
182 p.priority = PiecePriorityNone
183 t.updatePiecePriority(i)
187 func (t *Torrent) initFiles() {
189 t.files = new([]*File)
190 for _, fi := range t.info.UpvertedFiles() {
192 if len(fi.PathUTF8) != 0 {
197 *t.files = append(*t.files, &File{
199 strings.Join(append([]string{t.info.Name}, path...), "/"),
210 // Returns handles to the files in the torrent. This requires that the Info is
212 func (t *Torrent) Files() []*File {
216 func (t *Torrent) AddPeers(pp []Peer) {
223 // Marks the entire torrent for download. Requires the info first, see
224 // GotInfo. Sets piece priorities for historical reasons.
225 func (t *Torrent) DownloadAll() {
226 t.DownloadPieces(0, t.numPieces())
229 func (t *Torrent) String() string {
232 return t.infoHash.HexString()
234 return strconv.Quote(s)
238 func (t *Torrent) AddTrackers(announceList [][]string) {
241 t.addTrackers(announceList)
244 func (t *Torrent) Piece(i pieceIndex) *Piece {