common

Documentation

Index

• Constants
• Variables
• func GetStatus(status string) int
• type Aria2
• type DummyAria2
  • func (instance *DummyAria2) Cancel(task *model.Download) error
  • func (instance *DummyAria2) CreateTask(model *model.Download, options map[string]interface{}) (string, error)
  • func (instance *DummyAria2) DeleteTempFile(src *model.Download) error
  • func (instance *DummyAria2) GetConfig() model.Aria2Option
  • func (instance *DummyAria2) Init() error
  • func (instance *DummyAria2) Select(task *model.Download, files []int) error
  • func (instance *DummyAria2) Status(task *model.Download) (rpc.StatusInfo, error)

Constants

const (
	// URLTask 从URL添加的任务
	URLTask = iota
	// TorrentTask 种子任务
	TorrentTask
)

const (
	// Ready 准备就绪
	Ready = iota
	// Downloading 下载中
	Downloading
	// Paused 暂停中
	Paused
	// Error 出错
	Error
	// Complete 完成
	Complete
	// Canceled 取消/停止
	Canceled
	// Unknown 未知状态
	Unknown
)

Variables

var (
	// ErrNotEnabled 功能未开启错误
	ErrNotEnabled = serializer.NewError(serializer.CodeNoPermissionErr, "离线下载功能未开启", nil)
	// ErrUserNotFound 未找到下载任务创建者
	ErrUserNotFound = serializer.NewError(serializer.CodeNotFound, "无法找到任务创建者", nil)
)

Functions

func GetStatus

func GetStatus(status string) int

GetStatus 将给定的状态字符串转换为状态标识数字

Types

type Aria2

type Aria2 interface {
	// Init 初始化客户端连接
	Init() error
	// CreateTask 创建新的任务
	CreateTask(task *model.Download, options map[string]interface{}) (string, error)
	// 返回状态信息
	Status(task *model.Download) (rpc.StatusInfo, error)
	// 取消任务
	Cancel(task *model.Download) error
	// 选择要下载的文件
	Select(task *model.Download, files []int) error
	// 获取离线下载配置
	GetConfig() model.Aria2Option
	// 删除临时下载文件
	DeleteTempFile(*model.Download) error
}

Aria2 离线下载处理接口

type DummyAria2

type DummyAria2 struct {
}

DummyAria2 未开启Aria2功能时使用的默认处理器

func (*DummyAria2) Cancel

func (instance *DummyAria2) Cancel(task *model.Download) error

Cancel 返回未开启错误

func (*DummyAria2) CreateTask

func (instance *DummyAria2) CreateTask(model *model.Download, options map[string]interface{}) (string, error)

CreateTask 创建新任务，此处直接返回未开启错误

func (*DummyAria2) DeleteTempFile

func (instance *DummyAria2) DeleteTempFile(src *model.Download) error

GetConfig 返回空的

func (*DummyAria2) GetConfig

func (instance *DummyAria2) GetConfig() model.Aria2Option

GetConfig 返回空的

func (*DummyAria2) Init

func (instance *DummyAria2) Init() error

func (*DummyAria2) Select

func (instance *DummyAria2) Select(task *model.Download, files []int) error

Select 返回未开启错误

func (*DummyAria2) Status

func (instance *DummyAria2) Status(task *model.Download) (rpc.StatusInfo, error)

Status 返回未开启错误