Class: ClientReadableStream

grpc~ ClientReadableStream


new ClientReadableStream(call [, deserialize])

A stream that the client can read from. Used for calls that are streaming from the server side.

Parameters:
Name Type Argument Default Description
call grpc.internal~Call

The call object to read data with

deserialize grpc~deserialize <optional>
identity

Deserialization function for reads

Extends

Methods


cancel()

Cancel the ongoing call. Results in the call ending with a CANCELLED status, unless it has already ended with some other status.


getPeer()

Get the endpoint this call/stream is connected to.

Returns:

The URI of the endpoint

Type
string

Events


metadata

Initial response metadata sent by the server when it starts processing the call

Type: grpc.Metadata

status

Status of the call when it has completed.

Type: grpc~StatusObject