streams

Documentation

Index

• func DisableDeleteOnCancel(ctx context.Context) context.Context
• type EOFReader
  • func NewEOFReader(r io.Reader) *EOFReader
  • func (r *EOFReader) HasError() bool
  • func (r *EOFReader) IsEOF() bool
  • func (r *EOFReader) Read(p []byte) (n int, err error)
• type Meta
• type Metadata
• type MetainfoUpload
• type Part
• type PeekThresholdReader
  • func NewPeekThresholdReader(r io.Reader) (pt *PeekThresholdReader)
  • func (pt *PeekThresholdReader) IsLargerThan(thresholdSize int) (bool, error)
  • func (pt *PeekThresholdReader) Read(p []byte) (n int, err error)
• type SizedReader
  • func SizeReader(r io.Reader) *SizedReader
  • func (r *SizedReader) Read(p []byte) (n int, err error)
  • func (r *SizedReader) Size() int64
• type Store
  • func NewStreamStore(metainfo *metaclient.Client, ec ecclient.Client, segmentSize int64, ...) (*Store, error)
  • func (s *Store) Close() error
  • func (s *Store) Get(ctx context.Context, bucket, unencryptedKey string, ...) (rr ranger.Ranger, err error)
  • func (s *Store) Put(ctx context.Context, bucket, unencryptedKey string, data io.Reader, ...) (_ Meta, err error)
  • func (s *Store) PutPart(ctx context.Context, bucket, unencryptedKey string, streamID storj.StreamID, ...) (_ Part, err error)
  • func (s *Store) Ranger(ctx context.Context, response metaclient.DownloadSegmentWithRSResponse) (rr ranger.Ranger, err error)
• type Upload
  • func (u *Upload) Abort() error
  • func (u *Upload) Commit() error
  • func (u *Upload) Meta() *Meta
  • func (u *Upload) Write(p []byte) (int, error)
• type Uploader
  • func NewUploader(metainfo MetainfoUpload, piecePutter pieceupload.PiecePutter, ...) (*Uploader, error)
  • func (u *Uploader) Close() error
  • func (u *Uploader) UploadObject(ctx context.Context, bucket, unencryptedKey string, metadata Metadata, ...) (_ *Upload, err error)
  • func (u *Uploader) UploadPart(ctx context.Context, bucket, unencryptedKey string, streamID storj.StreamID, ...) (_ *Upload, err error)

Functions

func DisableDeleteOnCancel

func DisableDeleteOnCancel(ctx context.Context) context.Context

DisableDeleteOnCancel is now a no-op.

Types

type EOFReader

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

EOFReader holds reader and status of EOF.

func NewEOFReader

func NewEOFReader(r io.Reader) *EOFReader

NewEOFReader keeps track of the state, has the internal reader reached EOF.

func (*EOFReader) HasError

func (r *EOFReader) HasError() bool

HasError returns true if error was returned during reading.

func (*EOFReader) IsEOF

func (r *EOFReader) IsEOF() bool

IsEOF returns true if EOF was returned during reading.

func (*EOFReader) Read

func (r *EOFReader) Read(p []byte) (n int, err error)

type Meta

type Meta struct {
	Modified   time.Time
	Expiration time.Time
	Size       int64
	Data       []byte
}

Meta info about a stream.

type Metadata

type Metadata interface {
	Metadata() ([]byte, error)
}

Metadata interface returns the latest metadata for an object.

type MetainfoUpload

type MetainfoUpload interface {
	metaclient.Batcher
	RetryBeginSegmentPieces(ctx context.Context, params metaclient.RetryBeginSegmentPiecesParams) (metaclient.RetryBeginSegmentPiecesResponse, error)
	io.Closer
}

MetainfoUpload are the metainfo methods needed to upload a stream.

type Part

type Part struct {
	PartNumber uint32
	Size       int64
	Modified   time.Time
	ETag       []byte
}

Part info about a part.

type PeekThresholdReader

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

PeekThresholdReader allows a check to see if the size of a given reader exceeds the maximum inline segment size or not.

func NewPeekThresholdReader

func NewPeekThresholdReader(r io.Reader) (pt *PeekThresholdReader)

NewPeekThresholdReader creates a new instance of PeekThresholdReader.

func (*PeekThresholdReader) IsLargerThan

func (pt *PeekThresholdReader) IsLargerThan(thresholdSize int) (bool, error)

IsLargerThan returns a bool to determine whether a reader's size is larger than the given threshold or not.

func (*PeekThresholdReader) Read

func (pt *PeekThresholdReader) Read(p []byte) (n int, err error)

Read initially reads bytes from the internal buffer, then continues reading from the wrapped data reader. The number of bytes read `n` is returned.

type SizedReader

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

SizedReader allows to check the total number of bytes read so far.

func SizeReader

func SizeReader(r io.Reader) *SizedReader

SizeReader create a new instance of SizedReader.

func (*SizedReader) Read

func (r *SizedReader) Read(p []byte) (n int, err error)

Read implements io.Reader.Read.

func (*SizedReader) Size

func (r *SizedReader) Size() int64

Size returns the total number of bytes read so far.

type Store

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

Store is a store for streams. It implements typedStore as part of an ongoing migration to use typed paths. See the shim for the store that the rest of the world interacts with.

func NewStreamStore

func NewStreamStore(metainfo *metaclient.Client, ec ecclient.Client, segmentSize int64, encStore *encryption.Store, encryptionParameters storj.EncryptionParameters, inlineThreshold, longTailMargin int) (*Store, error)

NewStreamStore constructs a stream store.

func (*Store) Close

func (s *Store) Close() error

Close closes the underlying resources passed to the metainfo DB.

func (*Store) Get

func (s *Store) Get(ctx context.Context, bucket, unencryptedKey string, info metaclient.DownloadInfo) (rr ranger.Ranger, err error)

Get returns a ranger that knows what the overall size is (from l/<key>) and then returns the appropriate data from segments s0/<key>, s1/<key>, ..., l/<key>.

func (*Store) Put

func (s *Store) Put(ctx context.Context, bucket, unencryptedKey string, data io.Reader, metadata Metadata, expiration time.Time) (_ Meta, err error)

Put breaks up data as it comes in into s.segmentSize length pieces, then store the first piece at s0/<key>, second piece at s1/<key>, and the *last* piece at l/<key>. Store the given metadata, along with the number of segments, in a new protobuf, in the metadata of l/<key>.

If there is an error, it cleans up any uploaded segment before returning.

func (*Store) PutPart

func (s *Store) PutPart(ctx context.Context, bucket, unencryptedKey string, streamID storj.StreamID, partNumber uint32, eTagCh <-chan []byte, data io.Reader) (_ Part, err error)

PutPart uploads single part.

func (*Store) Ranger

func (s *Store) Ranger(ctx context.Context, response metaclient.DownloadSegmentWithRSResponse) (rr ranger.Ranger, err error)

Ranger creates a ranger for downloading erasure codes from piece store nodes.

type Upload

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

Upload represents an object or part upload and is returned by PutWriter or PutWriterPart. Data to be uploaded is written using the Write call. Either Commit or Abort must be called to either complete the upload or otherwise free up resources related to the upload.

func (*Upload) Abort

func (u *Upload) Abort() error

Abort aborts the upload. If called more than once, or after Commit, it will return an error.

func (*Upload) Commit

func (u *Upload) Commit() error

Commit commits the upload and must be called for the upload to complete successfully. It should only be called after all of the data has been written.

func (*Upload) Meta

func (u *Upload) Meta() *Meta

Meta returns the upload metadata. It should only be called after a successful Commit and will return nil otherwise.

func (*Upload) Write

func (u *Upload) Write(p []byte) (int, error)

Write uploads the object or part data.

type Uploader

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

Uploader uploads object or part streams.

func NewUploader

func NewUploader(metainfo MetainfoUpload, piecePutter pieceupload.PiecePutter, segmentSize int64, encStore *encryption.Store, encryptionParameters storj.EncryptionParameters, inlineThreshold, longTailMargin int) (*Uploader, error)

NewUploader constructs a new stream putter.

func (*Uploader) Close

func (u *Uploader) Close() error

Close closes the underlying resources for the uploader.

func (*Uploader) UploadObject

func (u *Uploader) UploadObject(ctx context.Context, bucket, unencryptedKey string, metadata Metadata, expiration time.Time, sched segmentupload.Scheduler) (_ *Upload, err error)

UploadObject starts an upload of an object to the given location. The object contents can be written to the returned upload, which can then be committed.

func (*Uploader) UploadPart

func (u *Uploader) UploadPart(ctx context.Context, bucket, unencryptedKey string, streamID storj.StreamID, partNumber int32, eTag <-chan []byte, sched segmentupload.Scheduler) (_ *Upload, err error)

UploadPart starts an upload of a part to the given location for the given multipart upload stream. The eTag is an optional channel is used to provide the eTag to be encrypted and included in the final segment of the part. The eTag should be sent on the channel only after the contents of the part have been fully written to the returned upload, but before calling Commit.