Refactorings

[btrtrc.git] / t.go

diff --git a/t.go b/t.go
index 5f58703eb5eb88d043067f7f74db9b6bad95f4aa..173cdd31dd1caa7e9f39a063c71b44ccb9fb5240 100644 (file)
--- a/t.go
+++ b/t.go
@@ -2,41 +2,62 @@ package torrent
 
 import (
        "github.com/anacrolix/missinggo/pubsub"
-       "github.com/anacrolix/torrent/tracker"
        "github.com/anacrolix/torrent/metainfo"
+       "github.com/anacrolix/torrent/tracker"
 )
 
 // 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 {
+// The public interface to a live torrent within a Client.
+type Torrent interface {
+       InfoHash() InfoHash
+       GotInfo() <-chan struct{}
+       Info() *metainfo.Info
+       NewReader() (ret *Reader)
+       PieceStateRuns() []PieceStateRun
+       NumPieces() int
+       Drop()
+       BytesCompleted() int64
+       SubscribePieceStateChanges() *pubsub.Subscription
+       Seeding() bool
+       SetDisplayName(dn string)
+       Client() *Client
+       AddPeers(pp []Peer) error
+       DownloadAll()
+       Trackers() [][]tracker.Client
+       Files() (ret []File)
+       Peers() map[PeersKey]Peer
+}
+
+
+type clientTorrent struct {
        cl *Client
        *torrent
 }
 
 // The torrent's infohash. This is fixed and cannot change. It uniquely
 // identifies a torrent.
-func (t Torrent) InfoHash() InfoHash {
+func (t clientTorrent) 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{} {
+func (t clientTorrent) GotInfo() <-chan struct{} {
        return t.torrent.gotMetainfo
 }
 
 // Returns the metainfo, or nil if it's not yet available.
-func (t Torrent) Info() *metainfo.Info {
+func (t clientTorrent) 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) {
+func (t clientTorrent) NewReader() (ret *Reader) {
        ret = &Reader{
                t:         &t,
                readahead: 5 * 1024 * 1024,
@@ -47,25 +68,25 @@ func (t Torrent) NewReader() (ret *Reader) {
 // 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 {
+func (t clientTorrent) PieceStateRuns() []PieceStateRun {
        t.stateMu.Lock()
        defer t.stateMu.Unlock()
        return t.torrent.pieceStateRuns()
 }
 
-func (t Torrent) NumPieces() int {
+func (t clientTorrent) NumPieces() int {
        return t.numPieces()
 }
 
 // Drop the torrent from the client, and close it.
-func (t Torrent) Drop() {
+func (t clientTorrent) 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 {
+func (t clientTorrent) BytesCompleted() int64 {
        t.cl.mu.RLock()
        defer t.cl.mu.RUnlock()
        return t.bytesCompleted()
@@ -73,13 +94,13 @@ func (t Torrent) BytesCompleted() int64 {
 
 // 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 {
+func (t clientTorrent) 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 {
+func (t clientTorrent) Seeding() bool {
        t.cl.mu.Lock()
        defer t.cl.mu.Unlock()
        return t.cl.seeding(t.torrent)
@@ -87,23 +108,23 @@ func (t Torrent) Seeding() bool {
 
 // 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) {
+func (t clientTorrent) SetDisplayName(dn string) {
        t.cl.mu.Lock()
        defer t.cl.mu.Unlock()
        t.torrent.setDisplayName(dn)
 }
 
 // Client returns Torrent's client instance
-func (t Torrent) Client() *Client {
+func (t clientTorrent) Client() *Client {
        return t.cl
 }
 
 // Trackers returns torrent's trackers
-func (t Torrent) Trackers() [][]tracker.Client {
+func (t clientTorrent) Trackers() [][]tracker.Client {
        return t.torrent.Trackers
 }
 
 // Peers returns torrent's peers
-func (t Torrent) Peers() map[PeersKey]Peer {
+func (t clientTorrent) Peers() map[PeersKey]Peer {
        return t.torrent.Peers
-}
\ No newline at end of file
+}