Public Member Functions | Private Member Functions | Private Attributes | List of all members
grpc.aio._interceptor.InterceptedCall Class Reference
Inheritance diagram for grpc.aio._interceptor.InterceptedCall:
Inheritance graph
[legend]

Public Member Functions

def __del__ (self)
 
None __init__ (self, asyncio.Task interceptors_task)
 
None add_done_callback (self, DoneCallbackType callback)
 
bool cancel (self)
 
bool cancelled (self)
 
grpc.StatusCode code (self)
 
Optional[str] debug_error_string (self)
 
str details (self)
 
bool done (self)
 
Optional[Metadatainitial_metadata (self)
 
Optional[float] time_remaining (self)
 
Optional[Metadatatrailing_metadata (self)
 
None wait_for_connection (self)
 

Private Member Functions

None _fire_or_add_pending_done_callbacks (self, asyncio.Task interceptors_task)
 
None _wrap_add_done_callback (self, DoneCallbackType callback, _base_call.Call unused_call)
 

Private Attributes

 _interceptors_task
 
 _pending_add_done_callbacks
 

Detailed Description

Base implementation for all intercepted call arities.

Interceptors might have some work to do before the RPC invocation with
the capacity of changing the invocation parameters, and some work to do
after the RPC invocation with the capacity for accessing to the wrapped
`UnaryUnaryCall`.

It handles also early and later cancellations, when the RPC has not even
started and the execution is still held by the interceptors or when the
RPC has finished but again the execution is still held by the interceptors.

Once the RPC is finally executed, all methods are finally done against the
intercepted call, being at the same time the same call returned to the
interceptors.

As a base class for all of the interceptors implements the logic around
final status, metadata and cancellation.

Definition at line 262 of file aio/_interceptor.py.

Constructor & Destructor Documentation

◆ __init__()

None grpc.aio._interceptor.InterceptedCall.__init__ (   self,
asyncio.Task  interceptors_task 
)
Base implementation for all intercepted call arities.

Interceptors might have some work to do before the RPC invocation with
the capacity of changing the invocation parameters, and some work to do
after the RPC invocation with the capacity for accessing to the wrapped
`UnaryUnaryCall`.

It handles also early and later cancellations, when the RPC has not even
started and the execution is still held by the interceptors or when the
RPC has finished but again the execution is still held by the interceptors.

Once the RPC is finally executed, all methods are finally done against the
intercepted call, being at the same time the same call returned to the
interceptors.

As a base class for all of the interceptors implements the logic around
final status, metadata and cancellation.

Definition at line 285 of file aio/_interceptor.py.

◆ __del__()

def grpc.aio._interceptor.InterceptedCall.__del__ (   self)

Definition at line 291 of file aio/_interceptor.py.

Member Function Documentation

◆ _fire_or_add_pending_done_callbacks()

None grpc.aio._interceptor.InterceptedCall._fire_or_add_pending_done_callbacks (   self,
asyncio.Task  interceptors_task 
)
private

Definition at line 294 of file aio/_interceptor.py.

◆ _wrap_add_done_callback()

None grpc.aio._interceptor.InterceptedCall._wrap_add_done_callback (   self,
DoneCallbackType  callback,
_base_call.Call  unused_call 
)
private

Definition at line 320 of file aio/_interceptor.py.

◆ add_done_callback()

None grpc.aio._interceptor.InterceptedCall.add_done_callback (   self,
DoneCallbackType  callback 
)

Definition at line 364 of file aio/_interceptor.py.

◆ cancel()

bool grpc.aio._interceptor.InterceptedCall.cancel (   self)

Definition at line 324 of file aio/_interceptor.py.

◆ cancelled()

bool grpc.aio._interceptor.InterceptedCall.cancelled (   self)

Definition at line 340 of file aio/_interceptor.py.

◆ code()

grpc.StatusCode grpc.aio._interceptor.InterceptedCall.code (   self)

Definition at line 404 of file aio/_interceptor.py.

◆ debug_error_string()

Optional[str] grpc.aio._interceptor.InterceptedCall.debug_error_string (   self)

Definition at line 424 of file aio/_interceptor.py.

◆ details()

str grpc.aio._interceptor.InterceptedCall.details (   self)

Definition at line 414 of file aio/_interceptor.py.

◆ done()

bool grpc.aio._interceptor.InterceptedCall.done (   self)

Definition at line 353 of file aio/_interceptor.py.

◆ initial_metadata()

Optional[Metadata] grpc.aio._interceptor.InterceptedCall.initial_metadata (   self)

Definition at line 384 of file aio/_interceptor.py.

◆ time_remaining()

Optional[float] grpc.aio._interceptor.InterceptedCall.time_remaining (   self)

◆ trailing_metadata()

Optional[Metadata] grpc.aio._interceptor.InterceptedCall.trailing_metadata (   self)

Definition at line 394 of file aio/_interceptor.py.

◆ wait_for_connection()

None grpc.aio._interceptor.InterceptedCall.wait_for_connection (   self)

Definition at line 434 of file aio/_interceptor.py.

Member Data Documentation

◆ _interceptors_task

grpc.aio._interceptor.InterceptedCall._interceptors_task
private

Definition at line 286 of file aio/_interceptor.py.

◆ _pending_add_done_callbacks

grpc.aio._interceptor.InterceptedCall._pending_add_done_callbacks
private

Definition at line 287 of file aio/_interceptor.py.


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


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