piecestore

Documentation

Index

• Variables
• type Client
  • func DialNodeURL(ctx context.Context, dialer rpc.Dialer, nodeURL storj.NodeURL, log *zap.Logger, ...) (*Client, error)
  • func (client *Client) Close() error
  • func (client *Client) Download(ctx context.Context, limit *pb.OrderLimit, ...) (_ Downloader, err error)
  • func (client *Client) GetPeerIdentity() (*identity.PeerIdentity, error)
  • func (client *Client) Retain(ctx context.Context, req *pb.RetainRequest) (err error)
  • func (client *Client) UploadReader(ctx context.Context, limit *pb.OrderLimit, ...) (hash *pb.PieceHash, err error)
  • func (client *Client) VerifyPieceHash(ctx context.Context, peer *identity.PeerIdentity, limit *pb.OrderLimit, ...) (err error)
• type Config
• type Download
  • func (client *Download) Close() (err error)
  • func (client *Download) GetHashAndLimit() (*pb.PieceHash, *pb.OrderLimit)
  • func (client *Download) Read(data []byte) (read int, err error)
• type Downloader
• type LockingDownload
  • func (download *LockingDownload) Close() error
  • func (download *LockingDownload) GetHashAndLimit() (*pb.PieceHash, *pb.OrderLimit)
  • func (download *LockingDownload) Read(p []byte) (int, error)
• type ReadBuffer
  • func (buffer *ReadBuffer) Empty() bool
  • func (buffer *ReadBuffer) Error() error
  • func (buffer *ReadBuffer) Errored() bool
  • func (buffer *ReadBuffer) Fill(data []byte)
  • func (buffer *ReadBuffer) IncludeError(err error)
  • func (buffer *ReadBuffer) Read(data []byte) (n int, err error)

Variables

var (
	// ErrInternal is an error class for internal errors.
	ErrInternal = errs.Class("internal")
	// ErrProtocol is an error class for unexpected protocol sequence.
	ErrProtocol = errs.Class("protocol")
	// ErrVerifyUntrusted is an error in case there is a trust issue.
	ErrVerifyUntrusted = errs.Class("untrusted")
	// ErrStorageNodeInvalidResponse is an error when a storage node returns a response with invalid data.
	ErrStorageNodeInvalidResponse = errs.Class("storage node has returned an invalid response")
)

var DefaultConfig = Config{
	DownloadBufferSize: 256 * memory.KiB.Int64(),

	InitialStep: 64 * memory.KiB.Int64(),
	MaximumStep: 256 * memory.KiB.Int64(),
}

DefaultConfig are the default params used for upload and download.

var Error = errs.Class("piecestore")

Error is the default error class for piecestore client.

Types

type Client

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

Client implements uploading, downloading and deleting content from a piecestore.

func DialNodeURL

func DialNodeURL(ctx context.Context, dialer rpc.Dialer, nodeURL storj.NodeURL, log *zap.Logger, config Config) (*Client, error)

DialNodeURL dials the target piecestore endpoint.

func (*Client) Close

func (client *Client) Close() error

Close closes the underlying connection.

func (*Client) Download

func (client *Client) Download(ctx context.Context, limit *pb.OrderLimit, piecePrivateKey storj.PiecePrivateKey, offset, size int64) (_ Downloader, err error)

Download starts a new download using the specified order limit at the specified offset and size.

func (*Client) GetPeerIdentity

func (client *Client) GetPeerIdentity() (*identity.PeerIdentity, error)

GetPeerIdentity gets the connection's peer identity.

func (*Client) Retain

func (client *Client) Retain(ctx context.Context, req *pb.RetainRequest) (err error)

Retain uses a bloom filter to tell the piece store which pieces to keep.

func (*Client) UploadReader

func (client *Client) UploadReader(ctx context.Context, limit *pb.OrderLimit, piecePrivateKey storj.PiecePrivateKey, data io.Reader) (hash *pb.PieceHash, err error)

UploadReader uploads to the storage node.

func (*Client) VerifyPieceHash

func (client *Client) VerifyPieceHash(ctx context.Context, peer *identity.PeerIdentity, limit *pb.OrderLimit, hash *pb.PieceHash, expectedHash []byte) (err error)

VerifyPieceHash verifies piece hash which is sent by peer.

type Config

type Config struct {
	DownloadBufferSize int64

	InitialStep int64
	MaximumStep int64
}

Config defines piecestore client parameters for upload and download.

type Download

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

Download implements downloading from a piecestore.

func (*Download) Close

func (client *Download) Close() (err error)

Close closes the downloading.

func (*Download) GetHashAndLimit

func (client *Download) GetHashAndLimit() (*pb.PieceHash, *pb.OrderLimit)

GetHashAndLimit gets the download's hash and original order limit.

func (*Download) Read

func (client *Download) Read(data []byte) (read int, err error)

Read downloads data from the storage node allocating as necessary.

type Downloader

type Downloader interface {
	Read([]byte) (int, error)
	Close() error
	GetHashAndLimit() (*pb.PieceHash, *pb.OrderLimit)
}

Downloader is interface that can be used for downloading content. It matches signature of `io.ReadCloser`, with one extra function, GetHashAndLimit(), used for accessing information during GET_REPAIR.

type LockingDownload

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

LockingDownload adds a lock around download making it safe to use concurrently. TODO: this shouldn't be needed.

func (*LockingDownload) Close

func (download *LockingDownload) Close() error

Close closes the deownload.

func (*LockingDownload) GetHashAndLimit

func (download *LockingDownload) GetHashAndLimit() (*pb.PieceHash, *pb.OrderLimit)

GetHashAndLimit gets the download's hash and original order limit.

func (*LockingDownload) Read

func (download *LockingDownload) Read(p []byte) (int, error)

Read downloads content.

type ReadBuffer

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

ReadBuffer implements buffered reading with an error.

func (*ReadBuffer) Empty

func (buffer *ReadBuffer) Empty() bool

Empty checks whether buffer needs to be filled.

func (*ReadBuffer) Error

func (buffer *ReadBuffer) Error() error

Error returns an error if it was encountered.

func (*ReadBuffer) Errored

func (buffer *ReadBuffer) Errored() bool

Errored returns whether the buffer contains an error.

func (*ReadBuffer) Fill

func (buffer *ReadBuffer) Fill(data []byte)

Fill fills the buffer with the specified bytes.

func (*ReadBuffer) IncludeError

func (buffer *ReadBuffer) IncludeError(err error)

IncludeError adds error at the end of the buffer.

func (*ReadBuffer) Read

func (buffer *ReadBuffer) Read(data []byte) (n int, err error)

Read reads from the buffer.