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@89:b1d417383c0d, 2016-04-19 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 19 18:20:38 2016 -0500
Revision:
89:b1d417383c0d
Parent:
81:1600369a29dd
Child:
90:0a988e4abb72
Adopt mbed style doxygen comments

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Christopher Haster 89:b1d417383c0d 1 /* Socket
Christopher Haster 89:b1d417383c0d 2 * Copyright (c) 2015 ARM Limited
Christopher Haster 89:b1d417383c0d 3 *
Christopher Haster 89:b1d417383c0d 4 * Licensed under the Apache License, Version 2.0 (the "License");
Christopher Haster 89:b1d417383c0d 5 * you may not use this file except in compliance with the License.
Christopher Haster 89:b1d417383c0d 6 * You may obtain a copy of the License at
Christopher Haster 89:b1d417383c0d 7 *
Christopher Haster 89:b1d417383c0d 8 * http://www.apache.org/licenses/LICENSE-2.0
Christopher Haster 89:b1d417383c0d 9 *
Christopher Haster 89:b1d417383c0d 10 * Unless required by applicable law or agreed to in writing, software
Christopher Haster 89:b1d417383c0d 11 * distributed under the License is distributed on an "AS IS" BASIS,
Christopher Haster 89:b1d417383c0d 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Christopher Haster 89:b1d417383c0d 13 * See the License for the specific language governing permissions and
Christopher Haster 89:b1d417383c0d 14 * limitations under the License.
Christopher Haster 89:b1d417383c0d 15 */
Christopher Haster 89:b1d417383c0d 16
Christopher Haster 89:b1d417383c0d 17 #ifndef TCPSERVER_H
Christopher Haster 89:b1d417383c0d 18 #define TCPSERVER_H
Christopher Haster 89:b1d417383c0d 19
Christopher Haster 89:b1d417383c0d 20 #include "Socket.h"
Christopher Haster 89:b1d417383c0d 21 #include "TCPSocket.h"
Christopher Haster 89:b1d417383c0d 22 #include "NetworkInterface.h"
Christopher Haster 89:b1d417383c0d 23
Christopher Haster 89:b1d417383c0d 24 /** TCP Server.
Christopher Haster 89:b1d417383c0d 25 */
Christopher Haster 89:b1d417383c0d 26 class TCPServer : public Socket {
Christopher Haster 89:b1d417383c0d 27 public:
Christopher Haster 89:b1d417383c0d 28 /** TCP Server lifetime
Christopher Haster 89:b1d417383c0d 29 */
Christopher Haster 89:b1d417383c0d 30 TCPServer(NetworkInterface *iface);
Christopher Haster 89:b1d417383c0d 31 virtual ~TCPServer();
Christopher Haster 89:b1d417383c0d 32
Christopher Haster 89:b1d417383c0d 33 /** Bind a socket to a specific port
Christopher Haster 89:b1d417383c0d 34 * @param port The port to listen for incoming connections on
Christopher Haster 89:b1d417383c0d 35 * @return 0 on success, negative on failure
Christopher Haster 89:b1d417383c0d 36 */
Christopher Haster 89:b1d417383c0d 37 int bind(uint16_t port);
Christopher Haster 89:b1d417383c0d 38
Christopher Haster 89:b1d417383c0d 39 /** Start listening for incoming connections
Christopher Haster 89:b1d417383c0d 40 * @param backlog Number of pending connections that can be queued up at any
Christopher Haster 89:b1d417383c0d 41 * one time [Default: 1]
Christopher Haster 89:b1d417383c0d 42 * @return 0 on success, negative on failure
Christopher Haster 89:b1d417383c0d 43 */
Christopher Haster 89:b1d417383c0d 44 int listen(int backlog=1);
Christopher Haster 89:b1d417383c0d 45
Christopher Haster 89:b1d417383c0d 46 /** Accept a new connection.
Christopher Haster 89:b1d417383c0d 47 * @param socket A TCPSocket instance that will handle the incoming connection.
Christopher Haster 89:b1d417383c0d 48 * @return 0 on success, negative on failure.
Christopher Haster 89:b1d417383c0d 49 */
Christopher Haster 89:b1d417383c0d 50 int accept(TCPSocket *connection);
Christopher Haster 89:b1d417383c0d 51
Christopher Haster 89:b1d417383c0d 52 /** Register a callback on when a new connection is ready
Christopher Haster 89:b1d417383c0d 53 * @param callback Function to call when accept will succeed, may be called in
Christopher Haster 89:b1d417383c0d 54 * interrupt context.
Christopher Haster 89:b1d417383c0d 55 */
Christopher Haster 89:b1d417383c0d 56 void attach_accept(FunctionPointer callback);
Christopher Haster 89:b1d417383c0d 57
Christopher Haster 89:b1d417383c0d 58 template <typename T, typename M>
Christopher Haster 89:b1d417383c0d 59 void attach_accept(T *tptr, M mptr) {
Christopher Haster 89:b1d417383c0d 60 attach_accept(FunctionPointer(tptr, mptr));
Christopher Haster 89:b1d417383c0d 61 }
Christopher Haster 89:b1d417383c0d 62
Christopher Haster 89:b1d417383c0d 63 private:
Christopher Haster 89:b1d417383c0d 64 FunctionPointer _accept_cb;
Christopher Haster 89:b1d417383c0d 65 };
Christopher Haster 89:b1d417383c0d 66
Christopher Haster 89:b1d417383c0d 67 #endif