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/WiconnectSocket.h@42:8ffb253b09e7, 2015-09-28 (annotated)

Committer:
aymangrais
Date:
Mon Sep 28 03:38:43 2015 +0000
Revision:
42:8ffb253b09e7
Parent:
29:b6af04b77a56
Child:
39:a963f69cb2de
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 namespace wiconnect
dan_ackme 29:b6af04b77a56 35 {
dan_ackme 29:b6af04b77a56 36
dan_ackme 29:b6af04b77a56 37 /**
dan_ackme 29:b6af04b77a56 38 * @ingroup api_socket_types
dan_ackme 29:b6af04b77a56 39 *
dan_ackme 29:b6af04b77a56 40 * @brief Connection object to remote server.
dan_ackme 29:b6af04b77a56 41 *
dan_ackme 29:b6af04b77a56 42 */
dan_ackme 29:b6af04b77a56 43 class WiconnectSocket
dan_ackme 29:b6af04b77a56 44 {
dan_ackme 29:b6af04b77a56 45 public:
dan_ackme 29:b6af04b77a56 46 WiconnectSocket(int rxBufferLen = 0, void *rxBuffer = NULL, int txBufferLen = 0, void *txBuffer = NULL);
dan_ackme 29:b6af04b77a56 47 ~WiconnectSocket();
dan_ackme 29:b6af04b77a56 48
dan_ackme 29:b6af04b77a56 49 WiconnectResult close();
dan_ackme 29:b6af04b77a56 50 WiconnectResult poll(bool *rxDataAvailablePtr, bool autoClose = false);
dan_ackme 29:b6af04b77a56 51 WiconnectResult write(const void* buffer, int length, bool flush = true);
dan_ackme 29:b6af04b77a56 52 WiconnectResult write(int length, bool flush = true);
dan_ackme 29:b6af04b77a56 53 WiconnectResult read(void* buffer, uint16_t maxLength, uint16_t *bytesRead);
dan_ackme 29:b6af04b77a56 54 WiconnectResult read(uint8_t **bufferPtr = NULL, uint16_t *bytesReadPtr = NULL);
dan_ackme 29:b6af04b77a56 55 WiconnectResult putc(uint8_t c, bool flush = false);
dan_ackme 29:b6af04b77a56 56 WiconnectResult puts(const char *s, bool flush = true);
dan_ackme 29:b6af04b77a56 57 WiconnectResult getc(uint8_t *c);
dan_ackme 29:b6af04b77a56 58 WiconnectResult printf(const char* format, ...);
dan_ackme 29:b6af04b77a56 59 virtual WiconnectResult flushTxBuffer();
dan_ackme 29:b6af04b77a56 60 void clearRxBuffer();
dan_ackme 29:b6af04b77a56 61
dan_ackme 29:b6af04b77a56 62 uint8_t *getTxBuffer();
dan_ackme 29:b6af04b77a56 63 int getTxBufferSize();
dan_ackme 29:b6af04b77a56 64 int getTxBufferBytesPending();
dan_ackme 29:b6af04b77a56 65 uint8_t *getRxBuffer();
dan_ackme 29:b6af04b77a56 66 int getRxBufferSize();
dan_ackme 29:b6af04b77a56 67 int getRxBufferBytesPending();
dan_ackme 29:b6af04b77a56 68
dan_ackme 29:b6af04b77a56 69 bool isConnected();
dan_ackme 29:b6af04b77a56 70 SocketType getType();
dan_ackme 29:b6af04b77a56 71 const char* getHost();
dan_ackme 29:b6af04b77a56 72 uint16_t getLocalPort();
dan_ackme 29:b6af04b77a56 73 uint16_t getRemotePort();
dan_ackme 29:b6af04b77a56 74 uint8_t getHandle();
dan_ackme 29:b6af04b77a56 75
dan_ackme 29:b6af04b77a56 76 protected:
dan_ackme 29:b6af04b77a56 77 bool connected;
dan_ackme 29:b6af04b77a56 78 bool enableAutoClose;
dan_ackme 29:b6af04b77a56 79 SocketType type;
dan_ackme 29:b6af04b77a56 80 uint8_t handle;
dan_ackme 29:b6af04b77a56 81 char host[WICONNECT_MAX_HOST_SIZE];
dan_ackme 29:b6af04b77a56 82 uint16_t localPort;
dan_ackme 29:b6af04b77a56 83 uint16_t remotePort;
dan_ackme 29:b6af04b77a56 84 Wiconnect *wiconnect;
dan_ackme 29:b6af04b77a56 85 Buffer txBuffer;
dan_ackme 29:b6af04b77a56 86 Buffer rxBuffer;
dan_ackme 29:b6af04b77a56 87
dan_ackme 29:b6af04b77a56 88 WiconnectResult init(uint8_t handle, SocketType type, const char *host, uint16_t remotePort, uint16_t localPort);
dan_ackme 29:b6af04b77a56 89
dan_ackme 29:b6af04b77a56 90 friend class SocketInterface;
dan_ackme 29:b6af04b77a56 91 friend class GhmInterface;
dan_ackme 29:b6af04b77a56 92 };
dan_ackme 29:b6af04b77a56 93
dan_ackme 29:b6af04b77a56 94
dan_ackme 29:b6af04b77a56 95 }