ACKme / WiConnect

Host library for controlling a WiConnect enabled Wi-Fi module.

Dependents:   wiconnect-ota_example wiconnect-web_setup_example wiconnect-test-console wiconnect-tcp_server_example ... more

types/CommandQueue.h@11:ea484e1b7fc4, 2014-08-12 (annotated)

Committer:
dan_ackme
Date:
Tue Aug 12 02:34:46 2014 -0700
Revision:
11:ea484e1b7fc4
Parent:
1:6ec9998427ad
Child:
16:7f1d6d359787
updated documnetation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 0:ea85c4bb5e1f 1 /*
dan_ackme 0:ea85c4bb5e1f 2 * Copyright 2014, ACKme Networks
dan_ackme 0:ea85c4bb5e1f 3 * All Rights Reserved.
dan_ackme 0:ea85c4bb5e1f 4 *
dan_ackme 0:ea85c4bb5e1f 5 * This is UNPUBLISHED PROPRIETARY SOURCE CODE of ACKme Networks;
dan_ackme 0:ea85c4bb5e1f 6 * the contents of this file may not be disclosed to third parties, copied
dan_ackme 0:ea85c4bb5e1f 7 * or duplicated in any form, in whole or in part, without the prior
dan_ackme 0:ea85c4bb5e1f 8 * written permission of ACKme Networks.
dan_ackme 0:ea85c4bb5e1f 9 */
dan_ackme 0:ea85c4bb5e1f 10
dan_ackme 0:ea85c4bb5e1f 11 #pragma once
dan_ackme 0:ea85c4bb5e1f 12
dan_ackme 0:ea85c4bb5e1f 13
dan_ackme 0:ea85c4bb5e1f 14 #include "WiconnectTypes.h"
dan_ackme 0:ea85c4bb5e1f 15
dan_ackme 0:ea85c4bb5e1f 16
dan_ackme 0:ea85c4bb5e1f 17 namespace wiconnect
dan_ackme 0:ea85c4bb5e1f 18 {
dan_ackme 0:ea85c4bb5e1f 19
dan_ackme 11:ea484e1b7fc4 20 /**
dan_ackme 11:ea484e1b7fc4 21 * Class for hold queued commands
dan_ackme 11:ea484e1b7fc4 22 *
dan_ackme 11:ea484e1b7fc4 23 * @note Internal use only
dan_ackme 11:ea484e1b7fc4 24 */
dan_ackme 0:ea85c4bb5e1f 25 class CommandQueue
dan_ackme 0:ea85c4bb5e1f 26 {
dan_ackme 0:ea85c4bb5e1f 27 public:
dan_ackme 0:ea85c4bb5e1f 28 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 29 CommandQueue()
dan_ackme 0:ea85c4bb5e1f 30 {
dan_ackme 0:ea85c4bb5e1f 31 head = tail = queue;
dan_ackme 0:ea85c4bb5e1f 32 count = 0;
dan_ackme 0:ea85c4bb5e1f 33 }
dan_ackme 0:ea85c4bb5e1f 34
dan_ackme 0:ea85c4bb5e1f 35 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 36 bool isFull()
dan_ackme 0:ea85c4bb5e1f 37 {
dan_ackme 0:ea85c4bb5e1f 38 return count == WICONNECT_MAX_QUEUED_COMMANDS;
dan_ackme 0:ea85c4bb5e1f 39 }
dan_ackme 0:ea85c4bb5e1f 40
dan_ackme 0:ea85c4bb5e1f 41 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 42 bool isEmpty()
dan_ackme 0:ea85c4bb5e1f 43 {
dan_ackme 0:ea85c4bb5e1f 44 return count == 0;
dan_ackme 0:ea85c4bb5e1f 45 }
dan_ackme 0:ea85c4bb5e1f 46
dan_ackme 0:ea85c4bb5e1f 47 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 48 bool push(QueuedCommand *cmd)
dan_ackme 0:ea85c4bb5e1f 49 {
dan_ackme 0:ea85c4bb5e1f 50 if(isFull())
dan_ackme 0:ea85c4bb5e1f 51 {
dan_ackme 0:ea85c4bb5e1f 52 return false;
dan_ackme 0:ea85c4bb5e1f 53 }
dan_ackme 0:ea85c4bb5e1f 54 ++count;
dan_ackme 0:ea85c4bb5e1f 55 *tail = cmd;
dan_ackme 0:ea85c4bb5e1f 56 if(++tail >= queue + WICONNECT_MAX_QUEUED_COMMANDS)
dan_ackme 0:ea85c4bb5e1f 57 {
dan_ackme 0:ea85c4bb5e1f 58 tail = queue;
dan_ackme 0:ea85c4bb5e1f 59 }
dan_ackme 0:ea85c4bb5e1f 60
dan_ackme 0:ea85c4bb5e1f 61 return true;
dan_ackme 0:ea85c4bb5e1f 62 }
dan_ackme 0:ea85c4bb5e1f 63
dan_ackme 0:ea85c4bb5e1f 64 /*************************************************************************************************/
dan_ackme 0:ea85c4bb5e1f 65 QueuedCommand* pop()
dan_ackme 0:ea85c4bb5e1f 66 {
dan_ackme 0:ea85c4bb5e1f 67 if(isEmpty())
dan_ackme 0:ea85c4bb5e1f 68 return NULL;
dan_ackme 0:ea85c4bb5e1f 69
dan_ackme 0:ea85c4bb5e1f 70 QueuedCommand* cmd = *head;
dan_ackme 0:ea85c4bb5e1f 71 --count;
dan_ackme 0:ea85c4bb5e1f 72 if(++head >= queue + WICONNECT_MAX_QUEUED_COMMANDS)
dan_ackme 0:ea85c4bb5e1f 73 {
dan_ackme 0:ea85c4bb5e1f 74 head = queue;
dan_ackme 0:ea85c4bb5e1f 75 }
dan_ackme 0:ea85c4bb5e1f 76 return cmd;
dan_ackme 0:ea85c4bb5e1f 77 }
dan_ackme 0:ea85c4bb5e1f 78
dan_ackme 0:ea85c4bb5e1f 79 protected:
dan_ackme 0:ea85c4bb5e1f 80 QueuedCommand* queue[WICONNECT_MAX_QUEUED_COMMANDS];
dan_ackme 0:ea85c4bb5e1f 81 QueuedCommand** head;
dan_ackme 0:ea85c4bb5e1f 82 QueuedCommand** tail;
dan_ackme 0:ea85c4bb5e1f 83 int count;
dan_ackme 0:ea85c4bb5e1f 84 };
dan_ackme 0:ea85c4bb5e1f 85
dan_ackme 0:ea85c4bb5e1f 86
dan_ackme 0:ea85c4bb5e1f 87
dan_ackme 0:ea85c4bb5e1f 88
dan_ackme 0:ea85c4bb5e1f 89 }