package protocol.streams

Get desktop application:
View/edit binary Protocol Buffers messages

The performer should stream back responses as fast as it can.

Used in: Config

(message has no fields)

A request for the performer to cancel a stream. Exactly what this entails is context and SDK dependent. If the SDK's stream has the concept of user-cancellation, this should be invoked. At minimum, the performer should stop streaming responses from that stream to the driver. The performer can assume that if the driver tries to cancel a stream that doesn't exist (e.g. has stopped streaming), this is a driver bug. As a corollary, the driver will only cancel `stream_when.OnDemand` streams. Otherwise it would be a race as to whether the stream completes or is cancelled first. On cancellation the performer should not proceed to the next stage of streaming. E.g. it should not return a streams.Complete. But instead return a streams.Cancelled, after it has finished cancelling.

Used as request type in: PerformerService.streamCancel

• string stream_id = 1

The performer has successfully cancelled the stream. Due to the asynchronous nature of streaming and cancelling, a few items may still be streamed back to the driver after this is sent.

Currently empty, but included per GRPC best practices.

Used as response type in: PerformerService.streamCancel

(message has no fields)

A stream has finished being cancelled.

Used in: Signal

• string stream_id = 1

A stream has finished sending back all results.

Used in: Signal

• string stream_id = 1

Used in: sdk.kv.GetAllReplicas, sdk.kv.lookup_in.LookupInAllReplicas, sdk.kv.rangescan.Scan, sdk.search.Search, sdk.search.SearchWrapper

• string stream_id = 1

  The performer must use this as the subsequent stream id. (Having stream ids generated driver-side will make it much easier for the driver to handle concurrent tests in future.)

• oneof stream_when

  When the performer should stream back results.

  • Automatically automatically = 2

  • OnDemand on_demand = 3

The performer has created a stream and is notifying the driver of it.

Used in: Signal

• string stream_id = 1

• Type type = 2

A stream raised an error.

Used in: Signal

• string stream_id = 1

• optional shared.Exception exception = 2

The performer must wait for the driver to request rows before streaming them.

Used in: Config

(message has no fields)

The driver (pretending to be the user) is requesting more items. For each item requested, the performer should fetch one from the stream, and stream back an appropriate response. Once all items in the stream have been streamed, the performer should automatically proceed to the next stage of streaming (usually to return a streams.Complete). FIT is aware that some implementations (such as Go), don't have any lookahead, and that if the user/driver requests N items on a N item stream, the implementation does not know the stream is complete yet - the user/driver needs to request item N+1 first. To simplify the performer logic, the performer can assume that if the driver does any of these, it is a driver bug. It should raise a standard GRPC UNKNOWN error code: 1. If the driver tries to do this with a stream that doesn't exist (e.g. has stopped streaming), 2. If the driver requests more items before the performer has finished streaming back the previously requested items. If the driver requests more items than are currently in the stream, this is not an error, the performer should stream back as many as it can, and then wait for more items so it can satisfy the request. If the performer knows the stream has finished and the driver has still requested too many items, this is also not a bug. The performer should continue to the next stage of streaming (usually to return a streams.Complete).

Used as request type in: PerformerService.streamRequestItems

• string stream_id = 1

• int32 num_items = 2

Currently empty, but included per GRPC best practices.

Used as response type in: PerformerService.streamRequestItems

(message has no fields)

Used in: run.Result

• oneof signal

  • Created created = 1

  • Complete complete = 2

  • Error error = 3

  • Cancelled cancelled = 4

Used in: Created

• STREAM_KV_RANGE_SCAN = 0

• STREAM_FULL_TEXT_SEARCH = 1

• STREAM_LOOKUP_IN_ALL_REPLICAS = 2

• STREAM_KV_GET_ALL_REPLICAS = 3