AceRoutine  1.0
A low-memory, fast-switching, cooperative multitasking library using stackless coroutines on Arduino platforms.
CoroutineScheduler.h
1 /*
2 MIT License
3 
4 Copyright (c) 2018 Brian T. Park
5 
6 Permission is hereby granted, free of charge, to any person obtaining a copy
7 of this software and associated documentation files (the "Software"), to deal
8 in the Software without restriction, including without limitation the rights
9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 copies of the Software, and to permit persons to whom the Software is
11 furnished to do so, subject to the following conditions:
12 
13 The above copyright notice and this permission notice shall be included in all
14 copies or substantial portions of the Software.
15 
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 SOFTWARE.
23 */
24 
25 #ifndef ACE_ROUTINE_COROUTINE_SCHEDULER_H
26 #define ACE_ROUTINE_COROUTINE_SCHEDULER_H
27 
28 #include <Print.h>
29 #include "Coroutine.h"
30 
31 namespace ace_routine {
32 
38  public:
40  static void setup() { getScheduler()->setupScheduler(); }
41 
48  static void loop() { getScheduler()->runCoroutine(); }
49 
56  static void list(Print& printer) {
57  getScheduler()->listCoroutines(printer);
58  }
59 
60  private:
61  // Disable copy-constructor and assignment operator
62  CoroutineScheduler(const CoroutineScheduler&) = delete;
63  CoroutineScheduler& operator=(const CoroutineScheduler&) = delete;
64 
66  static CoroutineScheduler* getScheduler();
67 
70 
72  void setupScheduler();
73 
75  void runCoroutine();
76 
78  void listCoroutines(Print& printer);
79 
80  // The current coroutine is represented by a pointer to a pointer. This
81  // allows the root node to be treated the same as all the other nodes, and
82  // simplifies the code that traverses the singly-linked list.
83  Coroutine** mCurrent = nullptr;
84 };
85 
86 }
87 
88 #endif
static void list(Print &printer)
Print out the known coroutines to the printer (usually Serial).
static void loop()
Run the current coroutine using the current scheduler.
Class that manages instances of the Coroutine class, and executes them in a round-robin fashion...
static void setup()
Set up the scheduler.
All coroutines are instances of the Coroutine base class.
Base class of all coroutines.
Definition: Coroutine.h:255