Donatien Garnier / rtos_net

RTOS configured for use with Networking libraries

Dependents:   EthernetHTTPClientTest

Queue.h@0:07f30e7c9897, 2012-05-24 (annotated)

Committer:
donatien
Date:
Thu May 24 08:56:51 2012 +0000
Revision:
0:07f30e7c9897
[mbed] converted /VodafoneK3770Lib/rtos

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:07f30e7c9897 1 /* Copyright (c) 2012 mbed.org */
donatien 0:07f30e7c9897 2 #ifndef QUEUE_H
donatien 0:07f30e7c9897 3 #define QUEUE_H
donatien 0:07f30e7c9897 4
donatien 0:07f30e7c9897 5 #include <stdint.h>
donatien 0:07f30e7c9897 6 #include <string.h>
donatien 0:07f30e7c9897 7
donatien 0:07f30e7c9897 8 #include "cmsis_os.h"
donatien 0:07f30e7c9897 9 #include "error.h"
donatien 0:07f30e7c9897 10
donatien 0:07f30e7c9897 11 namespace rtos {
donatien 0:07f30e7c9897 12
donatien 0:07f30e7c9897 13 /*! The Queue class allow to control, send, receive, or wait for messages.
donatien 0:07f30e7c9897 14 A message can be a integer or pointer value to a certain type T that is send
donatien 0:07f30e7c9897 15 to a thread or interrupt service routine.
donatien 0:07f30e7c9897 16 \tparam T data type of a single message element.
donatien 0:07f30e7c9897 17 \tparam queue_sz maximum number of messages in queue.
donatien 0:07f30e7c9897 18 */
donatien 0:07f30e7c9897 19 template<typename T, uint32_t queue_sz>
donatien 0:07f30e7c9897 20 class Queue {
donatien 0:07f30e7c9897 21 public:
donatien 0:07f30e7c9897 22 /*! Create and initialise a message Queue. */
donatien 0:07f30e7c9897 23 Queue() {
donatien 0:07f30e7c9897 24 #ifdef CMSIS_OS_RTX
donatien 0:07f30e7c9897 25 memset(_queue_q, 0, sizeof(_queue_q));
donatien 0:07f30e7c9897 26 _queue_def.pool = _queue_q;
donatien 0:07f30e7c9897 27 _queue_def.queue_sz = queue_sz;
donatien 0:07f30e7c9897 28 #endif
donatien 0:07f30e7c9897 29 _queue_id = osMessageCreate(&_queue_def, NULL);
donatien 0:07f30e7c9897 30 if (_queue_id == NULL) {
donatien 0:07f30e7c9897 31 error("Error initialising the queue object\n");
donatien 0:07f30e7c9897 32 }
donatien 0:07f30e7c9897 33 }
donatien 0:07f30e7c9897 34
donatien 0:07f30e7c9897 35 /*! Put a message in a Queue.
donatien 0:07f30e7c9897 36 \param data message pointer.
donatien 0:07f30e7c9897 37 \param millisec timeout value or 0 in case of no time-out. (default: 0)
donatien 0:07f30e7c9897 38 \return status code that indicates the execution status of the function.
donatien 0:07f30e7c9897 39 */
donatien 0:07f30e7c9897 40 osStatus put(T* data, uint32_t millisec=0) {
donatien 0:07f30e7c9897 41 return osMessagePut(_queue_id, (uint32_t)data, millisec);
donatien 0:07f30e7c9897 42 }
donatien 0:07f30e7c9897 43
donatien 0:07f30e7c9897 44 /*! Get a message or Wait for a message from a Queue.
donatien 0:07f30e7c9897 45 \param millisec timeout value or 0 in case of no time-out. (default: osWaitForever).
donatien 0:07f30e7c9897 46 \return event information that includes the message and the status code.
donatien 0:07f30e7c9897 47 */
donatien 0:07f30e7c9897 48 osEvent get(uint32_t millisec=osWaitForever) {
donatien 0:07f30e7c9897 49 return osMessageGet(_queue_id, millisec);
donatien 0:07f30e7c9897 50 }
donatien 0:07f30e7c9897 51
donatien 0:07f30e7c9897 52 private:
donatien 0:07f30e7c9897 53 osMessageQId _queue_id;
donatien 0:07f30e7c9897 54 osMessageQDef_t _queue_def;
donatien 0:07f30e7c9897 55 #ifdef CMSIS_OS_RTX
donatien 0:07f30e7c9897 56 uint32_t _queue_q[4+(queue_sz)];
donatien 0:07f30e7c9897 57 #endif
donatien 0:07f30e7c9897 58 };
donatien 0:07f30e7c9897 59
donatien 0:07f30e7c9897 60 }
donatien 0:07f30e7c9897 61 #endif