Public Member Functions | List of all members
grpc.aio._base_call.StreamStreamCall Class Reference
Inheritance diagram for grpc.aio._base_call.StreamStreamCall:
Inheritance graph
[legend]

Public Member Functions

AsyncIterable[ResponseType] __aiter__ (self)
 
None done_writing (self)
 
Union[EOFType, ResponseType] read (self)
 
None write (self, RequestType request)
 
- Public Member Functions inherited from grpc.aio._base_call.Call
grpc.StatusCode code (self)
 
str details (self)
 
Metadata initial_metadata (self)
 
Metadata trailing_metadata (self)
 
None wait_for_connection (self)
 
- Public Member Functions inherited from grpc.aio._base_call.RpcContext
None add_done_callback (self, DoneCallbackType callback)
 
bool cancel (self)
 
bool cancelled (self)
 
bool done (self)
 
Optional[float] time_remaining (self)
 

Detailed Description

Definition at line 210 of file _base_call.py.

Member Function Documentation

◆ __aiter__()

AsyncIterable[ResponseType] grpc.aio._base_call.StreamStreamCall.__aiter__ (   self)
Returns the async iterable representation that yields messages.

Under the hood, it is calling the "read" method.

Returns:
  An async iterable object that yields messages.

Definition at line 213 of file _base_call.py.

◆ done_writing()

None grpc.aio._base_call.StreamStreamCall.done_writing (   self)
Notifies server that the client is done sending messages.

After done_writing is called, any additional invocation to the write
function will fail. This function is idempotent.

Reimplemented in grpc.aio._interceptor.StreamStreamCallResponseIterator.

Definition at line 243 of file _base_call.py.

◆ read()

Union[EOFType, ResponseType] grpc.aio._base_call.StreamStreamCall.read (   self)
Reads one message from the stream.

Read operations must be serialized when called from multiple
coroutines.

Returns:
  A response message, or an `grpc.aio.EOF` to indicate the end of the
  stream.

Reimplemented in grpc.aio._interceptor.StreamStreamCallResponseIterator.

Definition at line 223 of file _base_call.py.

◆ write()

None grpc.aio._base_call.StreamStreamCall.write (   self,
RequestType  request 
)
Writes one message to the stream.

Raises:
  An RpcError exception if the write failed.

Reimplemented in grpc.aio._interceptor.StreamStreamCallResponseIterator.

Definition at line 235 of file _base_call.py.


The documentation for this class was generated from the following file:


grpc
Author(s):
autogenerated on Fri May 16 2025 03:03:32