Inheritance diagram for default_value_client_interceptor._ConcreteValue:
Public Member Functions | |
| def | __init__ (self, result) |
| def | add_done_callback (self, fn) |
| def | cancel (self) |
| def | cancelled (self) |
| def | done (self) |
| def | exception (self, timeout=None) |
| def | result (self, timeout=None) |
| def | running (self) |
| def | traceback (self, timeout=None) |
Private Attributes | |
| _result | |
Detailed Description
Definition at line 19 of file default_value_client_interceptor.py.
Constructor & Destructor Documentation
◆ __init__()
| def default_value_client_interceptor._ConcreteValue.__init__ | ( | self, | |
| result | |||
| ) |
Definition at line 21 of file default_value_client_interceptor.py.
Member Function Documentation
◆ add_done_callback()
| def default_value_client_interceptor._ConcreteValue.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 45 of file default_value_client_interceptor.py.
◆ cancel()
| def default_value_client_interceptor._ConcreteValue.cancel | ( | self | ) |
Attempts to cancel the computation.
This method does not block.
Returns:
bool:
Returns True if the computation was canceled.
Returns False under all other circumstances, for example:
1. computation has begun and could not be canceled.
2. computation has finished
3. computation is scheduled for execution and it is impossible
to determine its state without blocking.
Reimplemented from grpc.Future.
Definition at line 24 of file default_value_client_interceptor.py.
◆ cancelled()
| def default_value_client_interceptor._ConcreteValue.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 27 of file default_value_client_interceptor.py.
◆ done()
| def default_value_client_interceptor._ConcreteValue.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 33 of file default_value_client_interceptor.py.
◆ exception()
| def default_value_client_interceptor._ConcreteValue.exception | ( | self, | |
timeout = None |
|||
| ) |
Return the exception raised by the computation.
This method may return immediately or may block.
Args:
timeout: The length of time in seconds to wait for the computation to
terminate or be cancelled. If None, the call will block until the
computations's termination.
Returns:
The exception raised by the computation, or None if the computation
did not raise an exception.
Raises:
FutureTimeoutError: If a timeout value is passed and the computation
does not terminate within the allotted time.
FutureCancelledError: If the computation was cancelled.
Reimplemented from grpc.Future.
Definition at line 39 of file default_value_client_interceptor.py.
◆ result()
| def default_value_client_interceptor._ConcreteValue.result | ( | self, | |
timeout = None |
|||
| ) |
Returns the result of the computation or raises its exception.
This method may return immediately or may block.
Args:
timeout: The length of time in seconds to wait for the computation to
finish or be cancelled. If None, the call will block until the
computations's termination.
Returns:
The return value of the computation.
Raises:
FutureTimeoutError: If a timeout value is passed and the computation
does not terminate within the allotted time.
FutureCancelledError: If the computation was cancelled.
Exception: If the computation raised an exception, this call will
raise the same exception.
Reimplemented from grpc.Future.
Definition at line 36 of file default_value_client_interceptor.py.
◆ running()
| def default_value_client_interceptor._ConcreteValue.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 30 of file default_value_client_interceptor.py.
◆ traceback()
| def default_value_client_interceptor._ConcreteValue.traceback | ( | self, | |
timeout = None |
|||
| ) |
Access the traceback of the exception raised by the computation.
This method may return immediately or may block.
Args:
timeout: The length of time in seconds to wait for the computation
to terminate or be cancelled. If None, the call will block until
the computation's termination.
Returns:
The traceback of the exception raised by the computation, or None
if the computation did not raise an exception.
Raises:
FutureTimeoutError: If a timeout value is passed and the computation
does not terminate within the allotted time.
FutureCancelledError: If the computation was cancelled.
Reimplemented from grpc.Future.
Definition at line 42 of file default_value_client_interceptor.py.
Member Data Documentation
◆ _result
|
private |
Definition at line 22 of file default_value_client_interceptor.py.
The documentation for this class was generated from the following file: