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

ServerStream

class ServerStream (View source)

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

Methods

__construct(ServerStreamingCallInterface $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.

ServerStreamingCallInterface
getServerStreamingCall()

Return the underlying call object.

Details

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

ServerStream constructor.

Parameters

ServerStreamingCallInterface $serverStreamingCall

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

Return the underlying call object.

Return Value

ServerStreamingCallInterface