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

internal/network/socket/SocketInterface.cpp@11:ea484e1b7fc4, 2014-08-12 (annotated)

Committer:
dan_ackme
Date:
Tue Aug 12 02:34:46 2014 -0700
Revision:
11:ea484e1b7fc4
updated documnetation

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 11:ea484e1b7fc4 1 /*
dan_ackme 11:ea484e1b7fc4 2 * Copyright 2014, ACKme Networks
dan_ackme 11:ea484e1b7fc4 3 * All Rights Reserved.
dan_ackme 11:ea484e1b7fc4 4 *
dan_ackme 11:ea484e1b7fc4 5 * This is UNPUBLISHED PROPRIETARY SOURCE CODE of ACKme Networks;
dan_ackme 11:ea484e1b7fc4 6 * the contents of this file may not be disclosed to third parties, copied
dan_ackme 11:ea484e1b7fc4 7 * or duplicated in any form, in whole or in part, without the prior
dan_ackme 11:ea484e1b7fc4 8 * written permission of ACKme Networks.
dan_ackme 11:ea484e1b7fc4 9 */
dan_ackme 11:ea484e1b7fc4 10
dan_ackme 11:ea484e1b7fc4 11
dan_ackme 11:ea484e1b7fc4 12 #include "Wiconnect.h"
dan_ackme 11:ea484e1b7fc4 13 #include "internal/common.h"
dan_ackme 11:ea484e1b7fc4 14 #include "StringUtil.h"
dan_ackme 11:ea484e1b7fc4 15
dan_ackme 11:ea484e1b7fc4 16 #include "types/SocketIrqHandlerMap.h"
dan_ackme 11:ea484e1b7fc4 17
dan_ackme 11:ea484e1b7fc4 18
dan_ackme 11:ea484e1b7fc4 19
dan_ackme 11:ea484e1b7fc4 20
dan_ackme 11:ea484e1b7fc4 21 /*************************************************************************************************/
dan_ackme 11:ea484e1b7fc4 22 SocketInterface::SocketInterface(Wiconnect *wiconnect_)
dan_ackme 11:ea484e1b7fc4 23 {
dan_ackme 11:ea484e1b7fc4 24 wiconnect = wiconnect_;
dan_ackme 11:ea484e1b7fc4 25 }
dan_ackme 11:ea484e1b7fc4 26
dan_ackme 11:ea484e1b7fc4 27 /*************************************************************************************************/
dan_ackme 11:ea484e1b7fc4 28 WiconnectResult SocketInterface::connect(Socket &socket, SocketType type, const char *host, uint16_t remortPort, uint16_t localPort, const void *args, Pin irqPin)
dan_ackme 11:ea484e1b7fc4 29 {
dan_ackme 11:ea484e1b7fc4 30 WiconnectResult result;
dan_ackme 11:ea484e1b7fc4 31 int32_t handle;
dan_ackme 11:ea484e1b7fc4 32 char cmdBuffer[WICONNECT_MAX_CMD_SIZE];
dan_ackme 11:ea484e1b7fc4 33
dan_ackme 11:ea484e1b7fc4 34 if(WICONNECT_IS_IDLE())
dan_ackme 11:ea484e1b7fc4 35 {
dan_ackme 11:ea484e1b7fc4 36 char gpioOption[8] = "";
dan_ackme 11:ea484e1b7fc4 37
dan_ackme 11:ea484e1b7fc4 38 if(irqPin != NC)
dan_ackme 11:ea484e1b7fc4 39 {
dan_ackme 11:ea484e1b7fc4 40 PinToGpioMapper mapper = wiconnect->pinToGpioMapper;
dan_ackme 11:ea484e1b7fc4 41 if(mapper == NULL)
dan_ackme 11:ea484e1b7fc4 42 {
dan_ackme 11:ea484e1b7fc4 43 return WICONNECT_PINNAME_TO_GPIO_MAPPER_NULL;
dan_ackme 11:ea484e1b7fc4 44 }
dan_ackme 11:ea484e1b7fc4 45 int8_t gpio = mapper(irqPin);
dan_ackme 11:ea484e1b7fc4 46 if(gpio == -1)
dan_ackme 11:ea484e1b7fc4 47 {
dan_ackme 11:ea484e1b7fc4 48 return WICONNECT_PINNAME_TO_GPIO_NO_MAPPING;
dan_ackme 11:ea484e1b7fc4 49 }
dan_ackme 11:ea484e1b7fc4 50 else if(!irqHandlers.pinIsRegistered(irqPin))
dan_ackme 11:ea484e1b7fc4 51 {
dan_ackme 11:ea484e1b7fc4 52 return WICONNECT_NOT_FOUND;
dan_ackme 11:ea484e1b7fc4 53 }
dan_ackme 11:ea484e1b7fc4 54
dan_ackme 11:ea484e1b7fc4 55 sprintf(gpioOption, "-g %d ", gpio);
dan_ackme 11:ea484e1b7fc4 56 }
dan_ackme 11:ea484e1b7fc4 57
dan_ackme 11:ea484e1b7fc4 58
dan_ackme 11:ea484e1b7fc4 59 switch(type)
dan_ackme 11:ea484e1b7fc4 60 {
dan_ackme 11:ea484e1b7fc4 61 case SOCKET_TYPE_TCP:
dan_ackme 11:ea484e1b7fc4 62 sprintf(cmdBuffer, "tcpc %s%s %d", gpioOption, host, remortPort);
dan_ackme 11:ea484e1b7fc4 63 break;
dan_ackme 11:ea484e1b7fc4 64
dan_ackme 11:ea484e1b7fc4 65 case SOCKET_TYPE_UDP: {
dan_ackme 11:ea484e1b7fc4 66 char tmp[16];
dan_ackme 11:ea484e1b7fc4 67 sprintf(cmdBuffer, "udpc %s%s %d %s", gpioOption, host, remortPort,
dan_ackme 11:ea484e1b7fc4 68 (localPort != SOCKET_ANY_PORT) ? StringUtil::uint32ToStr(tmp, localPort) : "");
dan_ackme 11:ea484e1b7fc4 69 } break;
dan_ackme 11:ea484e1b7fc4 70
dan_ackme 11:ea484e1b7fc4 71 case SOCKET_TYPE_TLS:
dan_ackme 11:ea484e1b7fc4 72 sprintf(cmdBuffer, "tlsc %s%s %d %s", gpioOption, host, remortPort,
dan_ackme 11:ea484e1b7fc4 73 (args != NULL) ? (char*)args : "");
dan_ackme 11:ea484e1b7fc4 74 break;
dan_ackme 11:ea484e1b7fc4 75
dan_ackme 11:ea484e1b7fc4 76 case SOCKET_TYPE_HTTP: {
dan_ackme 11:ea484e1b7fc4 77 const HttpSocketArgs *httpArgs = (const HttpSocketArgs*)args;
dan_ackme 11:ea484e1b7fc4 78 switch(httpArgs->type)
dan_ackme 11:ea484e1b7fc4 79 {
dan_ackme 11:ea484e1b7fc4 80 case SOCKET_HTTP_GET:
dan_ackme 11:ea484e1b7fc4 81 sprintf(cmdBuffer, "http_get %s%s %s", httpArgs->openOnly ? "-o " : "",
dan_ackme 11:ea484e1b7fc4 82 host,
dan_ackme 11:ea484e1b7fc4 83 (httpArgs->certName != NULL) ? httpArgs->certName : "");
dan_ackme 11:ea484e1b7fc4 84 break;
dan_ackme 11:ea484e1b7fc4 85
dan_ackme 11:ea484e1b7fc4 86 case SOCKET_HTTP_HEAD:
dan_ackme 11:ea484e1b7fc4 87 sprintf(cmdBuffer, "http_head %s%s %s", httpArgs->openOnly ? "-o " : "",
dan_ackme 11:ea484e1b7fc4 88 host,
dan_ackme 11:ea484e1b7fc4 89 (httpArgs->certName != NULL) ? httpArgs->certName : "");
dan_ackme 11:ea484e1b7fc4 90 break;
dan_ackme 11:ea484e1b7fc4 91
dan_ackme 11:ea484e1b7fc4 92 case SOCKET_HTTP_POST:
dan_ackme 11:ea484e1b7fc4 93 sprintf(cmdBuffer, "http_post %s%s %s %s", httpArgs->openOnly ? "-o " : "",
dan_ackme 11:ea484e1b7fc4 94 host,
dan_ackme 11:ea484e1b7fc4 95 httpArgs->contextType,
dan_ackme 11:ea484e1b7fc4 96 (httpArgs->certName != NULL) ? httpArgs->certName : "");
dan_ackme 11:ea484e1b7fc4 97 break;
dan_ackme 11:ea484e1b7fc4 98
dan_ackme 11:ea484e1b7fc4 99 default:
dan_ackme 11:ea484e1b7fc4 100 return WICONNECT_BAD_ARG;
dan_ackme 11:ea484e1b7fc4 101 }
dan_ackme 11:ea484e1b7fc4 102
dan_ackme 11:ea484e1b7fc4 103 } break;
dan_ackme 11:ea484e1b7fc4 104 default:
dan_ackme 11:ea484e1b7fc4 105 return WICONNECT_BAD_ARG;
dan_ackme 11:ea484e1b7fc4 106 }
dan_ackme 11:ea484e1b7fc4 107 }
dan_ackme 11:ea484e1b7fc4 108
dan_ackme 11:ea484e1b7fc4 109 CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 11:ea484e1b7fc4 110
dan_ackme 11:ea484e1b7fc4 111 if(WICONNECT_SUCCEEDED(result, wiconnect->sendCommand(cmdBuffer)))
dan_ackme 11:ea484e1b7fc4 112 {
dan_ackme 11:ea484e1b7fc4 113 if(!WICONNECT_FAILED(result, wiconnect->responseToInt32(&handle)))
dan_ackme 11:ea484e1b7fc4 114 {
dan_ackme 11:ea484e1b7fc4 115 socket.init(handle, type, host, remortPort, localPort);
dan_ackme 11:ea484e1b7fc4 116 }
dan_ackme 11:ea484e1b7fc4 117 }
dan_ackme 11:ea484e1b7fc4 118
dan_ackme 11:ea484e1b7fc4 119 CHECK_CLEANUP_COMMAND();
dan_ackme 11:ea484e1b7fc4 120
dan_ackme 11:ea484e1b7fc4 121 return result;
dan_ackme 11:ea484e1b7fc4 122 }
dan_ackme 11:ea484e1b7fc4 123
dan_ackme 11:ea484e1b7fc4 124 /*************************************************************************************************/
dan_ackme 11:ea484e1b7fc4 125 WiconnectResult SocketInterface::tcpConnect(Socket &socket, const char *host, uint16_t remortPort, Pin irqPin)
dan_ackme 11:ea484e1b7fc4 126 {
dan_ackme 11:ea484e1b7fc4 127 return connect(socket, SOCKET_TYPE_TCP, host, remortPort, SOCKET_ANY_PORT, NULL, irqPin);
dan_ackme 11:ea484e1b7fc4 128 }
dan_ackme 11:ea484e1b7fc4 129
dan_ackme 11:ea484e1b7fc4 130 /*************************************************************************************************/
dan_ackme 11:ea484e1b7fc4 131 WiconnectResult SocketInterface::tlsConnect(Socket &socket, const char *host, uint16_t remortPort, const char *certFilename, Pin irqPin)
dan_ackme 11:ea484e1b7fc4 132 {
dan_ackme 11:ea484e1b7fc4 133 return connect(socket, SOCKET_TYPE_TLS, host, remortPort, SOCKET_ANY_PORT, certFilename, irqPin);
dan_ackme 11:ea484e1b7fc4 134 }
dan_ackme 11:ea484e1b7fc4 135
dan_ackme 11:ea484e1b7fc4 136 /*************************************************************************************************/
dan_ackme 11:ea484e1b7fc4 137 WiconnectResult SocketInterface::udpConnect(Socket &socket, const char *host, uint16_t remortPort, uint16_t localPort, Pin irqPin)
dan_ackme 11:ea484e1b7fc4 138 {
dan_ackme 11:ea484e1b7fc4 139 return connect(socket, SOCKET_TYPE_UDP, host, remortPort, localPort, NULL, irqPin);
dan_ackme 11:ea484e1b7fc4 140 }
dan_ackme 11:ea484e1b7fc4 141
dan_ackme 11:ea484e1b7fc4 142 /*************************************************************************************************/
dan_ackme 11:ea484e1b7fc4 143 WiconnectResult SocketInterface::httpConnect(Socket &socket, const char *url, const HttpSocketArgs *args)
dan_ackme 11:ea484e1b7fc4 144 {
dan_ackme 11:ea484e1b7fc4 145 return connect(socket, SOCKET_TYPE_HTTP, url, SOCKET_ANY_PORT, SOCKET_ANY_PORT, args, NC);
dan_ackme 11:ea484e1b7fc4 146 }
dan_ackme 11:ea484e1b7fc4 147
dan_ackme 11:ea484e1b7fc4 148 /*************************************************************************************************/
dan_ackme 11:ea484e1b7fc4 149 WiconnectResult SocketInterface::httpGet(Socket &socket, const char *url, bool openOnly, const char *certFilename)
dan_ackme 11:ea484e1b7fc4 150 {
dan_ackme 11:ea484e1b7fc4 151 const HttpSocketArgs args =
dan_ackme 11:ea484e1b7fc4 152 {
dan_ackme 11:ea484e1b7fc4 153 NULL,
dan_ackme 11:ea484e1b7fc4 154 certFilename,
dan_ackme 11:ea484e1b7fc4 155 openOnly,
dan_ackme 11:ea484e1b7fc4 156 SOCKET_HTTP_GET
dan_ackme 11:ea484e1b7fc4 157 };
dan_ackme 11:ea484e1b7fc4 158 return httpConnect(socket, url, &args);
dan_ackme 11:ea484e1b7fc4 159 }
dan_ackme 11:ea484e1b7fc4 160
dan_ackme 11:ea484e1b7fc4 161 /*************************************************************************************************/
dan_ackme 11:ea484e1b7fc4 162 WiconnectResult SocketInterface::httpPost(Socket &socket, const char *url, const char *contextType, bool openOnly, const char *certFilename)
dan_ackme 11:ea484e1b7fc4 163 {
dan_ackme 11:ea484e1b7fc4 164 const HttpSocketArgs args =
dan_ackme 11:ea484e1b7fc4 165 {
dan_ackme 11:ea484e1b7fc4 166 contextType,
dan_ackme 11:ea484e1b7fc4 167 certFilename,
dan_ackme 11:ea484e1b7fc4 168 openOnly,
dan_ackme 11:ea484e1b7fc4 169 SOCKET_HTTP_POST
dan_ackme 11:ea484e1b7fc4 170 };
dan_ackme 11:ea484e1b7fc4 171 return httpConnect(socket, url, &args);
dan_ackme 11:ea484e1b7fc4 172 }
dan_ackme 11:ea484e1b7fc4 173
dan_ackme 11:ea484e1b7fc4 174 /*************************************************************************************************/
dan_ackme 11:ea484e1b7fc4 175 WiconnectResult SocketInterface::httpHead(Socket &socket, const char *url, const char *certFilename)
dan_ackme 11:ea484e1b7fc4 176 {
dan_ackme 11:ea484e1b7fc4 177 const HttpSocketArgs args =
dan_ackme 11:ea484e1b7fc4 178 {
dan_ackme 11:ea484e1b7fc4 179 NULL,
dan_ackme 11:ea484e1b7fc4 180 certFilename,
dan_ackme 11:ea484e1b7fc4 181 false,
dan_ackme 11:ea484e1b7fc4 182 SOCKET_HTTP_HEAD
dan_ackme 11:ea484e1b7fc4 183 };
dan_ackme 11:ea484e1b7fc4 184 return httpConnect(socket, url, &args);
dan_ackme 11:ea484e1b7fc4 185 }
dan_ackme 11:ea484e1b7fc4 186
dan_ackme 11:ea484e1b7fc4 187 /*************************************************************************************************/
dan_ackme 11:ea484e1b7fc4 188 WiconnectResult SocketInterface::httpAddHeader(Socket &socket, const char *key, const char *value)
dan_ackme 11:ea484e1b7fc4 189 {
dan_ackme 11:ea484e1b7fc4 190 WiconnectResult result;
dan_ackme 11:ea484e1b7fc4 191 char cmdBuffer[WICONNECT_MAX_CMD_SIZE];
dan_ackme 11:ea484e1b7fc4 192
dan_ackme 11:ea484e1b7fc4 193 if(WICONNECT_IS_IDLE())
dan_ackme 11:ea484e1b7fc4 194 {
dan_ackme 11:ea484e1b7fc4 195 sprintf(cmdBuffer, "http_add_header %d %s %s", socket.getHandle(), key, value);
dan_ackme 11:ea484e1b7fc4 196 }
dan_ackme 11:ea484e1b7fc4 197
dan_ackme 11:ea484e1b7fc4 198 CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 11:ea484e1b7fc4 199
dan_ackme 11:ea484e1b7fc4 200 result = wiconnect->sendCommand(cmdBuffer);
dan_ackme 11:ea484e1b7fc4 201
dan_ackme 11:ea484e1b7fc4 202 CHECK_CLEANUP_COMMAND();
dan_ackme 11:ea484e1b7fc4 203
dan_ackme 11:ea484e1b7fc4 204 return result;
dan_ackme 11:ea484e1b7fc4 205 }
dan_ackme 11:ea484e1b7fc4 206
dan_ackme 11:ea484e1b7fc4 207 /*************************************************************************************************/
dan_ackme 11:ea484e1b7fc4 208 WiconnectResult SocketInterface::httpGetStatus(Socket &socket, uint32_t *statusCodePtr)
dan_ackme 11:ea484e1b7fc4 209 {
dan_ackme 11:ea484e1b7fc4 210 WiconnectResult result;
dan_ackme 11:ea484e1b7fc4 211
dan_ackme 11:ea484e1b7fc4 212 CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 11:ea484e1b7fc4 213
dan_ackme 11:ea484e1b7fc4 214 result = wiconnect->sendCommand("http_read_status %d", socket.getHandle());
dan_ackme 11:ea484e1b7fc4 215
dan_ackme 11:ea484e1b7fc4 216 CHECK_CLEANUP_COMMAND();
dan_ackme 11:ea484e1b7fc4 217
dan_ackme 11:ea484e1b7fc4 218 return result;
dan_ackme 11:ea484e1b7fc4 219 }
dan_ackme 11:ea484e1b7fc4 220
dan_ackme 11:ea484e1b7fc4 221 /*************************************************************************************************/
dan_ackme 11:ea484e1b7fc4 222 WiconnectResult SocketInterface::closeAllSockets()
dan_ackme 11:ea484e1b7fc4 223 {
dan_ackme 11:ea484e1b7fc4 224 WiconnectResult result;
dan_ackme 11:ea484e1b7fc4 225
dan_ackme 11:ea484e1b7fc4 226 CHECK_OTHER_COMMAND_EXECUTING();
dan_ackme 11:ea484e1b7fc4 227
dan_ackme 11:ea484e1b7fc4 228 result = wiconnect->sendCommand("close all");
dan_ackme 11:ea484e1b7fc4 229
dan_ackme 11:ea484e1b7fc4 230 CHECK_CLEANUP_COMMAND();
dan_ackme 11:ea484e1b7fc4 231
dan_ackme 11:ea484e1b7fc4 232 return result;
dan_ackme 11:ea484e1b7fc4 233 }
dan_ackme 11:ea484e1b7fc4 234
dan_ackme 11:ea484e1b7fc4 235
dan_ackme 11:ea484e1b7fc4 236 /*************************************************************************************************/
dan_ackme 11:ea484e1b7fc4 237 WiconnectResult SocketInterface::registerSocketIrqHandler(Pin irqPin, const Callback &handler)
dan_ackme 11:ea484e1b7fc4 238 {
dan_ackme 11:ea484e1b7fc4 239 PinToGpioMapper mapper = wiconnect->pinToGpioMapper;
dan_ackme 11:ea484e1b7fc4 240 if(irqHandlers.pinIsRegistered(irqPin))
dan_ackme 11:ea484e1b7fc4 241 {
dan_ackme 11:ea484e1b7fc4 242 return WICONNECT_DUPLICATE;
dan_ackme 11:ea484e1b7fc4 243 }
dan_ackme 11:ea484e1b7fc4 244 else if(mapper == NULL)
dan_ackme 11:ea484e1b7fc4 245 {
dan_ackme 11:ea484e1b7fc4 246 return WICONNECT_PINNAME_TO_GPIO_MAPPER_NULL;
dan_ackme 11:ea484e1b7fc4 247 }
dan_ackme 11:ea484e1b7fc4 248 int8_t gpio = mapper(irqPin);
dan_ackme 11:ea484e1b7fc4 249 if(gpio == -1)
dan_ackme 11:ea484e1b7fc4 250 {
dan_ackme 11:ea484e1b7fc4 251 return WICONNECT_PINNAME_TO_GPIO_NO_MAPPING;
dan_ackme 11:ea484e1b7fc4 252 }
dan_ackme 11:ea484e1b7fc4 253
dan_ackme 11:ea484e1b7fc4 254 return irqHandlers.registerHandler(irqPin, handler);
dan_ackme 11:ea484e1b7fc4 255 }
dan_ackme 11:ea484e1b7fc4 256
dan_ackme 11:ea484e1b7fc4 257 /*************************************************************************************************/
dan_ackme 11:ea484e1b7fc4 258 WiconnectResult SocketInterface::unregisterSocketIrqHandler(Pin irqPin)
dan_ackme 11:ea484e1b7fc4 259 {
dan_ackme 11:ea484e1b7fc4 260 return irqHandlers.unregisterHandler(irqPin);
dan_ackme 11:ea484e1b7fc4 261 }