bget

README

bget

bget是一个实现了BitTorrent协议的package,目前只是初步完成还有一些需要完善测试的的地方。

已实现的BEP:

• The BitTorrent Protocol Specification
• DHT Protocol(未完成)
• Fast Extension
• UDP Tracker Protocol
• UDP Tracker Protocol
• Tracker Returns Compact Peer Lists

Documentation

Index

• Variables
• type Configuration
  • func NewConfig() *Configuration
• type Download
  • func New(cfg *Configuration) (*Download, error)
  • func (d *Download) Add(task, path string) (id string, err error)
  • func (d *Download) Close()
  • func (d *Download) GetFileList(task string) ([]meta.FileInfo, error)
  • func (d *Download) SetFile(task string, option map[int]bool)
  • func (d *Download) Start(task string)
  • func (d *Download) Stop(task string)
• type OptionsConfiguration

Variables

var (
	ErrIdentFormat   = errors.New("Ident format error")
	ErrVersionFormat = errors.New("version format error")

	ErrCreateTaskRepeat = errors.New("repeat task, task has been created")
	ErrTaskNotFound     = errors.New("can't find this task")
)

Errors

Types

type Configuration

type Configuration struct {
	Version     string
	Ident       string
	IP          string
	Port        int
	DHTPort     int
	Folder      string
	Cache       int64
	MaxDownload int
	Options     OptionsConfiguration
}

Configuration is Configuration of Download

func NewConfig

func NewConfig() *Configuration

NewConfig create a default configure

type Download

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

Download is top-level instance

func New

func New(cfg *Configuration) (*Download, error)

New creates an instance of Download

func (*Download) Add

func (d *Download) Add(task, path string) (id string, err error)

Add add a new task to the instance

func (*Download) Close

func (d *Download) Close()

Close close the download instance

func (*Download) GetFileList

func (d *Download) GetFileList(task string) ([]meta.FileInfo, error)

GetFileList get all files of the task

func (*Download) SetFile

func (d *Download) SetFile(task string, option map[int]bool)

SetFile set all files of the task download or not by option

func (*Download) Start

func (d *Download) Start(task string)

Start start a task, it will block until task finish or occur errors

func (*Download) Stop

func (d *Download) Stop(task string)

Stop stop a task

type OptionsConfiguration

type OptionsConfiguration struct {
	Ident   string
	IP      string
	Port    int
	DHTPort int
}

OptionsConfiguration is Options Configuration of download