Skip to content

These module docs are in beta and may be incomplete.

modm:processing: Processing

Constructs to influence program flow execution, timing, synchronization and delegation.

Content

// Class
class modm::GenericPeriodicTimer< class Clock, typename TimestampType=modm::Timestamp >;
class modm::GenericTimeout< class Clock, class TimestampType=modm::Timestamp >;
class modm::GenericTimestamp< typename T >;
class modm::NestedResumable< uint8_t Levels=1 >;
class modm::Resumable< uint8_t Functions=1 >;
class modm::Scheduler::Task;
class modm::Scheduler;
class modm::Task;
class modm::pt::Protothread;
class modm::pt::Semaphore;
class modm::rtos::BinarySemaphore;
class modm::rtos::Mutex;
class modm::rtos::MutexGuard;
class modm::rtos::Queue< typename T  >;
class modm::rtos::QueueBase;
class modm::rtos::Scheduler;
class modm::rtos::Semaphore;
class modm::rtos::SemaphoreBase;
class modm::rtos::Thread::Lock;
class modm::rtos::Thread;

// Struct
struct modm::ResumableResult< typename T >;
struct modm::Scheduler::TaskListItem;

// Function
IOStream& modm::operator<<(IOStream &os, const GenericTimestamp< T > &t);

// Enum
enum class PeriodicTimerState;
enum class TimeoutState;

// Typedef
using modm::PeriodicTimer = typedef GenericPeriodicTimer< ::modm::Clock, Timestamp>;
using modm::ShortPeriodicTimer = typedef GenericPeriodicTimer< ::modm::Clock, ShortTimestamp>;
using modm::ShortTimeout = typedef GenericTimeout< ::modm::Clock, ShortTimestamp>;
using modm::ShortTimestamp = typedef GenericTimestamp<uint16_t>;
using modm::Timeout = typedef GenericTimeout< ::modm::Clock, Timestamp>;
using modm::Timestamp = typedef GenericTimestamp<uint32_t>;

// Define
#define MILLISECONDS
#define MODM_RESUMABLE_MODULE_NAME
#define PT_BEGIN
#define PT_CALL(resumable)
#define PT_END
#define PT_EXIT
#define PT_RESTART
#define PT_SPAWN(child)
#define PT_WAIT_THREAD(child)
#define PT_WAIT_UNTIL(condition)
#define PT_WAIT_WHILE(condition)
#define PT_YIELD
#define RF_BEGIN
#define RF_BEGIN(index)
#define RF_CALL(resumable)
#define RF_CALL_BLOCKING(resumable)
#define RF_END
#define RF_END_RETURN(result)
#define RF_END_RETURN_CALL(resumable)
#define RF_RETURN
#define RF_RETURN(result)
#define RF_RETURN_CALL(resumable)
#define RF_WAIT_THREAD(child)
#define RF_WAIT_UNTIL(condition)
#define RF_WAIT_WHILE(condition)
#define RF_YIELD
#define TIME_LOOP(frequency)

Dependencies

modm:processing modm_processing modm: processing modm_processing_protothread modm: processing: protothread modm_processing_protothread->modm_processing modm_processing_resumable modm: processing: resumable modm_processing_resumable->modm_processing modm_processing_rtos modm: processing: rtos modm_processing_rtos->modm_processing modm_processing_scheduler modm: processing: scheduler modm_processing_scheduler->modm_processing modm_processing_timer modm: processing: timer modm_processing_timer->modm_processing