resumable

README

go-resumable

It's a Go library providing multiple simultaneous and resumable uploads.

Library is designed to introduce fault-tolerance into the upload of large files throught HTTP. This is done by splitting each file into small chunks; whenever the upload of a chunk fails, uploading is retried until the procedure completes. This allows uploads to automatically resume uploading after a network connection is lost either locally or to the server. Additionally, it allows users to pause, resume and even recover uploads without losing state.

Demo

In this demo upload is paused for 2 seconds after initial second, then it uploads till 100%.

Please check here for full code sample.

Installation

$ go get -v https://github.com/bleenco/go-resumable

Usage

import (
  "net/http"

  "github.com/bleenco/go-resumable"
)

func main() {
  httpClient := &http.Client{}
  url := "http://example.com/upload"
  filePath := "/path/to/file/to/upload.zip"
  chunkSize := int(1 * (1 << 20)) // 1MB
  client := resumable.New(url, filePath, httpClient, chunkSize)

  client.Init()
  client.Start()

  resumable.WG.Wait() // this is important
}

Licence

MIT

Documentation

Index

• Variables
• func HTTPHandler(w http.ResponseWriter, r *http.Request)
• type Resumable
  • func New(url string, filePath string, client *http.Client, chunkSize int, debug bool) *Resumable
  • func (c *Resumable) Cancel()
  • func (c *Resumable) Init()
  • func (c *Resumable) Pause()
  • func (c *Resumable) Start()
• type UploadStatus

Variables

var FileStorage = fileStorage{
	Path:     "./files",
	TempPath: ".tmp",
}

FileStorage settings. When finished uploading with success files are stored inside Path config. While uploading temporary files are stored inside TempPath directory.

var WG sync.WaitGroup

WG exports wait group, so we can wait for it

Functions

func HTTPHandler

func HTTPHandler(w http.ResponseWriter, r *http.Request)

HTTPHandler is main request/response handler for HTTP server.

Types

type Resumable

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

Resumable structure

func New

func New(url string, filePath string, client *http.Client, chunkSize int, debug bool) *Resumable

New creates new instance of resumable Client

func (*Resumable) Cancel

func (c *Resumable) Cancel()

Cancel set upload state to stopped

func (*Resumable) Init

func (c *Resumable) Init()

Init method initializes upload

func (*Resumable) Pause

func (c *Resumable) Pause()

Pause set upload state to paused

func (*Resumable) Start

func (c *Resumable) Start()

Start set upload state to uploading

type UploadStatus

type UploadStatus struct {
	Size             int64
	SizeTransferred  int64
	Parts            uint64
	PartsTransferred uint64
}

UploadStatus holds the data about upload