Samantha Wang / MbedModules

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   SDFileSystem TextLCD mbed-rtos mbed wave_player FATFileSystem

MbedModules/mbed-rtos/rtos/Queue.h@0:6dff7b3b161d, 2014-12-26 (annotated)

Committer:
ywang627
Date:
Fri Dec 26 13:38:44 2014 +0000
Revision:
0:6dff7b3b161d
Battleship Game

Who changed what in which revision?

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