ganeti.locking.PipeCondition

class documentation

class PipeCondition(_BaseCondition):

Known subclasses: ganeti.locking._PipeConditionWithMode

Group-only non-polling condition with counters.

This condition class uses pipes and poll, internally, to be able to wait for notification with a timeout, without resorting to polling. It is almost compatible with Python's threading.Condition, but only supports notify_all and non-recursive locks. As an additional features it's able to report whether there are any waiting threads.

Method	`__init__`	Initializes this class.
Method	`__repr__`	Undocumented
Method	`get_waiting`	Returns a list of all waiting threads.
Method	`has_waiting`	Returns whether there are active waiters.
Method	`notify_all`	Notify all currently waiting threads.
Method	`wait`	Wait for a notification.
Class Variable	`__slots__`	Undocumented
Instance Variable	`_single_condition`	Undocumented
Instance Variable	`_waiters`	Undocumented

Inherited from _BaseCondition:

Instance Variable	`acquire`	Undocumented
Instance Variable	`release`	Undocumented
Method	`_base_acquire_restore`	Undocumented
Method	`_base_is_owned`	Check whether lock is owned by current thread.
Method	`_base_release_save`	Undocumented
Method	`_check_owned`	Raise an exception if the current thread doesn't own the lock.
Instance Variable	`_acquire_restore`	Undocumented
Instance Variable	`_is_owned`	Undocumented
Instance Variable	`_lock`	Undocumented
Instance Variable	`_release_save`	Undocumented

def __init__(self, lock): ¶

overrides ganeti.locking._BaseCondition.__init__

overridden in ganeti.locking._PipeConditionWithMode

Initializes this class.

def __repr__(self): ¶

Undocumented

def get_waiting(self): ¶

Returns a list of all waiting threads.

def has_waiting(self): ¶

Returns whether there are active waiters.

def notify_all(self): ¶

Notify all currently waiting threads.

def wait(self, timeout): ¶

Wait for a notification.

Parameters
timeout:float or None	Waiting timeout (can be None)

__slots__: list[str] = ¶

overrides ganeti.locking._BaseCondition.__slots__

overridden in ganeti.locking._PipeConditionWithMode

Undocumented

_single_condition = ¶

Undocumented

_waiters: set = ¶

Undocumented