Base class for IP Based Networking Libraries
Dependencies: DnsQuery
Dependents: TempTower BSDInterfaceTests HelloBSDInterface ESP8266InterfaceTests ... more
For a complete getting started guide see the wiki...
Network Socket API
The Network Socket API provides a common interface for using sockets on network devices. The API provides a simple class-based interface that should be familiar to users experienced with other socket APIs. Additionally, the API provides a simple interface for implementing network devices, making it easy to connect hardware agnostic programs to new devices.
Network Interfaces
The NetworkInterface provides an abstract class for network devices that support sockets. Devices should provide a DeviceInterface class that inherits this interface and adds implementation specific methods for using the device. A NetworkInterface must be provided to a Socket constructor to open a socket on the interface. Currently two subclasses are defined for common devices, EthernetInterface
and WiFiInterface.
Sockets
The Socket class is used for managing network sockets. Once opened, the socket provides a pipe through which data can sent and recieved to a specific endpoint. The socket class can be instantiated as either a TCPSocket
or a UDPSocket
which defines the protocol used for the connection.
Revision 72:6a8b52ee83ed, committed 2016-04-05
- Comitter:
- Christopher Haster
- Date:
- Tue Apr 05 05:40:43 2016 -0500
- Child:
- 73:968f7b32278f
- Commit message:
- Added initial design for user-facing API
Changed in this revision
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Socket.h Tue Apr 05 05:40:43 2016 -0500 @@ -0,0 +1,64 @@ +/* Copyright (C) 2012 mbed.org, MIT License + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of this software + * and associated documentation files (the "Software"), to deal in the Software without restriction, + * including without limitation the rights to use, copy, modify, merge, publish, distribute, + * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all copies or + * substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +#ifndef SOCKET_H +#define SOCKET_H + +/** Abstract socket class + */ +class Socket { +public: + /** Socket lifetime + */ + Socket(); + ~Socket(); + + /** Set blocking or non-blocking mode of the socket + \param blocking true for blocking mode, false for non-blocking mode. + */ + void set_blocking(bool blocking); + + /** Set timeout on a socket operation + \param timeout timeout in ms + */ + void set_timeout(unsigned int timeout); + + /** Set socket options + \param level stack level + \param optname option ID + \param optval option value + \param optlen length of the option value + \return 0 on success, negative on failure + */ + int set_option(int level, int optname, const void *optval, unsigned int optlen); + + /** Get socket options + \param level stack level + \param optname option ID + \param optval buffer pointer where to write the option value + \param socklen_t length of the option value + \return 0 on success, negative on failure + */ + int get_option(int level, int optname, void *optval, unsigned int *optlen); + + /** Close the socket + \param shutdown free the left-over data in message queues + */ + int close(bool shutdown=true); +}; + +#endif
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/TCPServer.h Tue Apr 05 05:40:43 2016 -0500 @@ -0,0 +1,53 @@ +/* Copyright (C) 2012 mbed.org, MIT License + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of this software + * and associated documentation files (the "Software"), to deal in the Software without restriction, + * including without limitation the rights to use, copy, modify, merge, publish, distribute, + * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all copies or + * substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +#ifndef TCPSERVER_H +#define TCPSERVER_H + +#include "Socket.h" +#include "TCPSocket.h" + +/** TCP Server. + */ +class TCPServer : public Socket { +public: + /** TCP Server lifetime + */ + TCPServer(); + ~TCPServer(); + + /** Bind a socket to a specific port + \param port The port to listen for incoming connections on + \return 0 on success, negative on failure + */ + int bind(int port); + + /** Start listening for incoming connections + \param backlog Number of pending connections that can be queued up at any + one time [Default: 1] + \return 0 on success, negative on failure + */ + int listen(int backlog=1); + + /** Accept a new connection. + \param socket A TCPSocket instance that will handle the incoming connection. + \return 0 on success, negative on failure. + */ + int accept(TCPSocket &connection); +}; + +#endif
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/TCPSocket.h Tue Apr 05 05:40:43 2016 -0500 @@ -0,0 +1,62 @@ +/* Copyright (C) 2012 mbed.org, MIT License + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of this software + * and associated documentation files (the "Software"), to deal in the Software without restriction, + * including without limitation the rights to use, copy, modify, merge, publish, distribute, + * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all copies or + * substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ + +#ifndef TCPSOCKET_H +#define TCPSOCKET_H + +#include "Socket.h" + +/** +TCP socket connection +*/ +class TCPSocket : public Socket { +public: + /** TCP socket lifetime + */ + TCPSocket(); + ~TCPSocket(); + + /** Connects this TCP socket to the server + \param host The host to connect to. It can either be an IP Address + or a hostname that will be resolved with DNS + \param port The host's port to connect to + \return 0 on success, negative on failure + */ + int connect(const char* host, const int port); + + /** Check if the socket is connected + \return true if connected, false otherwise + */ + bool is_connected(void); + + /** Send data to the remote host + \param data The buffer to send to the host + \param size The length of the buffer to send + \return Number of written bytes on success, negative on failure + */ + int send(const void *data, unsigned size); + + /** Receive data from the remote host + \param data The buffer in which to store the data received from the host + \param size The maximum length of the buffer + \return Number of received bytes on success, negative on failure + */ + int receive(void *data, unsigned size); +}; + +#endif
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/UDPSocket.h Tue Apr 05 05:40:43 2016 -0500 @@ -0,0 +1,60 @@ +/* Copyright (C) 2012 mbed.org, MIT License + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of this software + * and associated documentation files (the "Software"), to deal in the Software without restriction, + * including without limitation the rights to use, copy, modify, merge, publish, distribute, + * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all copies or + * substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ + +#ifndef UDPSOCKET_H +#define UDPSOCKET_H + +#include "Socket.h" + +/** +UDP Socket +*/ +class UDPSocket : public Socket { +public: + /** UDPSocket lifetime + */ + UDPSocket(); + ~UDPSocket(); + + /** Bind a UDP Server Socket to a specific port + \param port The port to listen for incoming connections on + \return 0 on success, negative on failure. + */ + int bind(int port); + + /** Send a packet to a remote endpoint + \param addr The remote IP address + \param remote The remote port + \param data The packet to be sent + \param size The length of the packet to be sent + \return the number of written bytes on success (>=0) or -1 on failure + */ + int sendto(const char *addr, uint16_t port, const void *data, unsigned size); + + /** Receive a packet from a remote endpoint + \param addr The remote IP address + \param buffer The buffer for storing the incoming packet data + If a packet is too long to fit in the supplied buffer, + excess bytes are discarded + \param size The length of the buffer + \return the number of received bytes on success, negative on failure + */ + int recvfrom(const char *addr, uint16_t port, void *buffer, unsigned size); +}; + +#endif