Skip to main content

Heart

Timer sending heartbeats at regular intervals.

Attributes

AttributeTypeDescription
timerkombu.asynchronous.timer.TimerTimer to use.
eventercelery.events.EventDispatcherEvent dispatcher to use.
intervalfloat = 2.0Time in seconds between sending heartbeats.
trefkombu.asynchronous.timer.Entry = NoneReference to the scheduled heartbeat event used to cancel the timer when stopping.
_send_sent_signalcallableInternal signal sender used to dispatch the heartbeat_sent signal only if active receivers exist.

Constructor

Signature

def Heart(
timer: kombu.asynchronous.timer.Timer,
eventer: celery.events.EventDispatcher,
interval: float = None
)

Parameters

NameTypeDescription
timerkombu.asynchronous.timer.TimerTimer to use for scheduling heartbeats.
eventercelery.events.EventDispatcherEvent dispatcher to use for sending events.
intervalfloat = NoneTime in seconds between sending heartbeats. Defaults to 2.0 seconds.

Signature

def Heart(
timer: kombu.asynchronous.timer.Timer,
eventer: celery.events.EventDispatcher,
interval: float = None
) - > null

Parameters

NameTypeDescription
timerkombu.asynchronous.timer.TimerThe asynchronous timer used to schedule recurring heartbeat events
eventercelery.events.EventDispatcherThe event dispatcher responsible for transmitting heartbeat messages to the broker
intervalfloat = NoneThe time in seconds between heartbeat transmissions; defaults to 2.0 seconds if not provided

Methods


start()

@classmethod
def start() - > null

Initiates the heartbeat cycle by sending an online status event and scheduling recurring heartbeat tasks.

Returns

TypeDescription
nullNone

stop()

@classmethod
def stop() - > null

Cancels the scheduled heartbeat timer and sends an offline status event to signal the worker is shutting down.

Returns

TypeDescription
nullNone