Inheritance diagram for esiaccel.types.MessageFuture:

Collaboration diagram for esiaccel.types.MessageFuture:

Public Member Functions
def	__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

	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 383 of file types.py.

Constructor & Destructor Documentation

◆ init()

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

Definition at line 388 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 407 of file types.py.

◆ done()

bool esiaccel.types.MessageFuture.done ( self )

Definition at line 395 of file types.py.

References esiaccel.types.MessageFuture.cpp_future.

◆ result()

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

Definition at line 398 of file types.py.

References esiaccel.types.MessageFuture.cpp_future, circt::calyx::direction.get(), esiaccel.types.MessageFuture.result_type, and esiaccel.types.FunctionPort.result_type.

◆ running()

bool esiaccel.types.MessageFuture.running ( self )

Definition at line 392 of file types.py.

Member Data Documentation

◆ cpp_future

esiaccel.types.MessageFuture.cpp_future

Definition at line 390 of file types.py.

Referenced by esiaccel.types.MessageFuture.done(), and esiaccel.types.MessageFuture.result().

◆ result_type

esiaccel.types.MessageFuture.result_type

Definition at line 389 of file types.py.

Referenced by esiaccel.types.FunctionPort.call(), and esiaccel.types.MessageFuture.result().

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

/home/runner/work/circt-www/circt-www/circt_src/lib/Dialect/ESI/runtime/python/esiaccel/types.py

Public Member Functions

Public Attributes