CIRCT 24.0.0git
Loading...
Searching...
No Matches
esiaccel.types.MessageFuture Class Reference
Inheritance diagram for esiaccel.types.MessageFuture:
Collaboration diagram for esiaccel.types.MessageFuture:

Public Member Functions

 __init__ (self, Type result_type, cpp.MessageDataFuture cpp_future)
bool running (self)
bool done (self)
Any result (self, Optional[Union[int, float]] timeout=None)
None add_done_callback (self, Callable[[Future], object] fn)

Public Attributes

 result_type = result_type
 cpp_future = cpp_future

Detailed Description

A specialization of `Future` for ESI messages. Wraps the cpp object and
deserializes the result.  Hopefully overrides all the methods necessary for
proper operation, which is assumed to be not all of them.

Definition at line 677 of file types.py.

Constructor & Destructor Documentation

◆ __init__()

esiaccel.types.MessageFuture.__init__ ( self,
Type result_type,
cpp.MessageDataFuture cpp_future )

Definition at line 682 of file types.py.

Member Function Documentation

◆ add_done_callback()

None esiaccel.types.MessageFuture.add_done_callback ( self,
Callable[[Future], object] fn )

Definition at line 701 of file types.py.

◆ done()

bool esiaccel.types.MessageFuture.done ( self)

Definition at line 689 of file types.py.

References cpp_future.

◆ result()

Any esiaccel.types.MessageFuture.result ( self,
Optional[Union[int, float]] timeout = None )

Definition at line 692 of file types.py.

References cpp_future, and result_type.

◆ running()

bool esiaccel.types.MessageFuture.running ( self)

Definition at line 686 of file types.py.

Member Data Documentation

◆ cpp_future

esiaccel.types.MessageFuture.cpp_future = cpp_future

Definition at line 684 of file types.py.

Referenced by done(), and result().

◆ result_type

esiaccel.types.MessageFuture.result_type = result_type

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