Skip to content

Commit cd2b4a3

Browse files
authored
Comment out various task scheduling options
1 parent 1647514 commit cd2b4a3

1 file changed

Lines changed: 0 additions & 21 deletions

File tree

src/TaskSchedulerDeclarations.h

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -40,156 +40,135 @@
4040
* @details Enables tracking when the current execution took place relative to when it was scheduled.
4141
* Provides getStartDelay() and getOverrun() methods for performance monitoring.
4242
*/
43-
// #define _TASK_TIMECRITICAL
4443

4544
/**
4645
* @def _TASK_SLEEP_ON_IDLE_RUN
4746
* @brief Enable 1 ms SLEEP_IDLE powerdowns between runs if no callback methods were invoked during the pass
4847
* @details When enabled, the scheduler will place the processor into IDLE sleep mode for approximately 1 ms
4948
* after what is determined to be an "idle" pass. AVR boards only.
5049
*/
51-
// #define _TASK_SLEEP_ON_IDLE_RUN
5250

5351
/**
5452
* @def _TASK_STATUS_REQUEST
5553
* @brief Compile with support for StatusRequest functionality
5654
* @details Enables triggering tasks on status change events in addition to time-based scheduling.
5755
* Allows tasks to wait on an event and signal event completion to each other.
5856
*/
59-
// #define _TASK_STATUS_REQUEST
6057

6158
/**
6259
* @def _TASK_WDT_IDS
6360
* @brief Compile with support for watchdog timer control points and task IDs
6461
* @details Each task can be assigned an ID and Control Points can be defined within tasks
6562
* for watchdog timer integration and error handling.
6663
*/
67-
// #define _TASK_WDT_IDS
6864

6965
/**
7066
* @def _TASK_LTS_POINTER
7167
* @brief Compile with support for local task storage pointer
7268
* @details LTS is a generic (void*) pointer that can reference a variable or structure
7369
* specific to a particular task, allowing the same callback code for multiple tasks.
7470
*/
75-
// #define _TASK_LTS_POINTER
7671

7772
/**
7873
* @def _TASK_PRIORITY
7974
* @brief Support for layered scheduling priority
8075
* @details Enables task prioritization by creating several schedulers and organizing them in priority layers.
8176
* Higher priority tasks are evaluated more frequently.
8277
*/
83-
// #define _TASK_PRIORITY
8478

8579
/**
8680
* @def _TASK_MICRO_RES
8781
* @brief Support for microsecond resolution
8882
* @details Enables microsecond scheduling resolution instead of default millisecond resolution.
8983
* All time-relevant parameters will be treated as microseconds.
9084
*/
91-
// #define _TASK_MICRO_RES
9285

9386
/**
9487
* @def _TASK_STD_FUNCTION
9588
* @brief Support for std::function (ESP8266/ESP32 ONLY)
9689
* @details Enables support for standard functions instead of function pointers for callbacks.
9790
*/
98-
// #define _TASK_STD_FUNCTION
9991

10092
/**
10193
* @def _TASK_DEBUG
10294
* @brief Make all methods and variables public for debug purposes
10395
* @details Should not be used in production. Exposes all private and protected members as public.
10496
*/
105-
// #define _TASK_DEBUG
10697

10798
/**
10899
* @def _TASK_INLINE
109100
* @brief Make all methods "inline"
110101
* @details Needed to support some multi-tab, multi-file implementations. Lets compiler optimize.
111102
*/
112-
// #define _TASK_INLINE
113103

114104
/**
115105
* @def _TASK_TIMEOUT
116106
* @brief Support for overall task timeout
117107
* @details Any task can be set to time out after a certain period, and timeout can be reset.
118108
* Can be used as an individual Task's watchdog timer.
119109
*/
120-
// #define _TASK_TIMEOUT
121110

122111
/**
123112
* @def _TASK_OO_CALLBACKS
124113
* @brief Support for callbacks via inheritance
125114
* @details Useful for implementing Tasks as classes derived from the Task class.
126115
* Enables dynamic binding for object-oriented callback approach.
127116
*/
128-
// #define _TASK_OO_CALLBACKS
129117

130118
/**
131119
* @def _TASK_EXPOSE_CHAIN
132120
* @brief Methods to access tasks in the task chain
133121
* @details Provides access to scheduling chain methods and tasks on the chain.
134122
*/
135-
// #define _TASK_EXPOSE_CHAIN
136123

137124
/**
138125
* @def _TASK_SCHEDULING_OPTIONS
139126
* @brief Support for multiple scheduling options
140127
* @details Enables different task scheduling options like TASK_SCHEDULE, TASK_SCHEDULE_NC, and TASK_INTERVAL.
141128
*/
142-
// #define _TASK_SCHEDULING_OPTIONS
143129

144130
/**
145131
* @def _TASK_SELF_DESTRUCT
146132
* @brief Enable tasks to "self-destruct" after disable
147133
* @details Tasks can be set to automatically delete themselves when disabled.
148134
*/
149-
// #define _TASK_SELF_DESTRUCT
150135

151136
/**
152137
* @def _TASK_TICKLESS
153138
* @brief Enable support for tickless sleep on FreeRTOS
154139
* @details Enables support for tickless sleep mode on FreeRTOS systems.
155140
*/
156-
// #define _TASK_TICKLESS
157141

158142
/**
159143
* @def _TASK_DO_NOT_YIELD
160144
* @brief Disable yield() method in execute() for ESP chips
161145
* @details Disables automatic yielding in the execute loop for ESP-based systems.
162146
*/
163-
// #define _TASK_DO_NOT_YIELD
164147

165148
/**
166149
* @def _TASK_ISR_SUPPORT
167150
* @brief For ESP chips - place control methods in IRAM
168151
* @details Places critical control methods in IRAM for ESP8266/ESP32 interrupt support.
169152
*/
170-
// #define _TASK_ISR_SUPPORT
171153

172154
/**
173155
* @def _TASK_NON_ARDUINO
174156
* @brief For non-Arduino use
175157
* @details Enables compilation for non-Arduino environments.
176158
*/
177-
// #define _TASK_NON_ARDUINO
178159

179160
/**
180161
* @def _TASK_HEADER_AND_CPP
181162
* @brief Compile CPP file (non-Arduino IDE platforms)
182163
* @details For non-Arduino IDE platforms that require explicit CPP compilation.
183164
*/
184-
// #define _TASK_HEADER_AND_CPP
185165

186166
/**
187167
* @def _TASK_THREAD_SAFE
188168
* @brief Enable additional checking for thread safety
189169
* @details Uses an internal mutex to protect task scheduling methods from preemption.
190170
* Recommended for ESP32 and other MCUs running under preemptive schedulers like FreeRTOS.
191171
*/
192-
// #define _TASK_THREAD_SAFE
193172

194173
/** @} */ // End of CompileTimeOptions group
195174

0 commit comments

Comments
 (0)