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

ServerStream

class ServerStream (View source)

ServerStream is the response object from a gRPC server streaming API call.

Methods

__construct(ServerStreamingCall $serverStreamingCall, array $streamingDescriptor = [])

ServerStream constructor.

Generator|mixed
readAll()

A generator which yields results from the server until the streaming call completes. Throws an ApiException if the streaming call failed.

ServerStreamingCall|mixed
getServerStreamingCall()

Return the underlying gRPC call object

Details

at line 50
__construct(ServerStreamingCall $serverStreamingCall, array $streamingDescriptor = [])

ServerStream constructor.

Parameters

ServerStreamingCall $serverStreamingCall The gRPC server streaming call object
array $streamingDescriptor

at line 65
Generator|mixed readAll()

A generator which yields results from the server until the streaming call completes. Throws an ApiException if the streaming call failed.

Return Value

Generator|mixed

Exceptions

ApiException

at line 90
ServerStreamingCall|mixed getServerStreamingCall()

Return the underlying gRPC call object

Return Value

ServerStreamingCall|mixed