Official mbed Real Time Operating System based on the RTX implementation of the CMSIS-RTOS API open standard.
Fork of mbed-rtos by
rtos/Queue.h
- Committer:
- emilmont
- Date:
- 2012-11-23
- Revision:
- 6:350b53afb889
- Child:
- 8:88a1a9c26ae3
File content as of revision 6:350b53afb889:
/* Copyright (c) 2012 mbed.org */ #ifndef QUEUE_H #define QUEUE_H #include <stdint.h> #include <string.h> #include "cmsis_os.h" #include "error.h" namespace rtos { /*! 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. \tparam T data type of a single message element. \tparam queue_sz maximum number of messages in queue. */ template<typename T, uint32_t queue_sz> class Queue { public: /*! Create and initialise a message Queue. */ Queue() { #ifdef CMSIS_OS_RTX memset(_queue_q, 0, sizeof(_queue_q)); _queue_def.pool = _queue_q; _queue_def.queue_sz = queue_sz; #endif _queue_id = osMessageCreate(&_queue_def, NULL); if (_queue_id == NULL) { error("Error initialising the queue object\n"); } } /*! Put a message in a Queue. \param data message pointer. \param millisec timeout value or 0 in case of no time-out. (default: 0) \return status code that indicates the execution status of the function. */ osStatus put(T* data, uint32_t millisec=0) { return osMessagePut(_queue_id, (uint32_t)data, millisec); } /*! Get a message or Wait for a message from a Queue. \param millisec timeout value or 0 in case of no time-out. (default: osWaitForever). \return event information that includes the message and the status code. */ osEvent get(uint32_t millisec=osWaitForever) { return osMessageGet(_queue_id, millisec); } private: osMessageQId _queue_id; osMessageQDef_t _queue_def; #ifdef CMSIS_OS_RTX uint32_t _queue_q[4+(queue_sz)]; #endif }; } #endif