class ClusterShell.Engine.Engine.EngineTimer(fire_delay, interval, autoclose, handler)

Concrete class EngineTimer

An EngineTimer object represents a timer bound to an engine that fires at a preset time in the future. Timers can fire either only once or repeatedly at fixed time intervals. Repeating timers can also have their next firing time manually adjusted.

A timer is not a real-time mechanism; it fires when the task's underlying engine to which the timer has been added is running and able to check if the timer's firing time has passed.


Implement delattr(self, name).


Default dir() implementation.


Return self==value.


Default object formatter.


Return self>=value.


Return getattr(self, name).


Helper for pickle.


Return self>value.


Return hash(self).

__init__(fire_delay, interval, autoclose, handler)

Create a base timer.


This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.


Return self<=value.


Return self<value.


Return self!=value.


Create and return a new object. See help(type) for accurate signature.


Helper for pickle.


Helper for pickle.


Return repr(self).


Implement setattr(self, name, value).


Size of object in memory, in bytes.


Return str(self).


Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).


list of weak references to the object (if defined)


Invalidates a timer object, stopping it from ever firing again.


Returns a boolean value that indicates whether an EngineTimer object is valid and able to fire.

set_nextfire(fire_delay, interval=-1)

Set the next firing delay in seconds for an EngineTimer object.

The optional parameter interval sets the firing interval of the timer. If not specified, the timer fires once and then is automatically invalidated.

Time values are expressed in second using floating point values. Precision is implementation (and system) dependent.

It is safe to call this method from the task owning this timer object, in any event handlers, anywhere.

However, resetting a timer's next firing time may be a relatively expensive operation. It is more efficient to let timers autorepeat or to use this method from the timer's own event handler callback (ie. from its ev_timer).