Official mbed Real Time Operating System based on the RTX implementation of the CMSIS-RTOS API open standard. Patched to work with NUCLEO L152 board
Fork of mbed-rtos by
Mail< T, queue_sz > Class Template Reference
The Mail class allow to control, send, receive, or wait for mail. More...
#include <Mail.h>
Public Member Functions | |
Mail () | |
Create and Initialise Mail queue. | |
T * | alloc (uint32_t millisec=0) |
Allocate a memory block of type T. | |
T * | calloc (uint32_t millisec=0) |
Allocate a memory block of type T and set memory block to zero. | |
osStatus | put (T *mptr) |
Put a mail in the queue. | |
osEvent | get (uint32_t millisec=osWaitForever) |
Get a mail from a queue. | |
osStatus | free (T *mptr) |
Free a memory block from a mail. |
Detailed Description
template<typename T, uint32_t queue_sz>
class rtos::Mail< T, queue_sz >
The Mail class allow to control, send, receive, or wait for mail.
A mail is a memory block that is send to a thread or interrupt service routine.
- Template Parameters:
-
T data type of a single message element. queue_sz maximum number of messages in queue.
Definition at line 38 of file Mail.h.
Constructor & Destructor Documentation
Member Function Documentation
T* alloc | ( | uint32_t | millisec = 0 ) |
T* calloc | ( | uint32_t | millisec = 0 ) |
osStatus free | ( | T * | mptr ) |
osEvent get | ( | uint32_t | millisec = osWaitForever ) |
osStatus put | ( | T * | mptr ) |
Put a mail in the queue.
- Parameters:
-
mptr memory block previously allocated with Mail::alloc or Mail::calloc.
- Returns:
- status code that indicates the execution status of the function.
Generated on Thu Jul 14 2022 02:41:33 by 1.7.2