GRPC PHP  1.38.0
Public Member Functions
Grpc\ServerStreamingCall Class Reference

Represents an active call that sends a single message and then gets a stream of responses. More...

Public Member Functions

 start ($data, array $metadata=[], array $options=[])
 Start the call. More...
 
 responses ()
 
 getStatus ()
 Wait for the server to send the status, and return it. More...
 
 getMetadata ()
 
- Public Member Functions inherited from Grpc\AbstractCall
 __construct (Channel $channel, $method, $deserialize, array $options=[])
 Create a new Call wrapper object. More...
 
 getTrailingMetadata ()
 
 getPeer ()
 
 cancel ()
 Cancels the call. More...
 
 setCallCredentials ($call_credentials)
 Set the CallCredentials for the underlying Call. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Grpc\AbstractCall
 _serializeMessage ($data)
 Serialize a message to the protobuf binary format. More...
 
 _deserializeResponse ($value)
 Deserialize a response value to an object. More...
 
- Protected Attributes inherited from Grpc\AbstractCall
 $call
 
 $deserialize
 
 $metadata
 
 $trailing_metadata
 

Detailed Description

Represents an active call that sends a single message and then gets a stream of responses.

Member Function Documentation

◆ getMetadata()

Grpc\ServerStreamingCall::getMetadata ( )
Returns
mixed The metadata sent by the server

Reimplemented from Grpc\AbstractCall.

◆ getStatus()

Grpc\ServerStreamingCall::getStatus ( )

Wait for the server to send the status, and return it.

Returns
\stdClass The status object, with integer $code, string $details, and array $metadata members

◆ responses()

Grpc\ServerStreamingCall::responses ( )
Returns
mixed An iterator of response values

◆ start()

Grpc\ServerStreamingCall::start (   $data,
array  $metadata = [],
array  $options = [] 
)

Start the call.

Parameters
mixed$dataThe data to send
array$metadataMetadata to send with the call, if applicable (optional)
array$optionsAn array of options, possible keys: 'flags' => a number (optional)

The documentation for this class was generated from the following file: