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

api/types/CommandQueue.h@42:8ffb253b09e7, 2015-09-28 (annotated)

Committer:
aymangrais
Date:
Mon Sep 28 03:38:43 2015 +0000
Revision:
42:8ffb253b09e7
Parent:
29:b6af04b77a56 
increase ota timeout to be 5 seconds (instead of 1.5 sec)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 29:b6af04b77a56 1 /**
dan_ackme 29:b6af04b77a56 2 * ACKme WiConnect Host Library is licensed under the BSD licence:
dan_ackme 29:b6af04b77a56 3 *
dan_ackme 29:b6af04b77a56 4 * Copyright (c)2014 ACKme Networks.
dan_ackme 29:b6af04b77a56 5 * All rights reserved.
dan_ackme 29:b6af04b77a56 6 *
dan_ackme 29:b6af04b77a56 7 * Redistribution and use in source and binary forms, with or without modification,
dan_ackme 29:b6af04b77a56 8 * are permitted provided that the following conditions are met:
dan_ackme 29:b6af04b77a56 9 *
dan_ackme 29:b6af04b77a56 10 * 1. Redistributions of source code must retain the above copyright notice,
dan_ackme 29:b6af04b77a56 11 * this list of conditions and the following disclaimer.
dan_ackme 29:b6af04b77a56 12 * 2. Redistributions in binary form must reproduce the above copyright notice,
dan_ackme 29:b6af04b77a56 13 * this list of conditions and the following disclaimer in the documentation
dan_ackme 29:b6af04b77a56 14 * and/or other materials provided with the distribution.
dan_ackme 29:b6af04b77a56 15 * 3. The name of the author may not be used to endorse or promote products
dan_ackme 29:b6af04b77a56 16 * derived from this software without specific prior written permission.
dan_ackme 29:b6af04b77a56 17 *
dan_ackme 29:b6af04b77a56 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED
dan_ackme 29:b6af04b77a56 19 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
dan_ackme 29:b6af04b77a56 20 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
dan_ackme 29:b6af04b77a56 21 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
dan_ackme 29:b6af04b77a56 22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
dan_ackme 29:b6af04b77a56 23 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
dan_ackme 29:b6af04b77a56 24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
dan_ackme 29:b6af04b77a56 25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
dan_ackme 29:b6af04b77a56 26 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
dan_ackme 29:b6af04b77a56 27 * OF SUCH DAMAGE.
dan_ackme 29:b6af04b77a56 28 */
dan_ackme 29:b6af04b77a56 29 #pragma once
dan_ackme 29:b6af04b77a56 30
dan_ackme 29:b6af04b77a56 31
dan_ackme 29:b6af04b77a56 32 #include "api/WiconnectTypes.h"
dan_ackme 29:b6af04b77a56 33
dan_ackme 29:b6af04b77a56 34
dan_ackme 29:b6af04b77a56 35 namespace wiconnect
dan_ackme 29:b6af04b77a56 36 {
dan_ackme 29:b6af04b77a56 37
dan_ackme 29:b6af04b77a56 38 /**
dan_ackme 29:b6af04b77a56 39 * Class for hold queued commands
dan_ackme 29:b6af04b77a56 40 *
dan_ackme 29:b6af04b77a56 41 * @note Internal use only
dan_ackme 29:b6af04b77a56 42 */
dan_ackme 29:b6af04b77a56 43 class CommandQueue
dan_ackme 29:b6af04b77a56 44 {
dan_ackme 29:b6af04b77a56 45 public:
dan_ackme 29:b6af04b77a56 46 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 47 CommandQueue()
dan_ackme 29:b6af04b77a56 48 {
dan_ackme 29:b6af04b77a56 49 head = tail = queue;
dan_ackme 29:b6af04b77a56 50 count = 0;
dan_ackme 29:b6af04b77a56 51 }
dan_ackme 29:b6af04b77a56 52
dan_ackme 29:b6af04b77a56 53 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 54 bool isFull()
dan_ackme 29:b6af04b77a56 55 {
dan_ackme 29:b6af04b77a56 56 return count == WICONNECT_MAX_QUEUED_COMMANDS;
dan_ackme 29:b6af04b77a56 57 }
dan_ackme 29:b6af04b77a56 58
dan_ackme 29:b6af04b77a56 59 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 60 bool isEmpty()
dan_ackme 29:b6af04b77a56 61 {
dan_ackme 29:b6af04b77a56 62 return count == 0;
dan_ackme 29:b6af04b77a56 63 }
dan_ackme 29:b6af04b77a56 64
dan_ackme 29:b6af04b77a56 65 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 66 bool push(QueuedCommand *cmd)
dan_ackme 29:b6af04b77a56 67 {
dan_ackme 29:b6af04b77a56 68 if(isFull())
dan_ackme 29:b6af04b77a56 69 {
dan_ackme 29:b6af04b77a56 70 return false;
dan_ackme 29:b6af04b77a56 71 }
dan_ackme 29:b6af04b77a56 72 ++count;
dan_ackme 29:b6af04b77a56 73 *tail = cmd;
dan_ackme 29:b6af04b77a56 74 if(++tail >= queue + WICONNECT_MAX_QUEUED_COMMANDS)
dan_ackme 29:b6af04b77a56 75 {
dan_ackme 29:b6af04b77a56 76 tail = queue;
dan_ackme 29:b6af04b77a56 77 }
dan_ackme 29:b6af04b77a56 78
dan_ackme 29:b6af04b77a56 79 return true;
dan_ackme 29:b6af04b77a56 80 }
dan_ackme 29:b6af04b77a56 81
dan_ackme 29:b6af04b77a56 82 /*************************************************************************************************/
dan_ackme 29:b6af04b77a56 83 QueuedCommand* pop()
dan_ackme 29:b6af04b77a56 84 {
dan_ackme 29:b6af04b77a56 85 if(isEmpty())
dan_ackme 29:b6af04b77a56 86 return NULL;
dan_ackme 29:b6af04b77a56 87
dan_ackme 29:b6af04b77a56 88 QueuedCommand* cmd = *head;
dan_ackme 29:b6af04b77a56 89 --count;
dan_ackme 29:b6af04b77a56 90 if(++head >= queue + WICONNECT_MAX_QUEUED_COMMANDS)
dan_ackme 29:b6af04b77a56 91 {
dan_ackme 29:b6af04b77a56 92 head = queue;
dan_ackme 29:b6af04b77a56 93 }
dan_ackme 29:b6af04b77a56 94 return cmd;
dan_ackme 29:b6af04b77a56 95 }
dan_ackme 29:b6af04b77a56 96
dan_ackme 29:b6af04b77a56 97 protected:
dan_ackme 29:b6af04b77a56 98 QueuedCommand* queue[WICONNECT_MAX_QUEUED_COMMANDS];
dan_ackme 29:b6af04b77a56 99 QueuedCommand** head;
dan_ackme 29:b6af04b77a56 100 QueuedCommand** tail;
dan_ackme 29:b6af04b77a56 101 int count;
dan_ackme 29:b6af04b77a56 102 };
dan_ackme 29:b6af04b77a56 103
dan_ackme 29:b6af04b77a56 104
dan_ackme 29:b6af04b77a56 105
dan_ackme 29:b6af04b77a56 106
dan_ackme 29:b6af04b77a56 107 }