uploader

Documentation

Overview

Package uploader 上传包

Index

• func DoUpload(uploadURL string, readerlen64 rio.ReaderLen64, checkFunc CheckFunc)
• type BlockState
  • func SplitBlock(fileSize, blockSize int64) (blockList []*BlockState)
• type CheckFunc
• type InstanceState
• type MultiError
  • func (me *MultiError) Error() string
• type MultiUpload
• type MultiUploader
  • func NewMultiUploader(multiUpload MultiUpload, file rio.ReaderAtLen64) *MultiUploader
  • func (muer *MultiUploader) Cancel()
  • func (muer *MultiUploader) Execute()
  • func (muer *MultiUploader) GetStatusChan() <-chan Status
  • func (muer *MultiUploader) InstanceState() *InstanceState
  • func (muer *MultiUploader) OnCancel(onCancelEvent requester.Event)
  • func (muer *MultiUploader) OnError(onErrorEvent requester.EventOnError)
  • func (muer *MultiUploader) OnExecute(onExecuteEvent requester.Event)
  • func (muer *MultiUploader) OnFinish(onFinishEvent requester.Event)
  • func (muer *MultiUploader) OnSuccess(onSuccessEvent requester.Event)
  • func (muer *MultiUploader) SetBlockSize(blockSize int64)
  • func (muer *MultiUploader) SetInstanceState(is *InstanceState)
  • func (muer *MultiUploader) SetParallel(parallel int)
  • func (muer *MultiUploader) UpdateInstanceStateChan() <-chan struct{}
• type ReadRange
• type Readed64
  • func NewReaded64(rl rio.ReaderLen64) Readed64
• type SplitUnit
  • func NewSplitUnit(readerAt io.ReaderAt, readRange ReadRange) SplitUnit
• type Status
• type UploadStatus
  • func (us *UploadStatus) SpeedsPerSecond() int64
  • func (us *UploadStatus) TimeElapsed() time.Duration
  • func (us *UploadStatus) TotalSize() int64
  • func (us *UploadStatus) Uploaded() int64
• type Uploader
  • func NewUploader(url string, readerlen64 rio.ReaderLen64) (uploader *Uploader)
  • func (u *Uploader) Execute()
  • func (u *Uploader) GetStatusChan() <-chan Status
  • func (u *Uploader) OnExecute(fn func())
  • func (u *Uploader) OnFinish(fn func())
  • func (u *Uploader) SetCheckFunc(checkFunc CheckFunc)
  • func (u *Uploader) SetClient(c *requester.HTTPClient)
  • func (u *Uploader) SetContentType(contentType string)

Functions

func DoUpload

func DoUpload(uploadURL string, readerlen64 rio.ReaderLen64, checkFunc CheckFunc)

DoUpload 执行上传

Types

type BlockState

type BlockState struct {
	ID       int       `json:"id"`
	Range    ReadRange `json:"range"`
	CheckSum string    `json:"checksum"`
}

BlockState 文件区块信息

func SplitBlock

func SplitBlock(fileSize, blockSize int64) (blockList []*BlockState)

SplitBlock 文件分块

type CheckFunc

type CheckFunc func(resp *http.Response, uploadErr error)

CheckFunc 上传完成的检测函数

type InstanceState

type InstanceState struct {
	BlockList []*BlockState `json:"block_list"`
}

InstanceState 上传断点续传信息

type MultiError

type MultiError struct {
	Err error
	// IsRetry 是否重试,
	Terminated bool
}

MultiError 多线程上传的错误

func (*MultiError) Error

func (me *MultiError) Error() string

type MultiUpload

type MultiUpload interface {
	Precreate() (perr error)
	TmpFile(ctx context.Context, partseq int, partOffset int64, readerlen64 rio.ReaderLen64) (checksum string, terr error)
	CreateSuperFile(checksumList ...string) (cerr error)
}

MultiUpload 支持多线程的上传, 可用于断点续传

type MultiUploader

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

MultiUploader 多线程上传

func NewMultiUploader

func NewMultiUploader(multiUpload MultiUpload, file rio.ReaderAtLen64) *MultiUploader

NewMultiUploader 初始化上传

func (*MultiUploader) Cancel

func (muer *MultiUploader) Cancel()

Cancel 取消上传

func (*MultiUploader) Execute

func (muer *MultiUploader) Execute()

Execute 执行上传

func (*MultiUploader) GetStatusChan

func (muer *MultiUploader) GetStatusChan() <-chan Status

GetStatusChan 获取上传状态

func (*MultiUploader) InstanceState

func (muer *MultiUploader) InstanceState() *InstanceState

InstanceState 返回断点续传信息

func (*MultiUploader) OnCancel

func (muer *MultiUploader) OnCancel(onCancelEvent requester.Event)

OnCancel 设置取消上传事件

func (*MultiUploader) OnError

func (muer *MultiUploader) OnError(onErrorEvent requester.EventOnError)

OnCancel 设置取消上传事件

func (*MultiUploader) OnExecute

func (muer *MultiUploader) OnExecute(onExecuteEvent requester.Event)

OnExecute 设置开始上传事件

func (*MultiUploader) OnFinish

func (muer *MultiUploader) OnFinish(onFinishEvent requester.Event)

OnFinish 设置结束上传事件

func (*MultiUploader) OnSuccess

func (muer *MultiUploader) OnSuccess(onSuccessEvent requester.Event)

OnSuccess 设置成功上传事件

func (*MultiUploader) SetBlockSize

func (muer *MultiUploader) SetBlockSize(blockSize int64)

SetBlockSize 设置block size

func (*MultiUploader) SetInstanceState

func (muer *MultiUploader) SetInstanceState(is *InstanceState)

SetInstanceState 设置InstanceState, 断点续传信息

func (*MultiUploader) SetParallel

func (muer *MultiUploader) SetParallel(parallel int)

SetParallel 设置parallel, 上传并发量

func (*MultiUploader) UpdateInstanceStateChan

func (muer *MultiUploader) UpdateInstanceStateChan() <-chan struct{}

UpdateInstanceStateChan 更新状态的信号

type ReadRange

type ReadRange struct {
	Begin int64 `json:"begin"`
	End   int64 `json:"end"`
}

ReadRange 读取io.ReaderAt范围

type Readed64

type Readed64 interface {
	rio.ReaderLen64
	Readed() int64
}

Readed64 增加获取已读取数据量, 用于统计速度

func NewReaded64

func NewReaded64(rl rio.ReaderLen64) Readed64

NewReaded64 实现Readed64接口

type SplitUnit

type SplitUnit interface {
	Readed64
	io.Seeker
	Range() ReadRange
	Left() int64
}

SplitUnit 将 io.ReaderAt 分割单元

func NewSplitUnit

func NewSplitUnit(readerAt io.ReaderAt, readRange ReadRange) SplitUnit

NewSplitUnit io.ReaderAt实现SplitUnit接口

type Status

type Status interface {
	TotalSize() int64           // 总大小
	Uploaded() int64            // 已上传数据
	SpeedsPerSecond() int64     // 每秒的上传速度
	TimeElapsed() time.Duration // 上传时间
}

Status 上传状态

type UploadStatus

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

UploadStatus 上传状态

func (*UploadStatus) SpeedsPerSecond

func (us *UploadStatus) SpeedsPerSecond() int64

SpeedsPerSecond 返回每秒的上传速度

func (*UploadStatus) TimeElapsed

func (us *UploadStatus) TimeElapsed() time.Duration

TimeElapsed 返回上传时间

func (*UploadStatus) TotalSize

func (us *UploadStatus) TotalSize() int64

TotalSize 返回总大小

func (*UploadStatus) Uploaded

func (us *UploadStatus) Uploaded() int64

Uploaded 返回已上传数据

type Uploader

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

Uploader 上传

func NewUploader

func NewUploader(url string, readerlen64 rio.ReaderLen64) (uploader *Uploader)

NewUploader 返回 uploader 对象, url: 上传地址, readerlen64: 实现 rio.ReaderLen64 接口的对象, 例如文件

func (*Uploader) Execute

func (u *Uploader) Execute()

Execute 执行上传, 收到返回值信号则为上传结束

func (*Uploader) GetStatusChan

func (u *Uploader) GetStatusChan() <-chan Status

GetStatusChan 获取上传状态

func (*Uploader) OnExecute

func (u *Uploader) OnExecute(fn func())

OnExecute 任务开始时触发的事件

func (*Uploader) OnFinish

func (u *Uploader) OnFinish(fn func())

OnFinish 任务完成时触发的事件

func (*Uploader) SetCheckFunc

func (u *Uploader) SetCheckFunc(checkFunc CheckFunc)

SetCheckFunc 设置上传完成的检测函数

func (*Uploader) SetClient

func (u *Uploader) SetClient(c *requester.HTTPClient)

SetClient 设置http客户端

func (*Uploader) SetContentType

func (u *Uploader) SetContentType(contentType string)

SetContentType 设置Content-Type