pyuavcan_v0.node.Scheduler Class Reference

Inheritance diagram for pyuavcan_v0.node.Scheduler:

Public Member Functions
def	__init__ (self)
def	defer (self, timeout_seconds, callback)
def	has_pending_events (self)
def	periodic (self, period_seconds, callback)

Private Member Functions
def	_make_sched_handle (self, get_event)
def	_poll_scheduler_and_get_next_deadline (self)

Private Attributes
	_run_scheduler
	_scheduler

Detailed Description

This class implements a simple non-blocking event scheduler.
It supports one-shot and periodic events.

Definition at line 33 of file node.py.

Constructor & Destructor Documentation

__init__()

def pyuavcan_v0.node.Scheduler.__init__

(

self

)

Definition at line 38 of file node.py.

Member Function Documentation

_make_sched_handle()

def pyuavcan_v0.node.Scheduler._make_sched_handle (   self,   get_event  )

private

Definition at line 65 of file node.py.

_poll_scheduler_and_get_next_deadline()

def pyuavcan_v0.node.Scheduler._poll_scheduler_and_get_next_deadline (   self )

private

Definition at line 81 of file node.py.

defer()

def pyuavcan_v0.node.Scheduler.defer	(		self,
			timeout_seconds,
			callback
	)

This method allows to invoke the callback with specified arguments once the specified amount of time.
:returns: EventHandle object. Call .remove() on it to cancel the event.

Definition at line 84 of file node.py.

has_pending_events()

def pyuavcan_v0.node.Scheduler.has_pending_events

(

self

)

Returns true if there is at least one pending event in the queue.

Definition at line 109 of file node.py.

periodic()

def pyuavcan_v0.node.Scheduler.periodic	(		self,
			period_seconds,
			callback
	)

This method allows to invoke the callback periodically, with specified time intervals.
Note that the scheduler features zero phase drift.
:returns: EventHandle object. Call .remove() on it to cancel the event.

Definition at line 92 of file node.py.

Member Data Documentation

_run_scheduler

pyuavcan_v0.node.Scheduler._run_scheduler

private

Definition at line 44 of file node.py.

_scheduler

pyuavcan_v0.node.Scheduler._scheduler

private

Definition at line 41 of file node.py.

---

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

• node.py