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.cpp@96:656011e49d9f, 2016-04-19 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 19 18:24:34 2016 -0500
Revision:
96:656011e49d9f
Parent:
93:65a9f84862f0
Child:
98:0f614f1d0398
Added better support for SocketAddress/string addresses/ports

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 #include "TCPServer.h"
Christopher Haster 89:b1d417383c0d 18 #include "Timer.h"
Christopher Haster 89:b1d417383c0d 19
Christopher Haster 90:0a988e4abb72 20 TCPServer::TCPServer()
Christopher Haster 90:0a988e4abb72 21 {
Christopher Haster 90:0a988e4abb72 22 }
Christopher Haster 90:0a988e4abb72 23
Christopher Haster 89:b1d417383c0d 24 TCPServer::TCPServer(NetworkInterface *iface)
Christopher Haster 89:b1d417383c0d 25 {
Christopher Haster 90:0a988e4abb72 26 open(iface);
Christopher Haster 90:0a988e4abb72 27 }
Christopher Haster 90:0a988e4abb72 28
Christopher Haster 90:0a988e4abb72 29 int TCPServer::open(NetworkInterface *iface)
Christopher Haster 90:0a988e4abb72 30 {
Christopher Haster 90:0a988e4abb72 31 return Socket::open(iface, NSAPI_TCP);
Christopher Haster 89:b1d417383c0d 32 }
Christopher Haster 89:b1d417383c0d 33
Christopher Haster 89:b1d417383c0d 34 int TCPServer::bind(uint16_t port)
Christopher Haster 89:b1d417383c0d 35 {
Christopher Haster 96:656011e49d9f 36 SocketAddress addr(0, port);
Christopher Haster 96:656011e49d9f 37 return bind(addr);
Christopher Haster 96:656011e49d9f 38 }
Christopher Haster 96:656011e49d9f 39
Christopher Haster 96:656011e49d9f 40 int TCPServer::bind(const char *address, uint16_t port)
Christopher Haster 96:656011e49d9f 41 {
Christopher Haster 96:656011e49d9f 42 SocketAddress addr(address, port);
Christopher Haster 96:656011e49d9f 43 return bind(addr);
Christopher Haster 96:656011e49d9f 44 }
Christopher Haster 96:656011e49d9f 45
Christopher Haster 96:656011e49d9f 46 int TCPServer::bind(const SocketAddress &address)
Christopher Haster 96:656011e49d9f 47 {
Christopher Haster 89:b1d417383c0d 48 if (!_socket) {
Christopher Haster 96:656011e49d9f 49 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 89:b1d417383c0d 50 }
Christopher Haster 89:b1d417383c0d 51
Christopher Haster 96:656011e49d9f 52 return _iface->socket_bind(_socket, address);
Christopher Haster 89:b1d417383c0d 53 }
Christopher Haster 89:b1d417383c0d 54
Christopher Haster 89:b1d417383c0d 55 int TCPServer::listen(int backlog)
Christopher Haster 89:b1d417383c0d 56 {
Christopher Haster 89:b1d417383c0d 57 if (!_socket) {
Christopher Haster 89:b1d417383c0d 58 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 89:b1d417383c0d 59 }
Christopher Haster 89:b1d417383c0d 60
Christopher Haster 89:b1d417383c0d 61 return _iface->socket_listen(_socket, backlog);
Christopher Haster 89:b1d417383c0d 62 }
Christopher Haster 89:b1d417383c0d 63
Christopher Haster 89:b1d417383c0d 64 int TCPServer::accept(TCPSocket *connection)
Christopher Haster 89:b1d417383c0d 65 {
Christopher Haster 89:b1d417383c0d 66 mbed::Timer timer;
Christopher Haster 89:b1d417383c0d 67 timer.start();
Christopher Haster 89:b1d417383c0d 68
Christopher Haster 90:0a988e4abb72 69 if (connection->_socket) {
Christopher Haster 90:0a988e4abb72 70 connection->close();
Christopher Haster 90:0a988e4abb72 71 }
Christopher Haster 89:b1d417383c0d 72
Christopher Haster 89:b1d417383c0d 73 while (true) {
Christopher Haster 89:b1d417383c0d 74 if (!_socket) {
Christopher Haster 89:b1d417383c0d 75 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 89:b1d417383c0d 76 }
Christopher Haster 89:b1d417383c0d 77
Christopher Haster 90:0a988e4abb72 78 void *socket;
Christopher Haster 93:65a9f84862f0 79 int err = _iface->socket_accept(&socket, _socket);
Christopher Haster 93:65a9f84862f0 80 if (!err) {
Christopher Haster 89:b1d417383c0d 81 connection->_socket = socket;
Christopher Haster 89:b1d417383c0d 82 }
Christopher Haster 89:b1d417383c0d 83
Christopher Haster 89:b1d417383c0d 84 if (err != NSAPI_ERROR_WOULD_BLOCK || !_blocking ||
Christopher Haster 89:b1d417383c0d 85 (_timeout && timer.read_ms() > _timeout)) {
Christopher Haster 89:b1d417383c0d 86 return err;
Christopher Haster 89:b1d417383c0d 87 }
Christopher Haster 89:b1d417383c0d 88 }
Christopher Haster 89:b1d417383c0d 89 }