modm API documentation
modm::fiber::Scheduler Class Reference

#include <modm/processing/fiber/scheduler.hpp>

Public Types

enum  Options : uint8_t { AutoWatermark = 0b1 }
 Scheduling options. More...
 

Static Public Member Functions

static constexpr unsigned int hardware_concurrency ()
 
static void run (Options options=Options (0))
 Runs the currently active scheduler.
 

Static Protected Member Functions

static Scheduler & instance ()
 Returns the currently active scheduler.
 

Detailed Description

The scheduler executes fibers in a simple round-robin fashion. Fibers can be added to a scheduler using the modm::fiber::Task::start() function, also while the scheduler is running. Fibers returning from their function will automatically unschedule themselves.

Member Enumeration Documentation

Scheduling options.

Enum ValuesDocumentation
AutoWatermark 

On every fiber start, watermark the fiber stack.


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