SNIC UART Interface library for Murata Type-YD module
Dependents: WebSocketServerTest
Fork of SNICInterface_mod by
Socket/Socket.h@41:1c1b5ad4d491, 2014-07-15 (annotated)
- Committer:
- kishino
- Date:
- Tue Jul 15 10:13:53 2014 +0000
- Revision:
- 41:1c1b5ad4d491
- Parent:
- 39:a1233ca02edf
- Child:
- 46:e1cb45f7a27f
Modified the module name of Copyright.
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
kishino | 20:dd736d328de6 | 1 | /* Copyright (C) 2012 mbed.org, MIT License |
kishino | 20:dd736d328de6 | 2 | * |
kishino | 20:dd736d328de6 | 3 | * Permission is hereby granted, free of charge, to any person obtaining a copy of this software |
kishino | 20:dd736d328de6 | 4 | * and associated documentation files (the "Software"), to deal in the Software without restriction, |
kishino | 20:dd736d328de6 | 5 | * including without limitation the rights to use, copy, modify, merge, publish, distribute, |
kishino | 20:dd736d328de6 | 6 | * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is |
kishino | 20:dd736d328de6 | 7 | * furnished to do so, subject to the following conditions: |
kishino | 20:dd736d328de6 | 8 | * |
kishino | 20:dd736d328de6 | 9 | * The above copyright notice and this permission notice shall be included in all copies or |
kishino | 20:dd736d328de6 | 10 | * substantial portions of the Software. |
kishino | 20:dd736d328de6 | 11 | * |
kishino | 20:dd736d328de6 | 12 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING |
kishino | 20:dd736d328de6 | 13 | * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
kishino | 20:dd736d328de6 | 14 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, |
kishino | 20:dd736d328de6 | 15 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
kishino | 20:dd736d328de6 | 16 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
kishino | 20:dd736d328de6 | 17 | */ |
kishino | 39:a1233ca02edf | 18 | /* Copyright (C) 2014 Murata Manufacturing Co.,Ltd., MIT License |
kishino | 41:1c1b5ad4d491 | 19 | * port to the muRata, SWITCH SCIENCE Wi-FI module TypeYD SNIC-UART. |
kishino | 39:a1233ca02edf | 20 | */ |
kishino | 20:dd736d328de6 | 21 | #ifndef SOCKET_H_ |
kishino | 20:dd736d328de6 | 22 | #define SOCKET_H_ |
kishino | 20:dd736d328de6 | 23 | |
kishino | 20:dd736d328de6 | 24 | #include "SNIC_Core.h" |
kishino | 20:dd736d328de6 | 25 | #include "SNIC_UartMsgUtil.h" |
kishino | 20:dd736d328de6 | 26 | |
kishino | 20:dd736d328de6 | 27 | typedef unsigned long socklen_t; |
kishino | 20:dd736d328de6 | 28 | |
kishino | 20:dd736d328de6 | 29 | /** Socket file descriptor and select wrapper |
kishino | 20:dd736d328de6 | 30 | */ |
kishino | 29:6a0ba999597d | 31 | class Socket { |
kishino | 20:dd736d328de6 | 32 | public: |
kishino | 20:dd736d328de6 | 33 | /** Socket |
kishino | 20:dd736d328de6 | 34 | */ |
kishino | 20:dd736d328de6 | 35 | Socket(); |
kishino | 20:dd736d328de6 | 36 | |
kishino | 29:6a0ba999597d | 37 | /** Set blocking or non-blocking mode of the socket and a timeout on |
kishino | 29:6a0ba999597d | 38 | blocking socket operations |
kishino | 29:6a0ba999597d | 39 | \param blocking true for blocking mode, false for non-blocking mode. |
kishino | 29:6a0ba999597d | 40 | \param timeout timeout in ms [Default: (1500)ms]. |
kishino | 29:6a0ba999597d | 41 | */ |
kishino | 29:6a0ba999597d | 42 | void set_blocking(bool blocking, unsigned int timeout=1500); |
kishino | 29:6a0ba999597d | 43 | |
kishino | 20:dd736d328de6 | 44 | /** Set socket options |
kishino | 20:dd736d328de6 | 45 | @param level stack level (see: lwip/sockets.h) |
kishino | 20:dd736d328de6 | 46 | @param optname option ID |
kishino | 20:dd736d328de6 | 47 | @param optval option value |
kishino | 20:dd736d328de6 | 48 | @param socklen_t length of the option value |
kishino | 20:dd736d328de6 | 49 | @return 0 on success, -1 on failure |
kishino | 20:dd736d328de6 | 50 | */ |
kishino | 20:dd736d328de6 | 51 | int set_option(int level, int optname, const void *optval, socklen_t optlen); |
kishino | 20:dd736d328de6 | 52 | |
kishino | 20:dd736d328de6 | 53 | /** Get socket options |
kishino | 20:dd736d328de6 | 54 | @param level stack level (see: lwip/sockets.h) |
kishino | 20:dd736d328de6 | 55 | @param optname option ID |
kishino | 20:dd736d328de6 | 56 | \param optval buffer pointer where to write the option value |
kishino | 20:dd736d328de6 | 57 | \param socklen_t length of the option value |
kishino | 20:dd736d328de6 | 58 | \return 0 on success, -1 on failure |
kishino | 20:dd736d328de6 | 59 | */ |
kishino | 20:dd736d328de6 | 60 | int get_option(int level, int optname, void *optval, socklen_t *optlen); |
kishino | 20:dd736d328de6 | 61 | |
kishino | 20:dd736d328de6 | 62 | /** Close the socket |
kishino | 20:dd736d328de6 | 63 | \param shutdown free the left-over data in message queues |
kishino | 20:dd736d328de6 | 64 | */ |
kishino | 20:dd736d328de6 | 65 | int close(bool shutdown=true); |
kishino | 20:dd736d328de6 | 66 | |
kishino | 26:f2e1030964e4 | 67 | virtual ~Socket(); |
kishino | 20:dd736d328de6 | 68 | |
kishino | 20:dd736d328de6 | 69 | int createSocket( unsigned char bind = 0, unsigned int local_addr = 0, unsigned short port = 0 ); |
kishino | 20:dd736d328de6 | 70 | |
kishino | 20:dd736d328de6 | 71 | protected: |
kishino | 29:6a0ba999597d | 72 | int resolveHostName( const char *host_p ); |
kishino | 29:6a0ba999597d | 73 | |
kishino | 27:dcc4f34448f0 | 74 | protected: |
kishino | 29:6a0ba999597d | 75 | int mSocketID; |
kishino | 20:dd736d328de6 | 76 | bool _blocking; |
kishino | 20:dd736d328de6 | 77 | int _timeout; |
kishino | 33:33f1bc919486 | 78 | char *getSocketSendBuf(); |
kishino | 33:33f1bc919486 | 79 | |
kishino | 20:dd736d328de6 | 80 | private: |
kishino | 20:dd736d328de6 | 81 | |
kishino | 20:dd736d328de6 | 82 | // int select(struct timeval *timeout, bool read, bool write); |
kishino | 20:dd736d328de6 | 83 | }; |
kishino | 20:dd736d328de6 | 84 | |
kishino | 20:dd736d328de6 | 85 | #endif /* SOCKET_H_ */ |