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/Thread.h
- Revision:
- 31:015df9e602b6
- Parent:
- 8:88a1a9c26ae3
- Child:
- 76:85a52b7ef44b
--- a/rtos/Thread.h Tue May 27 08:30:16 2014 +0100 +++ b/rtos/Thread.h Tue Jun 03 11:30:14 2014 +0100 @@ -41,29 +41,29 @@ osPriority priority=osPriorityNormal, uint32_t stack_size=DEFAULT_STACK_SIZE, unsigned char *stack_pointer=NULL); - + /** Terminate execution of a thread and remove it from Active Threads @return status code that indicates the execution status of the function. */ osStatus terminate(); - + /** Set priority of an active thread @param priority new priority value for the thread function. @return status code that indicates the execution status of the function. */ osStatus set_priority(osPriority priority); - + /** Get priority of an active thread @return current priority value of the thread function. */ osPriority get_priority(); - + /** Set the specified Signal Flags of an active thread. @param signals specifies the signal flags of the thread that should be set. @return previous signal flags of the specified thread or 0x80000000 in case of incorrect parameters. */ int32_t signal_set(int32_t signals); - + /** State of the Thread */ enum State { Inactive, /**< Not created or terminated */ @@ -77,35 +77,35 @@ WaitingMailbox, /**< Waiting for a mailbox event to occur */ WaitingMutex, /**< Waiting for a mutex event to occur */ }; - + /** State of this Thread @return the State of this Thread */ State get_state(); - - /** Wait for one or more Signal Flags to become signaled for the current RUNNING thread. + + /** Wait for one or more Signal Flags to become signaled for the current RUNNING thread. @param signals wait until all specified signal flags set or 0 for any single signal flag. @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever). @return event flag information or error code. */ static osEvent signal_wait(int32_t signals, uint32_t millisec=osWaitForever); - + /** Wait for a specified time period in millisec: @param millisec time delay value - @return status code that indicates the execution status of the function. + @return status code that indicates the execution status of the function. */ static osStatus wait(uint32_t millisec); - + /** Pass control to next thread that is in state READY. @return status code that indicates the execution status of the function. */ static osStatus yield(); - + /** Get the thread id of the current running thread. @return thread ID for reference by other functions or NULL in case of error. */ static osThreadId gettid(); - + virtual ~Thread(); private: