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

ServerStream

class ServerStream

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

Methods

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

ServerStream constructor.

static callable
createApiCall(callable $callable, mixed[] $grpcStreamingDescriptor)

No description

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
getServerStreamingCall()

Return the underlying gRPC call object

Details

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

ServerStream constructor.

Parameters

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

at line 63
static callable createApiCall(callable $callable, mixed[] $grpcStreamingDescriptor)

Parameters

callable $callable
mixed[] $grpcStreamingDescriptor

Return Value

callable ApiCall

at line 78
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 103
ServerStreamingCall getServerStreamingCall()

Return the underlying gRPC call object

Return Value

ServerStreamingCall