downloader

package

v0.0.0-...-ce8dd9f Latest Latest Go to latest Published: Apr 3, 2021 License: MIT Imports: 16 Imported by: 0

Details

View Source

const ErrDownloadFailed = errors.Sentinel("downloader: download request failed")

View Source

const ErrInternalResolution = errors.Sentinel("downloader: destination resolves to internal network location")

View Source

const ErrInvalidIPAddress = errors.Sentinel("downloader: invalid IP address")

This section is empty.

This section is empty.

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

func (c *Counter) Write(p []byte) (int, error)

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

func ByID(dlid string) *Download

Returns a single Download matching a given identifier. If no download is found the second argument in the response will be false.

func ByServer(sid string) []*Download

Returns all of the tracked downloads for a given server instance.

func New(s *server.Server, r DownloadRequest) *Download

Starts a new tracked download which allows for cancellation later on by calling the Downloader.Cancel function.

func (dl *Download) BelongsTo(s *server.Server) bool

Checks if the given download belongs to the provided server.

func (dl *Download) Cancel()

Cancels a running download and frees up the associated resources. If a file is being written a partial file will remain present on the disk.

func (dl *Download) Execute() error

Executes a given download for the server and begins writing the file to the disk. Once completed the download will be removed from the cache.

func (dl Download) MarshalJSON() ([]byte, error)

func (dl *Download) Progress() float64

Returns the current progress of the download as a float value between 0 and 1 where 1 indicates that the download is completed.

type DownloadRequest struct {
	URL       *url.URL
	Directory string
}

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

Defines a global downloader struct that keeps track of all currently processing downloads for the machine.