Lee Shen / FTHR_USB_serial_qSPI
Embed: (wiki syntax)

« Back to documentation index

Queue< T, queue_sz > Class Template Reference

Queue< T, queue_sz > Class Template Reference
[Rtos]

The Queue class allow to control, send, receive, or wait for messages. More...

#include <Queue.h>

Inherits NonCopyable< Queue< T, queue_sz > >.

Public Member Functions

 Queue ()
 Create and initialize a message Queue.
osStatus put (T *data, uint32_t millisec=0, uint8_t prio=0)
 Put a message in a Queue.
osEvent get (uint32_t millisec=osWaitForever)
 Get a message or Wait for a message from a Queue.

Detailed Description

template<typename T, uint32_t queue_sz>
class rtos::Queue< T, queue_sz >

The Queue class allow to control, send, receive, or wait for messages.

A message can be a integer or pointer value to a certain type T that is send to a thread or interrupt service routine.

Template Parameters:
Tdata type of a single message element.
queue_szmaximum number of messages in queue.
Note:
Memory considerations: The queue control structures will be created on current thread's stack, both for the mbed OS and underlying RTOS objects (static or dynamic RTOS memory pools are not being used).

Definition at line 49 of file Queue.h.


Constructor & Destructor Documentation

Queue (  )

Create and initialize a message Queue.

Definition at line 52 of file Queue.h.