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