stream

Documentation

Index

• type PayloadStream
  • func NewAsyncPayloadStream() *PayloadStream
  • func (stream *PayloadStream) AsyncStreamRead() <-chan *PieceEntry
  • func (stream *PayloadStream) Close()
  • func (stream *PayloadStream) InitAsyncPayloadStream(objectID uint64, redundancyType storagetypes.RedundancyType, pieceSize uint64, ...) error
  • func (stream *PayloadStream) StreamClose() error
  • func (stream *PayloadStream) StreamCloseWithError(err error) error
  • func (stream *PayloadStream) StreamWrite(data []byte) (n int, err error)
• type PieceEntry
  • func (entry *PieceEntry) Data() []byte
  • func (entry *PieceEntry) Error() error
  • func (entry *PieceEntry) ObjectID() uint64
  • func (entry *PieceEntry) PieceKey() string

Types

type PayloadStream

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

PayloadStream implements a one-way data flow, writes bytes of any size read the fixed data size with payload metadata

func NewAsyncPayloadStream

func NewAsyncPayloadStream() *PayloadStream

NewAsyncPayloadStream returns an instance of PayloadStream, and start async read stream TODO:: implement the SyncPayloadStream in the future base on requirements

func (*PayloadStream) AsyncStreamRead

func (stream *PayloadStream) AsyncStreamRead() <-chan *PieceEntry

AsyncStreamRead returns a channel which receives PieceEntry

func (*PayloadStream) Close

func (stream *PayloadStream) Close()

Close writes and reads stream by the safe way

func (*PayloadStream) InitAsyncPayloadStream

func (stream *PayloadStream) InitAsyncPayloadStream(objectID uint64, redundancyType storagetypes.RedundancyType,
	pieceSize uint64, ecPieceIndex uint32) error

InitAsyncPayloadStream only be called once, init the payload metadata must be called before write or read stream

func (*PayloadStream) StreamClose

func (stream *PayloadStream) StreamClose() error

StreamClose closes write stream without error

func (*PayloadStream) StreamCloseWithError

func (stream *PayloadStream) StreamCloseWithError(err error) error

StreamCloseWithError closes write stream with error

func (*PayloadStream) StreamWrite

func (stream *PayloadStream) StreamWrite(data []byte) (n int, err error)

StreamWrite writes data with the bytes of any size

type PieceEntry

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

PieceEntry is used to stream produce piece data.

func (*PieceEntry) Data

func (entry *PieceEntry) Data() []byte

Data returns piece data

func (*PieceEntry) Error

func (entry *PieceEntry) Error() error

Error returns stream read error

func (*PieceEntry) ObjectID

func (entry *PieceEntry) ObjectID() uint64

ObjectID returns piece's object id

func (*PieceEntry) PieceKey

func (entry *PieceEntry) PieceKey() string

PieceKey returns piece key, may be ECPieceKey/SegmentPieceKey