file

README

Go File

Go File is a file server library leveraging go-micro. It enables you to serve and consume files via RPC.

This is a stripped down version of gotransfer.

Usage

Server

import "github.com/micro/go-file"

service := micro.NewService(
	micro.Name("go.micro.srv.file"),
)

proto.RegisterFileHandler(service.Server(), file.NewHandler("/tmp"))

service.Init()
service.Run()

Client

import "github.com/micro/go-file"

// use new service or default client
service := micro.NewService()
service.Init()

client := file.NewClient("go.micro.srv.file", service.Client())
client.Download("remote.file", "local.file")

Hand Wavy Bench

Local hand wavy benchmarks for rough estimates on transfer speed

size	time taken
1mb	15.590542ms
8mb	75.184788ms
64mb	516.236417ms
128mb	1.141906576s
1024mb	9.794891634s

Using connection pooling and caching selector

size	time taken
1mb	13.521179ms
8mb	53.160487ms
64mb	415.388025ms
128mb	889.409332ms
512mb	4.177052391s
1024mb	8.347038098s

Documentation

Index

• func NewHandler(readDir string) proto.FileHandler
• func RegisterHandler(s server.Server, readDir string)
• type Client
  • func NewClient(service string, c client.Client) Client

Functions

func NewHandler

func NewHandler(readDir string) proto.FileHandler

NewHandler is a handler that can be registered with a micro Server

func RegisterHandler

func RegisterHandler(s server.Server, readDir string)

RegisterHandler is a convenience method for registering a handler

Types

type Client

type Client interface {
	Open(filename string) (int64, error)
	Stat(filename string) (*proto.StatResponse, error)
	GetBlock(sessionId, blockId int64) ([]byte, error)
	ReadAt(sessionId, offset, size int64) ([]byte, error)
	Read(sessionId int64, buf []byte) (int, error)
	Close(sessionId int64) error
	Download(filename, saveFile string) error
	DownloadAt(filename, saveFile string, blockId int) error
}

Client is the client interface to access files

func NewClient

func NewClient(service string, c client.Client) Client

NewClient returns a new Client which uses a micro Client