dragon.mpbridge.synchronize.DragonEvent

class DragonEvent

Bases: Event

An event co-located on the same node by default as the creating process

__init__(*args, ctx, **kwargs)

Initialize an event object :param m_uid: memory pool to create the channel in, defaults to _DEF_MUID :type m_uid: int, optional

Methods

__init__(*args, ctx, **kwargs)	Initialize an event object :param m_uid: memory pool to create the channel in, defaults to _DEF_MUID :type m_uid: int, optional
clear()	Clears the event once the message from the channel has been received.
destroy()	Destroys the underlying Dragon resources so the space can be re-used.
is_set()	Returns if the event has been set.
set()	Set the event.
wait([timeout])	Wait for the timeout to elapse and poll for the message in the channel.

__init__(*args, ctx, **kwargs)

Initialize an event object :param m_uid: memory pool to create the channel in, defaults to _DEF_MUID :type m_uid: int, optional

clear() → None

Clears the event once the message from the channel has been received.

Clear receives a messsage from the channel

Returns:

None

Return type:

NoneType

destroy()

Destroys the underlying Dragon resources so the space can be re-used.

Destroys underlying Dragon resource. Only do this when you know all references to the object have been deleted.

Returns:

None

Return type:

NoneType

is_set() → bool

Returns if the event has been set. Polls the channel for the message.

Returns:

Results from a channel poll with a timeout set to 0.

Return type:

bool

set() → None

Set the event.

Set writes a messsage into the channel.

Returns:

None

Return type:

NoneType

wait(timeout: float = None) → bool

Wait for the timeout to elapse and poll for the message in the channel.

Parameters:

timeout (float , optional) – how long to block in seconds, defaults to None

Returns:

if the event has been set

Return type:

bool