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
Diff: api/types/CommandQueue.h
- Revision:
- 29:b6af04b77a56
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/api/types/CommandQueue.h Mon Oct 27 13:42:26 2014 -0700 @@ -0,0 +1,107 @@ +/** + * ACKme WiConnect Host Library is licensed under the BSD licence: + * + * Copyright (c)2014 ACKme Networks. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT + * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT + * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING + * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY + * OF SUCH DAMAGE. + */ +#pragma once + + +#include "api/WiconnectTypes.h" + + +namespace wiconnect +{ + +/** + * Class for hold queued commands + * + * @note Internal use only + */ +class CommandQueue +{ +public: + /*************************************************************************************************/ + CommandQueue() + { + head = tail = queue; + count = 0; + } + + /*************************************************************************************************/ + bool isFull() + { + return count == WICONNECT_MAX_QUEUED_COMMANDS; + } + + /*************************************************************************************************/ + bool isEmpty() + { + return count == 0; + } + + /*************************************************************************************************/ + bool push(QueuedCommand *cmd) + { + if(isFull()) + { + return false; + } + ++count; + *tail = cmd; + if(++tail >= queue + WICONNECT_MAX_QUEUED_COMMANDS) + { + tail = queue; + } + + return true; + } + + /*************************************************************************************************/ + QueuedCommand* pop() + { + if(isEmpty()) + return NULL; + + QueuedCommand* cmd = *head; + --count; + if(++head >= queue + WICONNECT_MAX_QUEUED_COMMANDS) + { + head = queue; + } + return cmd; + } + +protected: + QueuedCommand* queue[WICONNECT_MAX_QUEUED_COMMANDS]; + QueuedCommand** head; + QueuedCommand** tail; + int count; +}; + + + + +}