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/QueuedCommand.h@29:b6af04b77a56, 2014-10-27 (annotated)
- Committer:
- dan_ackme
- Date:
- Mon Oct 27 13:42:26 2014 -0700
- Revision:
- 29:b6af04b77a56
refactored library layout
Who changed what in which revision?
User | Revision | Line number | New 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 | * @ingroup api_core_types |
dan_ackme | 29:b6af04b77a56 | 39 | * |
dan_ackme | 29:b6af04b77a56 | 40 | * @brief Class which contains command for asynchronous processing. |
dan_ackme | 29:b6af04b77a56 | 41 | */ |
dan_ackme | 29:b6af04b77a56 | 42 | |
dan_ackme | 29:b6af04b77a56 | 43 | class QueuedCommand |
dan_ackme | 29:b6af04b77a56 | 44 | { |
dan_ackme | 29:b6af04b77a56 | 45 | public: |
dan_ackme | 29:b6af04b77a56 | 46 | void *userData; |
dan_ackme | 29:b6af04b77a56 | 47 | |
dan_ackme | 29:b6af04b77a56 | 48 | |
dan_ackme | 29:b6af04b77a56 | 49 | QueuedCommand(int responseBufferLen, char *responseBuffer, int timeoutMs, const ReaderFunc &reader, void *user, const char *cmd, va_list vaList); |
dan_ackme | 29:b6af04b77a56 | 50 | QueuedCommand(int responseBufferLen, char *responseBuffer, int timeoutMs, const char *cmd, ...); |
dan_ackme | 29:b6af04b77a56 | 51 | QueuedCommand(int responseBufferLen, char *responseBuffer, const char *cmd, ...); |
dan_ackme | 29:b6af04b77a56 | 52 | QueuedCommand(int timeoutMs_, const char *cmd, ...); |
dan_ackme | 29:b6af04b77a56 | 53 | QueuedCommand(const char *cmd, ...); |
dan_ackme | 29:b6af04b77a56 | 54 | ~QueuedCommand(); |
dan_ackme | 29:b6af04b77a56 | 55 | |
dan_ackme | 29:b6af04b77a56 | 56 | char *getResponseBuffer(); |
dan_ackme | 29:b6af04b77a56 | 57 | int getResponseBufferLen(); |
dan_ackme | 29:b6af04b77a56 | 58 | int getTimeoutMs(); |
dan_ackme | 29:b6af04b77a56 | 59 | ReaderFunc getReader(); |
dan_ackme | 29:b6af04b77a56 | 60 | void * getReaderUserData(); |
dan_ackme | 29:b6af04b77a56 | 61 | char* getCommand(); |
dan_ackme | 29:b6af04b77a56 | 62 | Callback getCompletedCallback(); |
dan_ackme | 29:b6af04b77a56 | 63 | void setCompletedCallback(const Callback &cb); |
dan_ackme | 29:b6af04b77a56 | 64 | |
dan_ackme | 29:b6af04b77a56 | 65 | QueuedCommand& operator=( const QueuedCommand& other ); |
dan_ackme | 29:b6af04b77a56 | 66 | void* operator new(size_t size); |
dan_ackme | 29:b6af04b77a56 | 67 | void operator delete(void*); |
dan_ackme | 29:b6af04b77a56 | 68 | |
dan_ackme | 29:b6af04b77a56 | 69 | protected: |
dan_ackme | 29:b6af04b77a56 | 70 | char *responseBuffer; |
dan_ackme | 29:b6af04b77a56 | 71 | int responseBufferLen; |
dan_ackme | 29:b6af04b77a56 | 72 | int timeoutMs; |
dan_ackme | 29:b6af04b77a56 | 73 | ReaderFunc reader; |
dan_ackme | 29:b6af04b77a56 | 74 | void *user; |
dan_ackme | 29:b6af04b77a56 | 75 | char command[WICONNECT_MAX_CMD_SIZE]; |
dan_ackme | 29:b6af04b77a56 | 76 | Callback completeCallback; |
dan_ackme | 29:b6af04b77a56 | 77 | #ifdef WICONNECT_ENABLE_MALLOC |
dan_ackme | 29:b6af04b77a56 | 78 | bool allocatedBuffer; |
dan_ackme | 29:b6af04b77a56 | 79 | #endif |
dan_ackme | 29:b6af04b77a56 | 80 | friend class NetworkInterface; |
dan_ackme | 29:b6af04b77a56 | 81 | friend class Wiconnect; |
dan_ackme | 29:b6af04b77a56 | 82 | |
dan_ackme | 29:b6af04b77a56 | 83 | void initialize(int responseBufferLen, char *responseBuffer_, int timeoutMs_, const ReaderFunc &reader_, void *user_, const char *cmd_, va_list vaList); |
dan_ackme | 29:b6af04b77a56 | 84 | }; |
dan_ackme | 29:b6af04b77a56 | 85 | |
dan_ackme | 29:b6af04b77a56 | 86 | |
dan_ackme | 29:b6af04b77a56 | 87 | |
dan_ackme | 29:b6af04b77a56 | 88 | } |