stream

Documentation

Index

• func StreamTest(t *testing.T, c StreamPairCreator)
• type BrokenStream
  • func (b BrokenStream) Error() string
• type ClientStream
• type ResultChunk
• type ServerStream
• type StreamPairCreator

Functions

func StreamTest

func StreamTest(t *testing.T, c StreamPairCreator)

Types

type BrokenStream

type BrokenStream struct{}

BrokenStream means that the stream broke before we got the trailer. In practice this means that there was an interruption to the stream, meaning the results are not complete-- but all previously received results before the erorr are still valid they just don't constitute the full set of results

func (BrokenStream) Error

func (b BrokenStream) Error() string

type ClientStream

type ClientStream interface {
	Recv() (record.Record, error)
	// Close completes receiving of items
	Close() error
}

type ResultChunk

type ResultChunk struct {
	Results []record.Record `json:"results"`
	Error   string          `json:"error,omitempty"`
}

A chunk of results on the wire

type ServerStream

type ServerStream interface {
	// Methods to send items
	SendResult(record.Record) error
	SendError(error) error
	// Close completes sending of items-- no more items can be sent after Close() is called
	Close() error
}

type StreamPairCreator

type StreamPairCreator func(context.Context) (ServerStream, ClientStream)