Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of mbed-rtos by
Diff: rtos/Semaphore.h
- Revision:
- 31:015df9e602b6
- Parent:
- 8:88a1a9c26ae3
- Child:
- 119:19af2d39a542
diff -r 3761f69dbbb2 -r 015df9e602b6 rtos/Semaphore.h --- a/rtos/Semaphore.h Tue May 27 08:30:16 2014 +0100 +++ b/rtos/Semaphore.h Tue Jun 03 11:30:14 2014 +0100 @@ -30,22 +30,22 @@ /** The Semaphore class is used to manage and protect access to a set of shared resources. */ class Semaphore { public: - /** Create and Initialize a Semaphore object used for managing resources. + /** Create and Initialize a Semaphore object used for managing resources. @param number of available resources; maximum index value is (count-1). */ Semaphore(int32_t count); - - /** Wait until a Semaphore resource becomes available. + + /** Wait until a Semaphore resource becomes available. @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever). @return number of available tokens, or -1 in case of incorrect parameters */ int32_t wait(uint32_t millisec=osWaitForever); - + /** Release a Semaphore resource that was obtain with Semaphore::wait. - @return status code that indicates the execution status of the function. + @return status code that indicates the execution status of the function. */ osStatus release(void); - + ~Semaphore(); private: