fdsf
Dependents: sisk_proj_stat MQTT Hello_FXOS8700Q WireFSHandControl ... more
Socket/Socket.h@0:d7bd7384a37c, 2016-12-07 (annotated)
- Committer:
- grzemich
- Date:
- Wed Dec 07 23:47:50 2016 +0000
- Revision:
- 0:d7bd7384a37c
dgd
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
grzemich | 0:d7bd7384a37c | 1 | /* Copyright (C) 2012 mbed.org, MIT License |
grzemich | 0:d7bd7384a37c | 2 | * |
grzemich | 0:d7bd7384a37c | 3 | * Permission is hereby granted, free of charge, to any person obtaining a copy of this software |
grzemich | 0:d7bd7384a37c | 4 | * and associated documentation files (the "Software"), to deal in the Software without restriction, |
grzemich | 0:d7bd7384a37c | 5 | * including without limitation the rights to use, copy, modify, merge, publish, distribute, |
grzemich | 0:d7bd7384a37c | 6 | * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is |
grzemich | 0:d7bd7384a37c | 7 | * furnished to do so, subject to the following conditions: |
grzemich | 0:d7bd7384a37c | 8 | * |
grzemich | 0:d7bd7384a37c | 9 | * The above copyright notice and this permission notice shall be included in all copies or |
grzemich | 0:d7bd7384a37c | 10 | * substantial portions of the Software. |
grzemich | 0:d7bd7384a37c | 11 | * |
grzemich | 0:d7bd7384a37c | 12 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING |
grzemich | 0:d7bd7384a37c | 13 | * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
grzemich | 0:d7bd7384a37c | 14 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, |
grzemich | 0:d7bd7384a37c | 15 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
grzemich | 0:d7bd7384a37c | 16 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
grzemich | 0:d7bd7384a37c | 17 | */ |
grzemich | 0:d7bd7384a37c | 18 | #ifndef SOCKET_H_ |
grzemich | 0:d7bd7384a37c | 19 | #define SOCKET_H_ |
grzemich | 0:d7bd7384a37c | 20 | |
grzemich | 0:d7bd7384a37c | 21 | #include "lwip/sockets.h" |
grzemich | 0:d7bd7384a37c | 22 | #include "lwip/netdb.h" |
grzemich | 0:d7bd7384a37c | 23 | |
grzemich | 0:d7bd7384a37c | 24 | //DNS |
grzemich | 0:d7bd7384a37c | 25 | inline struct hostent *gethostbyname(const char *name) { |
grzemich | 0:d7bd7384a37c | 26 | return lwip_gethostbyname(name); |
grzemich | 0:d7bd7384a37c | 27 | } |
grzemich | 0:d7bd7384a37c | 28 | |
grzemich | 0:d7bd7384a37c | 29 | inline int gethostbyname_r(const char *name, struct hostent *ret, char *buf, size_t buflen, struct hostent **result, int *h_errnop) { |
grzemich | 0:d7bd7384a37c | 30 | return lwip_gethostbyname_r(name, ret, buf, buflen, result, h_errnop); |
grzemich | 0:d7bd7384a37c | 31 | } |
grzemich | 0:d7bd7384a37c | 32 | |
grzemich | 0:d7bd7384a37c | 33 | class TimeInterval; |
grzemich | 0:d7bd7384a37c | 34 | |
grzemich | 0:d7bd7384a37c | 35 | /** Socket file descriptor and select wrapper |
grzemich | 0:d7bd7384a37c | 36 | */ |
grzemich | 0:d7bd7384a37c | 37 | class Socket { |
grzemich | 0:d7bd7384a37c | 38 | public: |
grzemich | 0:d7bd7384a37c | 39 | /** Socket |
grzemich | 0:d7bd7384a37c | 40 | */ |
grzemich | 0:d7bd7384a37c | 41 | Socket(); |
grzemich | 0:d7bd7384a37c | 42 | |
grzemich | 0:d7bd7384a37c | 43 | /** Set blocking or non-blocking mode of the socket and a timeout on |
grzemich | 0:d7bd7384a37c | 44 | blocking socket operations |
grzemich | 0:d7bd7384a37c | 45 | \param blocking true for blocking mode, false for non-blocking mode. |
grzemich | 0:d7bd7384a37c | 46 | \param timeout timeout in ms [Default: (1500)ms]. |
grzemich | 0:d7bd7384a37c | 47 | */ |
grzemich | 0:d7bd7384a37c | 48 | void set_blocking(bool blocking, unsigned int timeout=1500); |
grzemich | 0:d7bd7384a37c | 49 | |
grzemich | 0:d7bd7384a37c | 50 | /** Set socket options |
grzemich | 0:d7bd7384a37c | 51 | \param level stack level (see: lwip/sockets.h) |
grzemich | 0:d7bd7384a37c | 52 | \param optname option ID |
grzemich | 0:d7bd7384a37c | 53 | \param optval option value |
grzemich | 0:d7bd7384a37c | 54 | \param socklen_t length of the option value |
grzemich | 0:d7bd7384a37c | 55 | \return 0 on success, -1 on failure |
grzemich | 0:d7bd7384a37c | 56 | */ |
grzemich | 0:d7bd7384a37c | 57 | int set_option(int level, int optname, const void *optval, socklen_t optlen); |
grzemich | 0:d7bd7384a37c | 58 | |
grzemich | 0:d7bd7384a37c | 59 | /** Get socket options |
grzemich | 0:d7bd7384a37c | 60 | \param level stack level (see: lwip/sockets.h) |
grzemich | 0:d7bd7384a37c | 61 | \param optname option ID |
grzemich | 0:d7bd7384a37c | 62 | \param optval buffer pointer where to write the option value |
grzemich | 0:d7bd7384a37c | 63 | \param socklen_t length of the option value |
grzemich | 0:d7bd7384a37c | 64 | \return 0 on success, -1 on failure |
grzemich | 0:d7bd7384a37c | 65 | */ |
grzemich | 0:d7bd7384a37c | 66 | int get_option(int level, int optname, void *optval, socklen_t *optlen); |
grzemich | 0:d7bd7384a37c | 67 | |
grzemich | 0:d7bd7384a37c | 68 | /** Close the socket |
grzemich | 0:d7bd7384a37c | 69 | \param shutdown free the left-over data in message queues |
grzemich | 0:d7bd7384a37c | 70 | */ |
grzemich | 0:d7bd7384a37c | 71 | int close(bool shutdown=true); |
grzemich | 0:d7bd7384a37c | 72 | |
grzemich | 0:d7bd7384a37c | 73 | ~Socket(); |
grzemich | 0:d7bd7384a37c | 74 | |
grzemich | 0:d7bd7384a37c | 75 | protected: |
grzemich | 0:d7bd7384a37c | 76 | int _sock_fd; |
grzemich | 0:d7bd7384a37c | 77 | int init_socket(int type); |
grzemich | 0:d7bd7384a37c | 78 | |
grzemich | 0:d7bd7384a37c | 79 | int wait_readable(TimeInterval& timeout); |
grzemich | 0:d7bd7384a37c | 80 | int wait_writable(TimeInterval& timeout); |
grzemich | 0:d7bd7384a37c | 81 | |
grzemich | 0:d7bd7384a37c | 82 | bool _blocking; |
grzemich | 0:d7bd7384a37c | 83 | unsigned int _timeout; |
grzemich | 0:d7bd7384a37c | 84 | |
grzemich | 0:d7bd7384a37c | 85 | private: |
grzemich | 0:d7bd7384a37c | 86 | int select(struct timeval *timeout, bool read, bool write); |
grzemich | 0:d7bd7384a37c | 87 | }; |
grzemich | 0:d7bd7384a37c | 88 | |
grzemich | 0:d7bd7384a37c | 89 | /** Time interval class used to specify timeouts |
grzemich | 0:d7bd7384a37c | 90 | */ |
grzemich | 0:d7bd7384a37c | 91 | class TimeInterval { |
grzemich | 0:d7bd7384a37c | 92 | friend class Socket; |
grzemich | 0:d7bd7384a37c | 93 | |
grzemich | 0:d7bd7384a37c | 94 | public: |
grzemich | 0:d7bd7384a37c | 95 | /** Time Interval |
grzemich | 0:d7bd7384a37c | 96 | \param ms time interval expressed in milliseconds |
grzemich | 0:d7bd7384a37c | 97 | */ |
grzemich | 0:d7bd7384a37c | 98 | TimeInterval(unsigned int ms); |
grzemich | 0:d7bd7384a37c | 99 | |
grzemich | 0:d7bd7384a37c | 100 | private: |
grzemich | 0:d7bd7384a37c | 101 | struct timeval _time; |
grzemich | 0:d7bd7384a37c | 102 | }; |
grzemich | 0:d7bd7384a37c | 103 | |
grzemich | 0:d7bd7384a37c | 104 | #endif /* SOCKET_H_ */ |