rclone/vendor/storj.io/drpc/drpcstream

package drpcstream

import "storj.io/drpc/drpcstream"

Package drpcstream sends protobufs using the dprc wire protocol.

Usage

type Options

type Options struct {
	// SplitSize controls the default size we split packets into frames.
	SplitSize int
}

Options controls configuration settings for a stream.

type Stream

type Stream struct {
}

Stream represents an rpc actively happening on a transport.

func New

func New(ctx context.Context, sid uint64, wr *drpcwire.Writer) *Stream

New returns a new stream bound to the context with the given stream id and will use the writer to write messages on. It is important use monotonically increasing stream ids within a single transport.

func NewWithOptions

func NewWithOptions(ctx context.Context, sid uint64, wr *drpcwire.Writer, opts Options) *Stream

NewWithOptions returns a new stream bound to the context with the given stream id and will use the writer to write messages on. It is important use monotonically increasing stream ids within a single transport. The options are used to control details of how the Stream operates.

func (*Stream) Cancel

func (s *Stream) Cancel(err error)

Cancel transitions the stream into a state where all writes to the transport will return the provided error, and terminates the stream. It is a no-op if the stream is already terminated.

func (*Stream) Close

func (s *Stream) Close() (err error)

Close terminates the stream and sends that the stream has been closed to the remote. It is a no-op if the stream is already terminated.

func (*Stream) CloseSend

func (s *Stream) CloseSend() (err error)

CloseSend informs the remote that no more messages will be sent. If the remote has also already issued a CloseSend, the stream is terminated. It is a no-op if the stream already has sent a CloseSend or if it is terminated.

func (*Stream) Context

func (s *Stream) Context() context.Context

Context returns the context associated with the stream. It is closed when the Stream will no longer issue any writes or reads.

func (*Stream) Finished

func (s *Stream) Finished() bool

Finished returns true if the stream is fully finished and will no longer issue any writes or reads.

func (*Stream) HandlePacket

func (s *Stream) HandlePacket(pkt drpcwire.Packet) (more bool, err error)

HandlePacket advances the stream state machine by inspecting the packet. It returns any major errors that should terminate the transport the stream is operating on as well as a boolean indicating if the stream expects more packets.

func (*Stream) MsgRecv

func (s *Stream) MsgRecv(msg drpc.Message) (err error)

MsgRecv recives some protobuf data and unmarshals it into msg.

func (*Stream) MsgSend

func (s *Stream) MsgSend(msg drpc.Message) (err error)

MsgSend marshals the message with protobuf, writes it, and flushes.

func (*Stream) RawFlush

func (s *Stream) RawFlush() (err error)

RawFlush flushes any buffers of data.

func (*Stream) RawRecv

func (s *Stream) RawRecv() (data []byte, err error)

RawRecv returns the raw bytes received for a message.

func (*Stream) RawWrite

func (s *Stream) RawWrite(kind drpcwire.Kind, data []byte) (err error)

RawWrite sends the data bytes with the given kind.

func (*Stream) SendError

func (s *Stream) SendError(serr error) (err error)

SendError terminates the stream and sends the error to the remote. It is a no-op if the stream is already terminated.

func (*Stream) Terminated

func (s *Stream) Terminated() <-chan struct{}

Terminated returns a channel when the stream has been terminated.