class BidiStream (View source)

BidiStream is the response object from a gRPC bidirectional streaming API call.

Methods

__construct(BidiStreamingCall $bidiStreamingCall, array $streamingDescriptor = [])

BidiStream constructor.

write(mixed $request)

Write request to the server.

writeAll(iterable $requests = [])

Write all requests in $requests.

closeWrite()

Inform the server that no more requests will be written. The write() function cannot be called after closeWrite() is called.

mixed
read()

Read the next response from the server. Returns null if the streaming call completed successfully. Throws an ApiException if the streaming call failed.

Generator|array
closeWriteAndReadAll()

Call closeWrite(), and read all responses from the server, until the streaming call is completed. Throws an ApiException if the streaming call failed.

BidiStreamingCall|mixed
getBidiStreamingCall()

Return the underlying gRPC call object

Details

__construct(BidiStreamingCall $bidiStreamingCall, array $streamingDescriptor = [])

BidiStream constructor.

Parameters

BidiStreamingCall $bidiStreamingCall

The gRPC bidirectional streaming call object

array $streamingDescriptor

write(mixed $request)

Write request to the server.

Parameters

mixed $request

The request to write

Exceptions

ValidationException

writeAll(iterable $requests = [])

Write all requests in $requests.

Parameters

iterable $requests

An Iterable of request objects to write to the server

Exceptions

ValidationException

closeWrite()

Inform the server that no more requests will be written. The write() function cannot be called after closeWrite() is called.

Exceptions

ValidationException

mixed read()

Read the next response from the server. Returns null if the streaming call completed successfully. Throws an ApiException if the streaming call failed.

Return Value

mixed

Exceptions

ValidationException
ApiException

Generator|array closeWriteAndReadAll()

Call closeWrite(), and read all responses from the server, until the streaming call is completed. Throws an ApiException if the streaming call failed.

Return Value

Generator|array

Exceptions

ValidationException
ApiException

BidiStreamingCall|mixed getBidiStreamingCall()

Return the underlying gRPC call object

Return Value

BidiStreamingCall|mixed