Google API Core Client - Class ServerStream (1.36.0)

Reference documentation and code samples for the Google API Core Client class ServerStream.

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

Namespace

Google \ ApiCore

Methods

__construct

ServerStream constructor.

Parameters
Name Description
serverStreamingCall ServerStreamingCallInterface

The server streaming call object

streamingDescriptor array
logger null|Psr\Log\LoggerInterface

A PSR-3 compliant logger.

readAll

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

Returns
Type Description
Generator|mixed

getServerStreamingCall

Return the underlying call object.

Returns
Type Description
ServerStreamingCallInterface