ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

equeue: Added note about using global event queues in irq

pull/6118/head
Christopher Haster 2018-02-16 10:33:32 -06:00 committed by GitHub
parent 4145cc0cf0
commit 6e4e62b8a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
events/mbed_shared_queues.h
View File

@ -45,6 +45,11 @@ namespace mbed {
* for the event loop to work without an RTOS, or an RTOS system can can save * for the event loop to work without an RTOS, or an RTOS system can can save
* memory by reusing the main stack. * memory by reusing the main stack.
* *
* @note
* mbed_event_queue is not itself IRQ safe. To use the mbed_event_queue in
* interrupt context, you must first call `mbed_event_queue()` in threaded
* context and store the pointer for later use.
*
* @return pointer to event queue * @return pointer to event queue
*/ */
events::EventQueue *mbed_event_queue(); events::EventQueue *mbed_event_queue();
@ -67,6 +72,12 @@ events::EventQueue *mbed_event_queue();
* or less, but could occasionally be significantly higher if many events are * or less, but could occasionally be significantly higher if many events are
* queued. * queued.
* *
* @note
* mbed_highprio_event_queue is not itself IRQ safe. To use the
* mbed_highprio_event_queue in interrupt context, you must first call
* `mbed_event_queue()` in threaded context and store the pointer for
* later use.
*
* @return pointer to high-priority event queue * @return pointer to high-priority event queue
*/ */