Timothy Beight / Mbed 2 deprecated 6_songs-from-the-cloud

This is a fork due to permission issues

Dependencies:   mbed Socket lwip-eth lwip-sys lwip

Fork of 6_songs-from-the-cloud by MakingMusicWorkshop

mbed-client/mbed-rtos/rtos/Queue.h@1:0ddbe2d3319c, 2016-05-19 (annotated)

Committer:
timbeight
Date:
Thu May 19 16:02:10 2016 +0000
Revision:
1:0ddbe2d3319c
Parent:
0:f7c60d3e7b8a 
This is my first commit while in the class.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
maclobdell 0:f7c60d3e7b8a 1 /* mbed Microcontroller Library
maclobdell 0:f7c60d3e7b8a 2 * Copyright (c) 2006-2012 ARM Limited
maclobdell 0:f7c60d3e7b8a 3 *
maclobdell 0:f7c60d3e7b8a 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
maclobdell 0:f7c60d3e7b8a 5 * of this software and associated documentation files (the "Software"), to deal
maclobdell 0:f7c60d3e7b8a 6 * in the Software without restriction, including without limitation the rights
maclobdell 0:f7c60d3e7b8a 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
maclobdell 0:f7c60d3e7b8a 8 * copies of the Software, and to permit persons to whom the Software is
maclobdell 0:f7c60d3e7b8a 9 * furnished to do so, subject to the following conditions:
maclobdell 0:f7c60d3e7b8a 10 *
maclobdell 0:f7c60d3e7b8a 11 * The above copyright notice and this permission notice shall be included in
maclobdell 0:f7c60d3e7b8a 12 * all copies or substantial portions of the Software.
maclobdell 0:f7c60d3e7b8a 13 *
maclobdell 0:f7c60d3e7b8a 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
maclobdell 0:f7c60d3e7b8a 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
maclobdell 0:f7c60d3e7b8a 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
maclobdell 0:f7c60d3e7b8a 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
maclobdell 0:f7c60d3e7b8a 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
maclobdell 0:f7c60d3e7b8a 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
maclobdell 0:f7c60d3e7b8a 20 * SOFTWARE.
maclobdell 0:f7c60d3e7b8a 21 */
maclobdell 0:f7c60d3e7b8a 22 #ifndef QUEUE_H
maclobdell 0:f7c60d3e7b8a 23 #define QUEUE_H
maclobdell 0:f7c60d3e7b8a 24
maclobdell 0:f7c60d3e7b8a 25 #include <stdint.h>
maclobdell 0:f7c60d3e7b8a 26 #include <string.h>
maclobdell 0:f7c60d3e7b8a 27
maclobdell 0:f7c60d3e7b8a 28 #include "cmsis_os.h"
maclobdell 0:f7c60d3e7b8a 29 #include "mbed_error.h"
maclobdell 0:f7c60d3e7b8a 30
maclobdell 0:f7c60d3e7b8a 31 namespace rtos {
maclobdell 0:f7c60d3e7b8a 32
maclobdell 0:f7c60d3e7b8a 33 /** The Queue class allow to control, send, receive, or wait for messages.
maclobdell 0:f7c60d3e7b8a 34 A message can be a integer or pointer value to a certain type T that is send
maclobdell 0:f7c60d3e7b8a 35 to a thread or interrupt service routine.
maclobdell 0:f7c60d3e7b8a 36 @tparam T data type of a single message element.
maclobdell 0:f7c60d3e7b8a 37 @tparam queue_sz maximum number of messages in queue.
maclobdell 0:f7c60d3e7b8a 38 */
maclobdell 0:f7c60d3e7b8a 39 template<typename T, uint32_t queue_sz>
maclobdell 0:f7c60d3e7b8a 40 class Queue {
maclobdell 0:f7c60d3e7b8a 41 public:
maclobdell 0:f7c60d3e7b8a 42 /** Create and initialise a message Queue. */
maclobdell 0:f7c60d3e7b8a 43 Queue() {
maclobdell 0:f7c60d3e7b8a 44 #ifdef CMSIS_OS_RTX
maclobdell 0:f7c60d3e7b8a 45 memset(_queue_q, 0, sizeof(_queue_q));
maclobdell 0:f7c60d3e7b8a 46 _queue_def.pool = _queue_q;
maclobdell 0:f7c60d3e7b8a 47 _queue_def.queue_sz = queue_sz;
maclobdell 0:f7c60d3e7b8a 48 #endif
maclobdell 0:f7c60d3e7b8a 49 _queue_id = osMessageCreate(&_queue_def, NULL);
maclobdell 0:f7c60d3e7b8a 50 if (_queue_id == NULL) {
maclobdell 0:f7c60d3e7b8a 51 error("Error initialising the queue object\n");
maclobdell 0:f7c60d3e7b8a 52 }
maclobdell 0:f7c60d3e7b8a 53 }
maclobdell 0:f7c60d3e7b8a 54
maclobdell 0:f7c60d3e7b8a 55 /** Put a message in a Queue.
maclobdell 0:f7c60d3e7b8a 56 @param data message pointer.
maclobdell 0:f7c60d3e7b8a 57 @param millisec timeout value or 0 in case of no time-out. (default: 0)
maclobdell 0:f7c60d3e7b8a 58 @return status code that indicates the execution status of the function.
maclobdell 0:f7c60d3e7b8a 59 */
maclobdell 0:f7c60d3e7b8a 60 osStatus put(T* data, uint32_t millisec=0) {
maclobdell 0:f7c60d3e7b8a 61 return osMessagePut(_queue_id, (uint32_t)data, millisec);
maclobdell 0:f7c60d3e7b8a 62 }
maclobdell 0:f7c60d3e7b8a 63
maclobdell 0:f7c60d3e7b8a 64 /** Get a message or Wait for a message from a Queue.
maclobdell 0:f7c60d3e7b8a 65 @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever).
maclobdell 0:f7c60d3e7b8a 66 @return event information that includes the message and the status code.
maclobdell 0:f7c60d3e7b8a 67 */
maclobdell 0:f7c60d3e7b8a 68 osEvent get(uint32_t millisec=osWaitForever) {
maclobdell 0:f7c60d3e7b8a 69 return osMessageGet(_queue_id, millisec);
maclobdell 0:f7c60d3e7b8a 70 }
maclobdell 0:f7c60d3e7b8a 71
maclobdell 0:f7c60d3e7b8a 72 private:
maclobdell 0:f7c60d3e7b8a 73 osMessageQId _queue_id;
maclobdell 0:f7c60d3e7b8a 74 osMessageQDef_t _queue_def;
maclobdell 0:f7c60d3e7b8a 75 #ifdef CMSIS_OS_RTX
maclobdell 0:f7c60d3e7b8a 76 uint32_t _queue_q[4+(queue_sz)];
maclobdell 0:f7c60d3e7b8a 77 #endif
maclobdell 0:f7c60d3e7b8a 78 };
maclobdell 0:f7c60d3e7b8a 79
maclobdell 0:f7c60d3e7b8a 80 }
maclobdell 0:f7c60d3e7b8a 81 #endif