Arlindo Montagnoli / Mbed 2 deprecated ProjetoBB

ProjetoBB

Dependencies:   F7_Ethernet WebSocketClient mbed mcp3008

Fork of Nucleo_F746ZG_Ethernet by Dieter Graef

F7_Ethernet/Socket/Socket.h@0:f9b6112278fe, 2016-06-18 (annotated)

Committer:
DieterGraef
Date:
Sat Jun 18 10:49:12 2016 +0000
Revision:
0:f9b6112278fe
Ethernet for the NUCLEO STM32F746 Board Testprogram uses DHCP and NTP to set the clock

Who changed what in which revision?

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