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/Socket/Socket.h@29:b6af04b77a56, 2014-10-27 (annotated)

Committer:
dan_ackme
Date:
Mon Oct 27 13:42:26 2014 -0700
Revision:
29:b6af04b77a56
Child:
32:b2bdbc018665
refactored library layout

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dan_ackme 29:b6af04b77a56 1 /* Copyright (C) 2012 mbed.org, MIT License
dan_ackme 29:b6af04b77a56 2 *
dan_ackme 29:b6af04b77a56 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
dan_ackme 29:b6af04b77a56 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
dan_ackme 29:b6af04b77a56 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
dan_ackme 29:b6af04b77a56 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
dan_ackme 29:b6af04b77a56 7 * furnished to do so, subject to the following conditions:
dan_ackme 29:b6af04b77a56 8 *
dan_ackme 29:b6af04b77a56 9 * The above copyright notice and this permission notice shall be included in all copies or
dan_ackme 29:b6af04b77a56 10 * substantial portions of the Software.
dan_ackme 29:b6af04b77a56 11 *
dan_ackme 29:b6af04b77a56 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
dan_ackme 29:b6af04b77a56 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
dan_ackme 29:b6af04b77a56 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
dan_ackme 29:b6af04b77a56 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
dan_ackme 29:b6af04b77a56 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
dan_ackme 29:b6af04b77a56 17 */
dan_ackme 29:b6af04b77a56 18 #ifndef SOCKET_H_
dan_ackme 29:b6af04b77a56 19 #define SOCKET_H_
dan_ackme 29:b6af04b77a56 20
dan_ackme 29:b6af04b77a56 21
dan_ackme 29:b6af04b77a56 22 #include "api/types/Socket/lwip/sockets.h"
dan_ackme 29:b6af04b77a56 23 #include "api/types/Socket/lwip/netdb.h"
dan_ackme 29:b6af04b77a56 24 #include "api/WiconnectTypes.h"
dan_ackme 29:b6af04b77a56 25 #include "api/types/WiconnectSocket.h"
dan_ackme 29:b6af04b77a56 26
dan_ackme 29:b6af04b77a56 27
dan_ackme 29:b6af04b77a56 28 using namespace wiconnect;
dan_ackme 29:b6af04b77a56 29
dan_ackme 29:b6af04b77a56 30
dan_ackme 29:b6af04b77a56 31 #define SOCKET_API_DEFAULT_RX_BUFFER_SIZE 128
dan_ackme 29:b6af04b77a56 32 #define SOCKET_API_DEFAULT_TX_BUFFER_SIZE 128
dan_ackme 29:b6af04b77a56 33
dan_ackme 29:b6af04b77a56 34
dan_ackme 29:b6af04b77a56 35 int gethostbyname_r(const char *name, struct hostent *ret, char *buf, size_t buflen, struct hostent **result, int *h_errnop);
dan_ackme 29:b6af04b77a56 36 struct hostent *gethostbyname(const char *name);
dan_ackme 29:b6af04b77a56 37
dan_ackme 29:b6af04b77a56 38
dan_ackme 29:b6af04b77a56 39
dan_ackme 29:b6af04b77a56 40
dan_ackme 29:b6af04b77a56 41 /** Socket file descriptor and select wrapper
dan_ackme 29:b6af04b77a56 42 */
dan_ackme 29:b6af04b77a56 43 class Socket {
dan_ackme 29:b6af04b77a56 44 public:
dan_ackme 29:b6af04b77a56 45 /** Socket
dan_ackme 29:b6af04b77a56 46 */
dan_ackme 29:b6af04b77a56 47 Socket();
dan_ackme 29:b6af04b77a56 48 Socket(int rxBufferLen, void *rxBuffer, int txBufferLen, void *txBuffer);
dan_ackme 29:b6af04b77a56 49
dan_ackme 29:b6af04b77a56 50 /** Set blocking or non-blocking mode of the socket and a timeout on
dan_ackme 29:b6af04b77a56 51 blocking socket operations
dan_ackme 29:b6af04b77a56 52
dan_ackme 29:b6af04b77a56 53 \note Currently the blocking/timeout functionality is only supported
dan_ackme 29:b6af04b77a56 54 for 'read' methods
dan_ackme 29:b6af04b77a56 55 \param blocking true for blocking mode, false for non-blocking mode.
dan_ackme 29:b6af04b77a56 56 \param timeout timeout in ms [Default: (1500)ms].
dan_ackme 29:b6af04b77a56 57 */
dan_ackme 29:b6af04b77a56 58 void set_blocking(bool blocking, unsigned int timeout=1500);
dan_ackme 29:b6af04b77a56 59
dan_ackme 29:b6af04b77a56 60 /** Set socket options
dan_ackme 29:b6af04b77a56 61 *
dan_ackme 29:b6af04b77a56 62 * \note NOT supported in this version.
dan_ackme 29:b6af04b77a56 63 *
dan_ackme 29:b6af04b77a56 64 \param level stack level (see: lwip/sockets.h)
dan_ackme 29:b6af04b77a56 65 \param optname option ID
dan_ackme 29:b6af04b77a56 66 \param optval option value
dan_ackme 29:b6af04b77a56 67 \param socklen_t length of the option value
dan_ackme 29:b6af04b77a56 68 \return 0 on success, -1 on failure
dan_ackme 29:b6af04b77a56 69 */
dan_ackme 29:b6af04b77a56 70 int set_option(int level, int optname, const void *optval, socklen_t optlen);
dan_ackme 29:b6af04b77a56 71
dan_ackme 29:b6af04b77a56 72 /** Get socket options
dan_ackme 29:b6af04b77a56 73 *
dan_ackme 29:b6af04b77a56 74 * \note NOT supported in this version.
dan_ackme 29:b6af04b77a56 75 *
dan_ackme 29:b6af04b77a56 76 \param level stack level (see: lwip/sockets.h)
dan_ackme 29:b6af04b77a56 77 \param optname option ID
dan_ackme 29:b6af04b77a56 78 \param optval buffer pointer where to write the option value
dan_ackme 29:b6af04b77a56 79 \param socklen_t length of the option value
dan_ackme 29:b6af04b77a56 80 \return 0 on success, -1 on failure
dan_ackme 29:b6af04b77a56 81 */
dan_ackme 29:b6af04b77a56 82 int get_option(int level, int optname, void *optval, socklen_t *optlen);
dan_ackme 29:b6af04b77a56 83
dan_ackme 29:b6af04b77a56 84 /** Close the socket
dan_ackme 29:b6af04b77a56 85 \param shutdown free the left-over data in message queues
dan_ackme 29:b6af04b77a56 86 */
dan_ackme 29:b6af04b77a56 87 int close(bool shutdown=true);
dan_ackme 29:b6af04b77a56 88
dan_ackme 29:b6af04b77a56 89 ~Socket();
dan_ackme 29:b6af04b77a56 90
dan_ackme 29:b6af04b77a56 91 protected:
dan_ackme 29:b6af04b77a56 92 bool _blocking;
dan_ackme 29:b6af04b77a56 93 unsigned int _timeout;
dan_ackme 29:b6af04b77a56 94
dan_ackme 29:b6af04b77a56 95 WiconnectSocket socket;
dan_ackme 29:b6af04b77a56 96 };
dan_ackme 29:b6af04b77a56 97
dan_ackme 29:b6af04b77a56 98 #endif /* SOCKET_H_ */