140 lines
3.8 KiB
Go
140 lines
3.8 KiB
Go
package torrent
|
|
|
|
import (
|
|
"github.com/anacrolix/missinggo/pubsub"
|
|
|
|
"github.com/anacrolix/torrent/metainfo"
|
|
)
|
|
|
|
// This file contains Torrent, until I decide where the private, lower-case
|
|
// "torrent" type belongs. That type is currently mostly in torrent.go.
|
|
|
|
// The public handle to a live torrent within a Client.
|
|
type Torrent struct {
|
|
cl *Client
|
|
torrent *torrent
|
|
}
|
|
|
|
// The torrent's infohash. This is fixed and cannot change. It uniquely
|
|
// identifies a torrent.
|
|
func (t Torrent) InfoHash() InfoHash {
|
|
return t.torrent.InfoHash
|
|
}
|
|
|
|
// Closed when the info (.Info()) for the torrent has become available. Using
|
|
// features of Torrent that require the info before it is available will have
|
|
// undefined behaviour.
|
|
func (t Torrent) GotInfo() <-chan struct{} {
|
|
return t.torrent.gotMetainfo
|
|
}
|
|
|
|
// Returns the metainfo info dictionary, or nil if it's not yet available.
|
|
func (t Torrent) Info() *metainfo.Info {
|
|
return t.torrent.Info
|
|
}
|
|
|
|
// Returns a Reader bound to the torrent's data. All read calls block until
|
|
// the data requested is actually available. Priorities are set to ensure the
|
|
// data requested will be downloaded as soon as possible.
|
|
func (t Torrent) NewReader() (ret *Reader) {
|
|
ret = &Reader{
|
|
t: &t,
|
|
readahead: 5 * 1024 * 1024,
|
|
}
|
|
t.addReader(ret)
|
|
return
|
|
}
|
|
|
|
// Returns the state of pieces of the torrent. They are grouped into runs of
|
|
// same state. The sum of the state run lengths is the number of pieces
|
|
// in the torrent.
|
|
func (t Torrent) PieceStateRuns() []PieceStateRun {
|
|
t.torrent.stateMu.Lock()
|
|
defer t.torrent.stateMu.Unlock()
|
|
return t.torrent.pieceStateRuns()
|
|
}
|
|
|
|
// The number of pieces in the torrent. This requires that the info has been
|
|
// obtained first.
|
|
func (t Torrent) NumPieces() int {
|
|
return t.torrent.numPieces()
|
|
}
|
|
|
|
// Drop the torrent from the client, and close it.
|
|
func (t Torrent) Drop() {
|
|
t.cl.mu.Lock()
|
|
t.cl.dropTorrent(t.torrent.InfoHash)
|
|
t.cl.mu.Unlock()
|
|
}
|
|
|
|
// Number of bytes of the entire torrent we have completed.
|
|
func (t Torrent) BytesCompleted() int64 {
|
|
t.cl.mu.RLock()
|
|
defer t.cl.mu.RUnlock()
|
|
return t.torrent.bytesCompleted()
|
|
}
|
|
|
|
// The subscription emits as (int) the index of pieces as their state changes.
|
|
// A state change is when the PieceState for a piece alters in value.
|
|
func (t Torrent) SubscribePieceStateChanges() *pubsub.Subscription {
|
|
return t.torrent.pieceStateChanges.Subscribe()
|
|
}
|
|
|
|
// Returns true if the torrent is currently being seeded. This occurs when the
|
|
// client is willing to upload without wanting anything in return.
|
|
func (t Torrent) Seeding() bool {
|
|
t.cl.mu.Lock()
|
|
defer t.cl.mu.Unlock()
|
|
return t.cl.seeding(t.torrent)
|
|
}
|
|
|
|
// Clobbers the torrent display name. The display name is used as the torrent
|
|
// name if the metainfo is not available.
|
|
func (t Torrent) SetDisplayName(dn string) {
|
|
t.cl.mu.Lock()
|
|
defer t.cl.mu.Unlock()
|
|
t.torrent.setDisplayName(dn)
|
|
}
|
|
|
|
// The current working name for the torrent. Either the name in the info dict,
|
|
// or a display name given such as by the dn value in a magnet link, or "".
|
|
func (t Torrent) Name() string {
|
|
t.cl.mu.Lock()
|
|
defer t.cl.mu.Unlock()
|
|
return t.torrent.Name()
|
|
}
|
|
|
|
func (t Torrent) Length() int64 {
|
|
select {
|
|
case <-t.GotInfo():
|
|
return t.torrent.length
|
|
default:
|
|
return -1
|
|
}
|
|
}
|
|
|
|
// Returns a run-time generated metainfo for the torrent that includes the
|
|
// info bytes and announce-list as currently known to the client.
|
|
func (t Torrent) MetaInfo() *metainfo.MetaInfo {
|
|
t.cl.mu.Lock()
|
|
defer t.cl.mu.Unlock()
|
|
return t.torrent.MetaInfo()
|
|
}
|
|
|
|
func (t Torrent) addReader(r *Reader) {
|
|
t.cl.mu.Lock()
|
|
defer t.cl.mu.Unlock()
|
|
if t.torrent.readers == nil {
|
|
t.torrent.readers = make(map[*Reader]struct{})
|
|
}
|
|
t.torrent.readers[r] = struct{}{}
|
|
t.torrent.readersChanged(t.cl)
|
|
}
|
|
|
|
func (t Torrent) deleteReader(r *Reader) {
|
|
t.cl.mu.Lock()
|
|
defer t.cl.mu.Unlock()
|
|
delete(t.torrent.readers, r)
|
|
t.torrent.readersChanged(t.cl)
|
|
}
|