Merge pull request #6118 from ARMmbed/g-note-global-equeue-irq

equeue: Add note about using global event queues in irq
pull/6134/merge
Cruz Monrreal 2018-02-16 19:48:36 -06:00 committed by GitHub
commit 7411b31eb4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions

View File

@ -45,6 +45,11 @@ namespace mbed {
* for the event loop to work without an RTOS, or an RTOS system can can save
* 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
*/
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
* 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
*/