Inheritance diagram for grpc._channel._MultiThreadedRendezvous:
Public Member Functions | |
| def | add_done_callback (self, fn) |
| def | cancelled (self) |
| def | code (self) |
| def | debug_error_string (self) |
| def | details (self) |
| def | done (self) |
| def | exception (self, timeout=None) |
| def | initial_metadata (self) |
| def | result (self, timeout=None) |
| def | running (self) |
| def | traceback (self, timeout=None) |
| def | trailing_metadata (self) |
 Public Member Functions inherited from grpc._channel._Rendezvous | |
| def | __del__ (self) |
| def | __init__ (self, state, call, response_deserializer, deadline) |
| def | __iter__ (self) |
| def | __next__ (self) |
| def | __repr__ (self) |
| def | __str__ (self) |
| def | add_callback (self, callback) |
| def | cancel (self) |
| def | is_active (self) |
| def | next (self) |
| def | time_remaining (self) |
| Public Member Functions inherited from grpc.Future | |
| def | cancel (self) |
Private Member Functions | |
| def | _is_complete (self) |
| def | _next (self) |
Detailed Description
An RPC iterator that depends on a channel spin thread. This iterator relies upon a per-channel thread running in the background, dequeueing events from the completion queue, and notifying threads waiting on the threading.Condition object in the _RPCState object. This extra thread allows _MultiThreadedRendezvous to fulfill the grpc.Future interface and to mediate a bidirection streaming RPC.
Definition at line 652 of file grpc/_channel.py.
Member Function Documentation
◆ _is_complete()
|
private |
Definition at line 724 of file grpc/_channel.py.
◆ _next()
|
private |
Reimplemented from grpc._channel._Rendezvous.
Definition at line 795 of file grpc/_channel.py.
◆ add_done_callback()
| def grpc._channel._MultiThreadedRendezvous.add_done_callback | ( | self, | |
| fn | |||
| ) |
Adds a function to be called at completion of the computation. The callback will be passed this Future object describing the outcome of the computation. Callbacks will be invoked after the future is terminated, whether successfully or not. If the computation has already completed, the callback will be called immediately. Exceptions raised in the callback will be logged at ERROR level, but will not terminate any threads of execution. Args: fn: A callable taking this Future object as its single parameter.
Reimplemented from grpc.Future.
Definition at line 787 of file grpc/_channel.py.
◆ cancelled()
| def grpc._channel._MultiThreadedRendezvous.cancelled | ( | self | ) |
Describes whether the computation was cancelled.
This method does not block.
Returns:
bool:
Returns True if the computation was cancelled before its result became
available.
Returns False under all other circumstances, for example:
1. computation was not cancelled.
2. computation's result is available.
Reimplemented from grpc.Future.
Definition at line 712 of file grpc/_channel.py.
◆ code()
| def grpc._channel._MultiThreadedRendezvous.code | ( | self | ) |
◆ debug_error_string()
| def grpc._channel._MultiThreadedRendezvous.debug_error_string | ( | self | ) |
Reimplemented from grpc._channel._Rendezvous.
Definition at line 703 of file grpc/_channel.py.
◆ details()
| def grpc._channel._MultiThreadedRendezvous.details | ( | self | ) |
See grpc.Call.details
Reimplemented from grpc.Call.
Definition at line 693 of file grpc/_channel.py.
◆ done()
| def grpc._channel._MultiThreadedRendezvous.done | ( | self | ) |
Describes whether the computation has taken place.
This method does not block.
Returns:
bool:
Returns True if the computation already executed or was cancelled.
Returns False if the computation is scheduled for execution or
currently executing.
This is exactly opposite of the running() method's result.
Reimplemented from grpc.Future.
Definition at line 720 of file grpc/_channel.py.
◆ exception()
| def grpc._channel._MultiThreadedRendezvous.exception | ( | self, | |
timeout = None |
|||
| ) |
Return the exception raised by the computation. See grpc.Future.exception for the full API contract.
Reimplemented from grpc.Future.
Definition at line 746 of file grpc/_channel.py.
◆ initial_metadata()
| def grpc._channel._MultiThreadedRendezvous.initial_metadata | ( | self | ) |
See grpc.Call.initial_metadata
Reimplemented from grpc.Call.
Definition at line 663 of file grpc/_channel.py.
◆ result()
| def grpc._channel._MultiThreadedRendezvous.result | ( | self, | |
timeout = None |
|||
| ) |
Returns the result of the computation or raises its exception. See grpc.Future.result for the full API contract.
Reimplemented from grpc.Future.
Definition at line 727 of file grpc/_channel.py.
◆ running()
| def grpc._channel._MultiThreadedRendezvous.running | ( | self | ) |
Describes whether the computation is taking place.
This method does not block.
Returns:
Returns True if the computation is scheduled for execution or
currently executing.
Returns False if the computation already executed or was cancelled.
Reimplemented from grpc.Future.
Definition at line 716 of file grpc/_channel.py.
◆ traceback()
| def grpc._channel._MultiThreadedRendezvous.traceback | ( | self, | |
timeout = None |
|||
| ) |
Access the traceback of the exception raised by the computation. See grpc.future.traceback for the full API contract.
Reimplemented from grpc.Future.
Definition at line 765 of file grpc/_channel.py.
◆ trailing_metadata()
| def grpc._channel._MultiThreadedRendezvous.trailing_metadata | ( | self | ) |
See grpc.Call.trailing_metadata
Reimplemented from grpc.Call.
Definition at line 673 of file grpc/_channel.py.
The documentation for this class was generated from the following file: