Alan Ffrench / Mbed 2 deprecated Experiment_2_5

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:   mbed

mbed-rtos/rtos/Queue.h@0:52468b19aa21, 2020-07-29 (annotated)

Committer:
alanffrench
Date:
Wed Jul 29 18:51:38 2020 +0000
Revision:
0:52468b19aa21
Threads

Who changed what in which revision?

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