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@78:0914f9b9b24b, 2016-04-05 (annotated)
- Committer:
- Christopher Haster
- Date:
- Tue Apr 05 09:20:32 2016 -0500
- Revision:
- 78:0914f9b9b24b
- Parent:
- 77:b66a6984ed2d
- Child:
- 79:43a7e8c0d6cc
Dragged over license from nsapi
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Christopher Haster |
78:0914f9b9b24b | 1 | /* Socket |
Christopher Haster |
78:0914f9b9b24b | 2 | * Copyright (c) 2015 ARM Limited |
Christopher Haster |
72:6a8b52ee83ed | 3 | * |
Christopher Haster |
78:0914f9b9b24b | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
Christopher Haster |
78:0914f9b9b24b | 5 | * you may not use this file except in compliance with the License. |
Christopher Haster |
78:0914f9b9b24b | 6 | * You may obtain a copy of the License at |
Christopher Haster |
72:6a8b52ee83ed | 7 | * |
Christopher Haster |
78:0914f9b9b24b | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
Christopher Haster |
72:6a8b52ee83ed | 9 | * |
Christopher Haster |
78:0914f9b9b24b | 10 | * Unless required by applicable law or agreed to in writing, software |
Christopher Haster |
78:0914f9b9b24b | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
Christopher Haster |
78:0914f9b9b24b | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
Christopher Haster |
78:0914f9b9b24b | 13 | * See the License for the specific language governing permissions and |
Christopher Haster |
78:0914f9b9b24b | 14 | * limitations under the License. |
Christopher Haster |
72:6a8b52ee83ed | 15 | */ |
Christopher Haster |
78:0914f9b9b24b | 16 | |
Christopher Haster |
72:6a8b52ee83ed | 17 | #ifndef TCPSERVER_H |
Christopher Haster |
72:6a8b52ee83ed | 18 | #define TCPSERVER_H |
Christopher Haster |
72:6a8b52ee83ed | 19 | |
Christopher Haster |
72:6a8b52ee83ed | 20 | #include "Socket.h" |
Christopher Haster |
72:6a8b52ee83ed | 21 | #include "TCPSocket.h" |
Christopher Haster |
77:b66a6984ed2d | 22 | #include "NetworkInterface.h" |
Christopher Haster |
72:6a8b52ee83ed | 23 | |
Christopher Haster |
72:6a8b52ee83ed | 24 | /** TCP Server. |
Christopher Haster |
72:6a8b52ee83ed | 25 | */ |
Christopher Haster |
72:6a8b52ee83ed | 26 | class TCPServer : public Socket { |
Christopher Haster |
72:6a8b52ee83ed | 27 | public: |
Christopher Haster |
72:6a8b52ee83ed | 28 | /** TCP Server lifetime |
Christopher Haster |
72:6a8b52ee83ed | 29 | */ |
Christopher Haster |
77:b66a6984ed2d | 30 | TCPServer(NetworkInterface *iface); |
Christopher Haster |
72:6a8b52ee83ed | 31 | ~TCPServer(); |
Christopher Haster |
72:6a8b52ee83ed | 32 | |
Christopher Haster |
72:6a8b52ee83ed | 33 | /** Bind a socket to a specific port |
Christopher Haster |
72:6a8b52ee83ed | 34 | \param port The port to listen for incoming connections on |
Christopher Haster |
72:6a8b52ee83ed | 35 | \return 0 on success, negative on failure |
Christopher Haster |
72:6a8b52ee83ed | 36 | */ |
Christopher Haster |
72:6a8b52ee83ed | 37 | int bind(int port); |
Christopher Haster |
72:6a8b52ee83ed | 38 | |
Christopher Haster |
72:6a8b52ee83ed | 39 | /** Start listening for incoming connections |
Christopher Haster |
72:6a8b52ee83ed | 40 | \param backlog Number of pending connections that can be queued up at any |
Christopher Haster |
72:6a8b52ee83ed | 41 | one time [Default: 1] |
Christopher Haster |
72:6a8b52ee83ed | 42 | \return 0 on success, negative on failure |
Christopher Haster |
72:6a8b52ee83ed | 43 | */ |
Christopher Haster |
72:6a8b52ee83ed | 44 | int listen(int backlog=1); |
Christopher Haster |
72:6a8b52ee83ed | 45 | |
Christopher Haster |
72:6a8b52ee83ed | 46 | /** Accept a new connection. |
Christopher Haster |
72:6a8b52ee83ed | 47 | \param socket A TCPSocket instance that will handle the incoming connection. |
Christopher Haster |
72:6a8b52ee83ed | 48 | \return 0 on success, negative on failure. |
Christopher Haster |
72:6a8b52ee83ed | 49 | */ |
Christopher Haster |
75:dea0cdb42241 | 50 | int accept(TCPSocket *connection); |
Christopher Haster |
73:968f7b32278f | 51 | |
Christopher Haster |
73:968f7b32278f | 52 | /** Register a callback on when a new connection is ready |
Christopher Haster |
73:968f7b32278f | 53 | \param callback Function to call when accept will succeed, may be called in |
Christopher Haster |
73:968f7b32278f | 54 | interrupt context. |
Christopher Haster |
73:968f7b32278f | 55 | */ |
Christopher Haster |
73:968f7b32278f | 56 | void attach_accept(FuncPtr<void()> callback); |
Christopher Haster |
72:6a8b52ee83ed | 57 | }; |
Christopher Haster |
72:6a8b52ee83ed | 58 | |
Christopher Haster |
72:6a8b52ee83ed | 59 | #endif |