You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/api/rtos/ConditionVariable.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
<spanclass="images"><span>ConditionVariable class hierarchy</span></span>
4
4
5
-
The ConditionVariable class provides a mechanism to safely wait for or signal state changes. A common scenario when writing multithreaded code is to protect shared resources with a mutex and then release that mutex to wait for a change of that data. If you do not do this carefully, this can lead to a race condition in the code. A condition variable provides a safe solution to this problem by handling the wait for a state change, along with releasing and acquiring the mutex automatically during this waiting period.
5
+
The ConditionVariable class provides a mechanism to safely wait for or signal state changes. A common scenario when writing multithreaded code is to protect shared resources with a mutex and then release that mutex to wait for a change of that data. If you do not do this carefully, this can lead to a race condition in the code. A condition variable provides a safe solution to this problem by handling the wait for a state change, along with releasing and acquiring the mutex automatically during this waiting period. Note that you cannot make wait or notify calls on a condition variable from ISR context. Unlike EventFlags, ConditionVariable does not let you wait on multiple events at the same time.
Copy file name to clipboardExpand all lines: docs/reference/api/rtos/rtos.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
<h2id="rtos-api">RTOS overview</h2>
2
2
3
-
The Arm Mbed RTOS APIs provides C++ APIs to manage RTOS objects like thread, synchronization objects and timer. It also provides interfaces for attaching application
4
-
specific idle hook function and to read the tick count from OS. The Arm Mbed RTOS layer also handles RTOS errors and report them into Mbed-OS error handling system.
3
+
Mbed-OS RTOS provide C++ APIs to manage objects like thread, synchronization objects and timer. It also provides interfaces for attaching application
4
+
specific idle hook function, read the OS tick count and implements functionality to report RTOS errors.
5
5
6
6
The code of the Mbed RTOS can be found in the [`mbed-os`](https://github.com/ARMmbed/mbed-os) repository, in the [RTOS subdirectory](https://github.com/ARMmbed/mbed-os/tree/master/rtos). See [the Doxygen](https://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/group__rtos.html) for more information.
7
7
@@ -25,9 +25,9 @@ The RTOS APIs handle creation and destruction of threads in Arm Mbed OS 5, as we
25
25
-[MemoryPool](/docs/development/reference/memorypool.html): This class that you can use to define and manage fixed-size memory pools
26
26
-[Mail](/docs/development/reference/mail.html): The API that provides a queue combined with a memory pool for allocating messages.
27
27
-[RtosTimer](/docs/development/reference/rtostimer.html): A deprecated class used to control timer functions in the system.
28
-
-[EventFlags](/docs/development/reference/eventflags.html): An event channel that provides a generic way of notifying other threads about conditions or events.
28
+
-[EventFlags](/docs/development/reference/eventflags.html): An event channel that provides a generic way of notifying other threads about conditions or events. Some EventFlags functions are callable from ISR context and each EventFlags objects can support up to 31 flags.
29
29
-[Event](/docs/development/reference/event.html): The queue to store events, extract them and excute them later.
30
-
-[ConditionVariable](/docs/development/reference/conditionvariable.html): The ConditionVariable class provides a mechanism to safely wait for or signal state changes.
30
+
-[ConditionVariable](/docs/development/reference/conditionvariable.html): The ConditionVariable class provides a mechanism to safely wait for or signal a single state change. ConditionVariable functions are not callable from ISR context.
31
31
-[Kernel](/docs/development/reference/kernel.html): Kernel namespace implements functions to control or read RTOS information like tick count.
32
32
33
33
##### Default timeouts
@@ -58,5 +58,5 @@ Each `Thread` can wait for signals and be notified of events:
The Arm Mbed RTOS layer handles RTOS errors and report them using Mbed-OS error handling system. See the list of error codes in[Error Handling](/docs/development/reference/error-handling.html)
61
+
Mbed OS error handling system assigns specific error codes for RTOS related erros. See[Error Handling](/docs/development/reference/error-handling.html)
0 commit comments