renter

Documentation

Index

• Constants
• Variables
• type Download
  • func (d *Download) Complete() bool
  • func (d *Download) Destination() string
  • func (d *Download) Filesize() uint64
  • func (d *Download) Nickname() string
  • func (d *Download) Received() uint64
  • func (d *Download) StartTime() time.Time
  • func (d *Download) Write(b []byte) (int, error)
• type Renter
  • func New(cs *consensus.State, hdb modules.HostDB, wallet modules.Wallet, saveDir string) (*Renter, error)
  • func (r *Renter) DeleteFile(nickname string) error
  • func (r *Renter) Download(nickname, destination string) error
  • func (r *Renter) DownloadQueue() []modules.DownloadInfo
  • func (r *Renter) FileList() (files []modules.FileInfo)
  • func (r *Renter) Info() (ri modules.RentInfo)
  • func (r *Renter) LoadSharedFile(filename string) ([]string, error)
  • func (r *Renter) LoadSharedFilesAscii(asciiSia string) ([]string, error)
  • func (r *Renter) ReceiveConsensusSetUpdate(cc modules.ConsensusChange)
  • func (r *Renter) RenameFile(currentName, newName string) error
  • func (r *Renter) RenterNotify() <-chan struct{}
  • func (r *Renter) ShareFiles(nicknames []string, sharedest string) error
  • func (r *Renter) ShareFilesAscii(nicknames []string) (string, error)
  • func (r *Renter) Upload(up modules.FileUploadParams) error

Constants

const (
	PersistFilename = "renter.json"
	ShareExtension  = ".sia"
)

Variables

var (
	ErrUnknownNickname  = errors.New("no file known by that nickname")
	ErrNicknameOverload = errors.New("a file with the proposed nickname already exists")
)

var (
	ErrNoNicknames    = errors.New("at least one nickname must be supplied")
	ErrNonShareSuffix = errors.New("suffix of file must be " + ShareExtension)
)

var (
	ErrNilCS     = errors.New("cannot create renter with nil consensus set")
	ErrNilHostDB = errors.New("cannot create renter with nil hostdb")
	ErrNilWallet = errors.New("cannot create renter wil nil wlalet")
)

Types

type Download

type Download struct {
	// contains filtered or unexported fields
}

A Download is a file download that has been queued by the renter. It implements the modules.DownloadInfo interface.

func (*Download) Complete

func (d *Download) Complete() bool

Complete returns whether the file is ready to be used.

func (*Download) Destination

func (d *Download) Destination() string

Destination returns the file's location on disk.

func (*Download) Filesize

func (d *Download) Filesize() uint64

Filesize returns the size of the file.

func (*Download) Nickname

func (d *Download) Nickname() string

Nickname returns the identifier assigned to the file when it was uploaded.

func (*Download) Received

func (d *Download) Received() uint64

Received returns the number of bytes downloaded so far.

func (*Download) StartTime

func (d *Download) StartTime() time.Time

StartTime returns when the download was initiated.

func (*Download) Write

func (d *Download) Write(b []byte) (int, error)

Write implements the io.Writer interface. Each write updates the Download's received field. This allows download progress to be monitored in real-time.

type Renter

type Renter struct {
	// contains filtered or unexported fields
}

A Renter is responsible for tracking all of the files that a user has uploaded to Sia, as well as the locations and health of these files.

func New

func New(cs *consensus.State, hdb modules.HostDB, wallet modules.Wallet, saveDir string) (*Renter, error)

New returns an empty renter.

func (*Renter) DeleteFile

func (r *Renter) DeleteFile(nickname string) error

DeleteFile removes a file entry from the renter.

func (*Renter) Download

func (r *Renter) Download(nickname, destination string) error

Download downloads a file, identified by its nickname, to the destination specified.

func (*Renter) DownloadQueue

func (r *Renter) DownloadQueue() []modules.DownloadInfo

DownloadQueue returns the list of downloads in the queue.

func (*Renter) FileList

func (r *Renter) FileList() (files []modules.FileInfo)

FileList returns all of the files that the renter has.

func (*Renter) Info

func (r *Renter) Info() (ri modules.RentInfo)

Info returns generic information about the renter and the files that are being rented.

func (*Renter) LoadSharedFile

func (r *Renter) LoadSharedFile(filename string) ([]string, error)

LoadSharedFile loads a shared file into the renter.

func (*Renter) LoadSharedFilesAscii

func (r *Renter) LoadSharedFilesAscii(asciiSia string) ([]string, error)

loadSharedFile takes an encoded set of files and adds them to the renter, taking them form an ascii string.

func (*Renter) ReceiveConsensusSetUpdate

func (r *Renter) ReceiveConsensusSetUpdate(cc modules.ConsensusChange)

ReceiveConsensusSetUpdate will be called by the consensus set every time there is a change in the blockchain. Updates will always be called in order.

func (*Renter) RenameFile

func (r *Renter) RenameFile(currentName, newName string) error

RenameFile takes an existing file and changes the nickname. The original file must exist, and there must not be any file that already has the replacement nickname.

func (*Renter) RenterNotify

func (r *Renter) RenterNotify() <-chan struct{}

RenterNotify returns a channel that will be sent a struct{} every time there is an update received from another module.

func (*Renter) ShareFiles

func (r *Renter) ShareFiles(nicknames []string, sharedest string) error

ShareFiles saves a '.sia' file that can be shared with others, enabling them to download the file you are sharing. It creates a Sia equivalent of a '.torrent'.

func (*Renter) ShareFilesAscii

func (r *Renter) ShareFilesAscii(nicknames []string) (string, error)

ShareFilesAscii returns an ascii string that can be shared with other daemons, granting them access to the files.

func (*Renter) Upload

func (r *Renter) Upload(up modules.FileUploadParams) error

Upload takes an upload parameters, which contain a file to upload, and then creates a redundant copy of the file on the Sia network.