1. class
  2. Google
  3. \
  4. ApiCore
  5. \
  6. ClientStream

ClientStream

class ClientStream

ClientStream is the response object from a gRPC client streaming API call.

Methods

__construct(ClientStreamingCall $clientStreamingCall, array $streamingDescriptor = [])

ClientStream constructor.

write(mixed $request)

Write request to the server.

mixed
readResponse()

Read the response from the server, completing the streaming call.

mixed
writeAllAndReadResponse(mixed[] $requests)

Write all data in $dataArray and read the response from the server, completing the streaming call.

ClientStreamingCall|mixed
getClientStreamingCall()

Return the underlying gRPC call object

Details

at line 49
__construct(ClientStreamingCall $clientStreamingCall, array $streamingDescriptor = [])

ClientStream constructor.

Parameters

ClientStreamingCall $clientStreamingCall The gRPC client streaming call object
array $streamingDescriptor

at line 59
write(mixed $request)

Write request to the server.

Parameters

mixed $request The request to write

at line 70
mixed readResponse()

Read the response from the server, completing the streaming call.

Return Value

mixed The response object from the server

Exceptions

ApiException

at line 87
mixed writeAllAndReadResponse(mixed[] $requests)

Write all data in $dataArray and read the response from the server, completing the streaming call.

Parameters

mixed[] $requests An iterator of request objects to write to the server

Return Value

mixed The response object from the server

at line 100
ClientStreamingCall|mixed getClientStreamingCall()

Return the underlying gRPC call object

Return Value

ClientStreamingCall|mixed