final class ServerStreamingCall extends Call

Methods

__construct(StreamState $state, string $method, string $peer, array|callable $deserialize, Deadline $deadline, RetryPolicy|null $retryPolicy = null, Closure|null $attemptFactory = null, RetryBackoff|null $retryBackoff = null, GrpcOperationHandle|null $operationHandle = null)

Create an active server-streaming call.

metadata()

Return the server's initial metadata.

from  Call
trailers()

Return the server's trailing metadata.

from  Call
status()

Return the final gRPC status without throwing for an RPC error.

from  Call
string
peer()

Return the normalized peer authority selected for this call.

from  Call
void
cancel()

Cancel this logical call.

from  Call
Message
waitForUnaryResponse()

Resolve and cache a unary response for every concurrent waiter.

from  Call
Message|null
readResponse()

Read and deserialize the next response message.

from  Call
void
beginReading()

Claim this call's single streaming response reader.

from  Call
void
endReading()

Release this call's streaming response reader.

from  Call
void
configureWriter(Connection $connection, FrameEncoder $requestEncoder, Compression $requestCompression)

Configure client-streaming request writes.

from  Call
void
writeRequest(Message $message)

Write one client-streaming request message.

from  Call
void
finishWrites()

Half-close the client-streaming request body.

from  Call
__destruct()

Release unfinished native call resources.

from  Call
Message|null
read()

Read the next response message or return null after a clean end.

iterable
responses()

Yield every response message until the server completes the stream.

Details

at line 22
__construct(StreamState $state, string $method, string $peer, array|callable $deserialize, Deadline $deadline, RetryPolicy|null $retryPolicy = null, Closure|null $attemptFactory = null, RetryBackoff|null $retryBackoff = null, GrpcOperationHandle|null $operationHandle = null)

internal  
 

Create an active server-streaming call.

Parameters

StreamState $state
string $method
string $peer
array|callable $deserialize
Deadline $deadline
RetryPolicy|null $retryPolicy
Closure|null $attemptFactory
RetryBackoff|null $retryBackoff
GrpcOperationHandle|null $operationHandle

in Call at line 121
Metadata metadata()

Return the server's initial metadata.

Return Value

Metadata

in Call at line 167
Metadata trailers()

Return the server's trailing metadata.

Return Value

Metadata

in Call at line 198
Status status()

Return the final gRPC status without throwing for an RPC error.

Return Value

Status

in Call at line 228
string peer()

Return the normalized peer authority selected for this call.

Return Value

string

in Call at line 236
void cancel()

Cancel this logical call.

Return Value

void

in Call at line 281
protected Message waitForUnaryResponse()

Resolve and cache a unary response for every concurrent waiter.

Return Value

Message

in Call at line 332
protected Message|null readResponse()

Read and deserialize the next response message.

Return Value

Message|null

in Call at line 342
protected void beginReading()

Claim this call's single streaming response reader.

Return Value

void

in Call at line 354
protected void endReading()

Release this call's streaming response reader.

Return Value

void

in Call at line 362
protected void configureWriter(Connection $connection, FrameEncoder $requestEncoder, Compression $requestCompression)

Configure client-streaming request writes.

Parameters

Connection $connection
FrameEncoder $requestEncoder
Compression $requestCompression

Return Value

void

in Call at line 384
protected void writeRequest(Message $message)

Write one client-streaming request message.

Parameters

Message $message

Return Value

void

in Call at line 448
protected void finishWrites()

Half-close the client-streaming request body.

Return Value

void

in Call at line 959
__destruct()

Release unfinished native call resources.

at line 49
Message|null read()

Read the next response message or return null after a clean end.

Return Value

Message|null

at line 65
iterable responses()

Yield every response message until the server completes the stream.

Return Value

iterable