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 {
38 readahead: 5 * 1024 * 1024,
45 type PieceStateRuns []PieceStateRun
47 func (me PieceStateRuns) String() (s string) {
49 var sb strings.Builder
50 sb.WriteString(me[0].String())
51 for i := 1; i < len(me); i += 1 {
53 sb.WriteString(me[i].String())
60 // Returns the state of pieces of the torrent. They are grouped into runs of same state. The sum of
61 // the state run-lengths is the number of pieces in the torrent.
62 func (t *Torrent) PieceStateRuns() (runs PieceStateRuns) {
64 runs = t.pieceStateRuns()
69 func (t *Torrent) PieceState(piece pieceIndex) PieceState {
72 return t.pieceState(piece)
75 // The number of pieces in the torrent. This requires that the info has been
77 func (t *Torrent) NumPieces() pieceIndex {
81 // Get missing bytes count for specific piece.
82 func (t *Torrent) PieceBytesMissing(piece int) int64 {
86 return int64(t.pieces[piece].bytesLeft())
89 // Drop the torrent from the client, and close it. It's always safe to do
90 // this. No data corruption can, or should occur to either the torrent's data,
91 // or connected peers.
92 func (t *Torrent) Drop() {
95 t.cl.dropTorrent(t.infoHash)
98 // Number of bytes of the entire torrent we have completed. This is the sum of
99 // completed pieces, and dirtied chunks of incomplete pieces. Do not use this
100 // for download rate, as it can go down when pieces are lost or fail checks.
101 // Sample Torrent.Stats.DataBytesRead for actual file data download rate.
102 func (t *Torrent) BytesCompleted() int64 {
105 return t.bytesCompleted()
108 // The subscription emits as (int) the index of pieces as their state changes.
109 // A state change is when the PieceState for a piece alters in value.
110 func (t *Torrent) SubscribePieceStateChanges() *pubsub.Subscription {
111 return t.pieceStateChanges.Subscribe()
114 // Returns true if the torrent is currently being seeded. This occurs when the
115 // client is willing to upload without wanting anything in return.
116 func (t *Torrent) Seeding() bool {
122 // Clobbers the torrent display name. The display name is used as the torrent
123 // name if the metainfo is not available.
124 func (t *Torrent) SetDisplayName(dn string) {
126 defer t.nameMu.Unlock()
133 // The current working name for the torrent. Either the name in the info dict,
134 // or a display name given such as by the dn value in a magnet link, or "".
135 func (t *Torrent) Name() string {
139 // The completed length of all the torrent data, in all its files. This is
140 // derived from the torrent info, when it is available.
141 func (t *Torrent) Length() int64 {
145 // Returns a run-time generated metainfo for the torrent that includes the
146 // info bytes and announce-list as currently known to the client.
147 func (t *Torrent) Metainfo() metainfo.MetaInfo {
150 return t.newMetaInfo()
153 func (t *Torrent) addReader(r *reader) {
156 if t.readers == nil {
157 t.readers = make(map[*reader]struct{})
159 t.readers[r] = struct{}{}
163 func (t *Torrent) deleteReader(r *reader) {
168 // Raise the priorities of pieces in the range [begin, end) to at least Normal
169 // priority. Piece indexes are not the same as bytes. Requires that the info
170 // has been obtained, see Torrent.Info and Torrent.GotInfo.
171 func (t *Torrent) DownloadPieces(begin, end pieceIndex) {
174 t.downloadPiecesLocked(begin, end)
177 func (t *Torrent) downloadPiecesLocked(begin, end pieceIndex) {
178 for i := begin; i < end; i++ {
179 if t.pieces[i].priority.Raise(PiecePriorityNormal) {
180 t.updatePiecePriority(i)
185 func (t *Torrent) CancelPieces(begin, end pieceIndex) {
188 t.cancelPiecesLocked(begin, end)
191 func (t *Torrent) cancelPiecesLocked(begin, end pieceIndex) {
192 for i := begin; i < end; i++ {
194 if p.priority == PiecePriorityNone {
197 p.priority = PiecePriorityNone
198 t.updatePiecePriority(i)
202 func (t *Torrent) initFiles() {
204 t.files = new([]*File)
205 for _, fi := range t.info.UpvertedFiles() {
207 if len(fi.PathUTF8) != 0 {
213 if len(fi.Path) != 0 {
214 dp = strings.Join(fi.Path, "/")
216 *t.files = append(*t.files, &File{
218 strings.Join(append([]string{t.info.Name}, path...), "/"),
230 // Returns handles to the files in the torrent. This requires that the Info is
232 func (t *Torrent) Files() []*File {
236 func (t *Torrent) AddPeers(pp []PeerInfo) int {
240 return t.addPeers(pp)
243 // Marks the entire torrent for download. Requires the info first, see
244 // GotInfo. Sets piece priorities for historical reasons.
245 func (t *Torrent) DownloadAll() {
246 t.DownloadPieces(0, t.numPieces())
249 func (t *Torrent) String() string {
252 return t.infoHash.HexString()
254 return strconv.Quote(s)
258 func (t *Torrent) AddTrackers(announceList [][]string) {
261 t.addTrackers(announceList)
264 func (t *Torrent) Piece(i pieceIndex) *Piece {
268 func (t *Torrent) PeerConns() []*PeerConn {
271 ret := make([]*PeerConn, 0, len(t.conns))
272 for c := range t.conns {