NetworkSocketAPI / NetworkSocketAPI

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.

TCPServer.h@77:b66a6984ed2d, 2016-04-05 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 05 09:16:47 2016 -0500
Revision:
77:b66a6984ed2d
Parent:
75:dea0cdb42241
Child:
78:0914f9b9b24b
Integrated interfaces as arguments to sockets

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Christopher Haster 72:6a8b52ee83ed 1 /* Copyright (C) 2012 mbed.org, MIT License
Christopher Haster 72:6a8b52ee83ed 2 *
Christopher Haster 72:6a8b52ee83ed 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
Christopher Haster 72:6a8b52ee83ed 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
Christopher Haster 72:6a8b52ee83ed 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
Christopher Haster 72:6a8b52ee83ed 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
Christopher Haster 72:6a8b52ee83ed 7 * furnished to do so, subject to the following conditions:
Christopher Haster 72:6a8b52ee83ed 8 *
Christopher Haster 72:6a8b52ee83ed 9 * The above copyright notice and this permission notice shall be included in all copies or
Christopher Haster 72:6a8b52ee83ed 10 * substantial portions of the Software.
Christopher Haster 72:6a8b52ee83ed 11 *
Christopher Haster 72:6a8b52ee83ed 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
Christopher Haster 72:6a8b52ee83ed 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Christopher Haster 72:6a8b52ee83ed 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
Christopher Haster 72:6a8b52ee83ed 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
Christopher Haster 72:6a8b52ee83ed 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Christopher Haster 72:6a8b52ee83ed 17 */
Christopher Haster 72:6a8b52ee83ed 18 #ifndef TCPSERVER_H
Christopher Haster 72:6a8b52ee83ed 19 #define TCPSERVER_H
Christopher Haster 72:6a8b52ee83ed 20
Christopher Haster 72:6a8b52ee83ed 21 #include "Socket.h"
Christopher Haster 72:6a8b52ee83ed 22 #include "TCPSocket.h"
Christopher Haster 77:b66a6984ed2d 23 #include "NetworkInterface.h"
Christopher Haster 72:6a8b52ee83ed 24
Christopher Haster 72:6a8b52ee83ed 25 /** TCP Server.
Christopher Haster 72:6a8b52ee83ed 26 */
Christopher Haster 72:6a8b52ee83ed 27 class TCPServer : public Socket {
Christopher Haster 72:6a8b52ee83ed 28 public:
Christopher Haster 72:6a8b52ee83ed 29 /** TCP Server lifetime
Christopher Haster 72:6a8b52ee83ed 30 */
Christopher Haster 77:b66a6984ed2d 31 TCPServer(NetworkInterface *iface);
Christopher Haster 72:6a8b52ee83ed 32 ~TCPServer();
Christopher Haster 72:6a8b52ee83ed 33
Christopher Haster 72:6a8b52ee83ed 34 /** Bind a socket to a specific port
Christopher Haster 72:6a8b52ee83ed 35 \param port The port to listen for incoming connections on
Christopher Haster 72:6a8b52ee83ed 36 \return 0 on success, negative on failure
Christopher Haster 72:6a8b52ee83ed 37 */
Christopher Haster 72:6a8b52ee83ed 38 int bind(int port);
Christopher Haster 72:6a8b52ee83ed 39
Christopher Haster 72:6a8b52ee83ed 40 /** Start listening for incoming connections
Christopher Haster 72:6a8b52ee83ed 41 \param backlog Number of pending connections that can be queued up at any
Christopher Haster 72:6a8b52ee83ed 42 one time [Default: 1]
Christopher Haster 72:6a8b52ee83ed 43 \return 0 on success, negative on failure
Christopher Haster 72:6a8b52ee83ed 44 */
Christopher Haster 72:6a8b52ee83ed 45 int listen(int backlog=1);
Christopher Haster 72:6a8b52ee83ed 46
Christopher Haster 72:6a8b52ee83ed 47 /** Accept a new connection.
Christopher Haster 72:6a8b52ee83ed 48 \param socket A TCPSocket instance that will handle the incoming connection.
Christopher Haster 72:6a8b52ee83ed 49 \return 0 on success, negative on failure.
Christopher Haster 72:6a8b52ee83ed 50 */
Christopher Haster 75:dea0cdb42241 51 int accept(TCPSocket *connection);
Christopher Haster 73:968f7b32278f 52
Christopher Haster 73:968f7b32278f 53 /** Register a callback on when a new connection is ready
Christopher Haster 73:968f7b32278f 54 \param callback Function to call when accept will succeed, may be called in
Christopher Haster 73:968f7b32278f 55 interrupt context.
Christopher Haster 73:968f7b32278f 56 */
Christopher Haster 73:968f7b32278f 57 void attach_accept(FuncPtr<void()> callback);
Christopher Haster 72:6a8b52ee83ed 58 };
Christopher Haster 72:6a8b52ee83ed 59
Christopher Haster 72:6a8b52ee83ed 60 #endif