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/QueuedCommand.h@24:e27e23297f02, 2014-09-06 (annotated)

Committer:
dan_ackme
Date:
Sat Sep 06 20:34:01 2014 -0700
Revision:
24:e27e23297f02
Parent:
16:7f1d6d359787 
add api to get/set module settings

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 24:e27e23297f02 1 /**
dan_ackme 24:e27e23297f02 2 * ACKme WiConnect Host Library is licensed under the BSD licence:
dan_ackme 24:e27e23297f02 3 *
dan_ackme 24:e27e23297f02 4 * Copyright (c)2014 ACKme Networks.
dan_ackme 24:e27e23297f02 5 * All rights reserved.
dan_ackme 24:e27e23297f02 6 *
dan_ackme 24:e27e23297f02 7 * Redistribution and use in source and binary forms, with or without modification,
dan_ackme 24:e27e23297f02 8 * are permitted provided that the following conditions are met:
dan_ackme 24:e27e23297f02 9 *
dan_ackme 24:e27e23297f02 10 * 1. Redistributions of source code must retain the above copyright notice,
dan_ackme 24:e27e23297f02 11 * this list of conditions and the following disclaimer.
dan_ackme 24:e27e23297f02 12 * 2. Redistributions in binary form must reproduce the above copyright notice,
dan_ackme 24:e27e23297f02 13 * this list of conditions and the following disclaimer in the documentation
dan_ackme 24:e27e23297f02 14 * and/or other materials provided with the distribution.
dan_ackme 24:e27e23297f02 15 * 3. The name of the author may not be used to endorse or promote products
dan_ackme 24:e27e23297f02 16 * derived from this software without specific prior written permission.
dan_ackme 24:e27e23297f02 17 *
dan_ackme 24:e27e23297f02 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS AND ANY EXPRESS OR IMPLIED
dan_ackme 24:e27e23297f02 19 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
dan_ackme 24:e27e23297f02 20 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
dan_ackme 24:e27e23297f02 21 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
dan_ackme 24:e27e23297f02 22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
dan_ackme 24:e27e23297f02 23 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
dan_ackme 24:e27e23297f02 24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
dan_ackme 24:e27e23297f02 25 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
dan_ackme 24:e27e23297f02 26 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
dan_ackme 24:e27e23297f02 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 11:ea484e1b7fc4 37 /**
dan_ackme 13:2b51f5267c92 38 * @ingroup api_core_types
dan_ackme 11:ea484e1b7fc4 39 *
dan_ackme 11:ea484e1b7fc4 40 * @brief Class which contains command for asynchronous processing.
dan_ackme 11:ea484e1b7fc4 41 */
dan_ackme 0:ea85c4bb5e1f 42
dan_ackme 0:ea85c4bb5e1f 43 class QueuedCommand
dan_ackme 0:ea85c4bb5e1f 44 {
dan_ackme 0:ea85c4bb5e1f 45 public:
dan_ackme 0:ea85c4bb5e1f 46 void *userData;
dan_ackme 0:ea85c4bb5e1f 47
dan_ackme 0:ea85c4bb5e1f 48
dan_ackme 0:ea85c4bb5e1f 49 QueuedCommand(int responseBufferLen, char *responseBuffer, int timeoutMs, const ReaderFunc &reader, void *user, const char *cmd, va_list vaList);
dan_ackme 0:ea85c4bb5e1f 50 QueuedCommand(int responseBufferLen, char *responseBuffer, int timeoutMs, const char *cmd, ...);
dan_ackme 0:ea85c4bb5e1f 51 QueuedCommand(int responseBufferLen, char *responseBuffer, const char *cmd, ...);
dan_ackme 0:ea85c4bb5e1f 52 QueuedCommand(int timeoutMs_, const char *cmd, ...);
dan_ackme 0:ea85c4bb5e1f 53 QueuedCommand(const char *cmd, ...);
dan_ackme 0:ea85c4bb5e1f 54 ~QueuedCommand();
dan_ackme 0:ea85c4bb5e1f 55
dan_ackme 0:ea85c4bb5e1f 56 char *getResponseBuffer();
dan_ackme 0:ea85c4bb5e1f 57 int getResponseBufferLen();
dan_ackme 0:ea85c4bb5e1f 58 int getTimeoutMs();
dan_ackme 0:ea85c4bb5e1f 59 ReaderFunc getReader();
dan_ackme 0:ea85c4bb5e1f 60 void * getReaderUserData();
dan_ackme 0:ea85c4bb5e1f 61 char* getCommand();
dan_ackme 0:ea85c4bb5e1f 62 Callback getCompletedCallback();
dan_ackme 0:ea85c4bb5e1f 63 void setCompletedCallback(const Callback &cb);
dan_ackme 0:ea85c4bb5e1f 64
dan_ackme 0:ea85c4bb5e1f 65 QueuedCommand& operator=( const QueuedCommand& other );
dan_ackme 0:ea85c4bb5e1f 66 void* operator new(size_t size);
dan_ackme 0:ea85c4bb5e1f 67 void operator delete(void*);
dan_ackme 0:ea85c4bb5e1f 68
dan_ackme 0:ea85c4bb5e1f 69 protected:
dan_ackme 0:ea85c4bb5e1f 70 char *responseBuffer;
dan_ackme 0:ea85c4bb5e1f 71 int responseBufferLen;
dan_ackme 0:ea85c4bb5e1f 72 int timeoutMs;
dan_ackme 0:ea85c4bb5e1f 73 ReaderFunc reader;
dan_ackme 0:ea85c4bb5e1f 74 void *user;
dan_ackme 0:ea85c4bb5e1f 75 char command[WICONNECT_MAX_CMD_SIZE];
dan_ackme 0:ea85c4bb5e1f 76 Callback completeCallback;
dan_ackme 0:ea85c4bb5e1f 77 #ifdef WICONNECT_ENABLE_MALLOC
dan_ackme 0:ea85c4bb5e1f 78 bool allocatedBuffer;
dan_ackme 0:ea85c4bb5e1f 79 #endif
dan_ackme 0:ea85c4bb5e1f 80 friend class NetworkInterface;
dan_ackme 0:ea85c4bb5e1f 81 friend class Wiconnect;
dan_ackme 0:ea85c4bb5e1f 82
dan_ackme 0:ea85c4bb5e1f 83 void initialize(int responseBufferLen, char *responseBuffer_, int timeoutMs_, const ReaderFunc &reader_, void *user_, const char *cmd_, va_list vaList);
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 }