ecclient

Documentation

Index

• Variables
• type Client
  • func NewClient(log *zap.Logger, dialer rpc.Dialer, memoryLimit int) Client

Variables

var Error = errs.Class("ecclient error")

Error is the errs class of standard Ranger errors

Types

type Client

type Client interface {
	Put(ctx context.Context, limits []*pb.AddressedOrderLimit, privateKey storj.PiecePrivateKey, rs eestream.RedundancyStrategy, data io.Reader, expiration time.Time) (successfulNodes []*pb.Node, successfulHashes []*pb.PieceHash, err error)
	Get(ctx context.Context, limits []*pb.AddressedOrderLimit, privateKey storj.PiecePrivateKey, es eestream.ErasureScheme, size int64) (ranger.Ranger, error)
	Delete(ctx context.Context, limits []*pb.AddressedOrderLimit, privateKey storj.PiecePrivateKey) error
	WithForceErrorDetection(force bool) Client
	// PutPiece is not intended to be used by normal uplinks directly, but is exported to support storagenode graceful exit transfers.
	PutPiece(ctx, parent context.Context, limit *pb.AddressedOrderLimit, privateKey storj.PiecePrivateKey, data io.ReadCloser, expiration time.Time) (hash *pb.PieceHash, err error)
}

Client defines an interface for storing erasure coded data to piece store nodes

func NewClient

func NewClient(log *zap.Logger, dialer rpc.Dialer, memoryLimit int) Client

NewClient from the given identity and max buffer memory