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

Committer:
Christopher Haster
Date:
Tue Apr 19 18:20:38 2016 -0500
Revision:
89:b1d417383c0d
Parent:
87:94e2cf3a06be
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 #include "TCPServer.h"
Christopher Haster 89:b1d417383c0d 18 #include "Timer.h"
Christopher Haster 89:b1d417383c0d 19
Christopher Haster 89:b1d417383c0d 20 TCPServer::TCPServer(NetworkInterface *iface)
Christopher Haster 89:b1d417383c0d 21 : Socket(iface, NSAPI_TCP)
Christopher Haster 89:b1d417383c0d 22 {
Christopher Haster 89:b1d417383c0d 23 }
Christopher Haster 89:b1d417383c0d 24
Christopher Haster 89:b1d417383c0d 25 int TCPServer::bind(uint16_t port)
Christopher Haster 89:b1d417383c0d 26 {
Christopher Haster 89:b1d417383c0d 27 if (!_socket) {
Christopher Haster 89:b1d417383c0d 28 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 89:b1d417383c0d 29 }
Christopher Haster 89:b1d417383c0d 30
Christopher Haster 89:b1d417383c0d 31 return _iface->socket_bind(_socket, port);
Christopher Haster 89:b1d417383c0d 32 }
Christopher Haster 89:b1d417383c0d 33
Christopher Haster 89:b1d417383c0d 34 int TCPServer::listen(int backlog)
Christopher Haster 89:b1d417383c0d 35 {
Christopher Haster 89:b1d417383c0d 36 if (!_socket) {
Christopher Haster 89:b1d417383c0d 37 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 89:b1d417383c0d 38 }
Christopher Haster 89:b1d417383c0d 39
Christopher Haster 89:b1d417383c0d 40 return _iface->socket_listen(_socket, backlog);
Christopher Haster 89:b1d417383c0d 41 }
Christopher Haster 89:b1d417383c0d 42
Christopher Haster 89:b1d417383c0d 43 int TCPServer::accept(TCPSocket *connection)
Christopher Haster 89:b1d417383c0d 44 {
Christopher Haster 89:b1d417383c0d 45 mbed::Timer timer;
Christopher Haster 89:b1d417383c0d 46 timer.start();
Christopher Haster 89:b1d417383c0d 47
Christopher Haster 89:b1d417383c0d 48 void *socket = connection->_socket;
Christopher Haster 89:b1d417383c0d 49 connection->_socket = 0;
Christopher Haster 89:b1d417383c0d 50 _iface->socket_destroy(socket);
Christopher Haster 89:b1d417383c0d 51
Christopher Haster 89:b1d417383c0d 52 while (true) {
Christopher Haster 89:b1d417383c0d 53 if (!_socket) {
Christopher Haster 89:b1d417383c0d 54 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 89:b1d417383c0d 55 }
Christopher Haster 89:b1d417383c0d 56
Christopher Haster 89:b1d417383c0d 57 int err = _iface->socket_accept(_socket, &socket);
Christopher Haster 89:b1d417383c0d 58
Christopher Haster 89:b1d417383c0d 59 if (err > 0) {
Christopher Haster 89:b1d417383c0d 60 connection->_socket = socket;
Christopher Haster 89:b1d417383c0d 61 }
Christopher Haster 89:b1d417383c0d 62
Christopher Haster 89:b1d417383c0d 63 if (err != NSAPI_ERROR_WOULD_BLOCK || !_blocking ||
Christopher Haster 89:b1d417383c0d 64 (_timeout && timer.read_ms() > _timeout)) {
Christopher Haster 89:b1d417383c0d 65 return err;
Christopher Haster 89:b1d417383c0d 66 }
Christopher Haster 89:b1d417383c0d 67 }
Christopher Haster 89:b1d417383c0d 68 }
Christopher Haster 89:b1d417383c0d 69
Christopher Haster 89:b1d417383c0d 70
Christopher Haster 89:b1d417383c0d 71 void TCPServer::attach_accept(FunctionPointer callback)
Christopher Haster 89:b1d417383c0d 72 {
Christopher Haster 89:b1d417383c0d 73 _accept_cb = callback;
Christopher Haster 89:b1d417383c0d 74
Christopher Haster 89:b1d417383c0d 75 if (_socket && _accept_cb) {
Christopher Haster 89:b1d417383c0d 76 return _iface->socket_attach_accept(_socket, Socket::thunk, &_accept_cb);
Christopher Haster 89:b1d417383c0d 77 } else if (_socket) {
Christopher Haster 89:b1d417383c0d 78 return _iface->socket_attach_accept(_socket, 0, 0);
Christopher Haster 89:b1d417383c0d 79 }
Christopher Haster 89:b1d417383c0d 80 }
Christopher Haster 89:b1d417383c0d 81
Christopher Haster 89:b1d417383c0d 82 TCPServer::~TCPServer()
Christopher Haster 89:b1d417383c0d 83 {
Christopher Haster 89:b1d417383c0d 84 if (_socket && _accept_cb) {
Christopher Haster 89:b1d417383c0d 85 _iface->socket_attach_accept(_socket, 0, 0);
Christopher Haster 89:b1d417383c0d 86 }
Christopher Haster 89:b1d417383c0d 87 }