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.

UDPSocket.cpp@92:dd5f19874adf, 2016-04-19 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 19 18:23:29 2016 -0500
Revision:
92:dd5f19874adf
Parent:
90:0a988e4abb72
Child:
96:656011e49d9f
Move to single state-change interrupt



Pros

- Easier to implement

- More similar to SIGIO in BDS sockets



Cons

- Less information, but this information had a high risk of being

  faulty/spurious

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Christopher Haster 79:43a7e8c0d6cc 1 /* Socket
Christopher Haster 79:43a7e8c0d6cc 2 * Copyright (c) 2015 ARM Limited
Christopher Haster 79:43a7e8c0d6cc 3 *
Christopher Haster 79:43a7e8c0d6cc 4 * Licensed under the Apache License, Version 2.0 (the "License");
Christopher Haster 79:43a7e8c0d6cc 5 * you may not use this file except in compliance with the License.
Christopher Haster 79:43a7e8c0d6cc 6 * You may obtain a copy of the License at
Christopher Haster 79:43a7e8c0d6cc 7 *
Christopher Haster 79:43a7e8c0d6cc 8 * http://www.apache.org/licenses/LICENSE-2.0
Christopher Haster 79:43a7e8c0d6cc 9 *
Christopher Haster 79:43a7e8c0d6cc 10 * Unless required by applicable law or agreed to in writing, software
Christopher Haster 79:43a7e8c0d6cc 11 * distributed under the License is distributed on an "AS IS" BASIS,
Christopher Haster 79:43a7e8c0d6cc 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Christopher Haster 79:43a7e8c0d6cc 13 * See the License for the specific language governing permissions and
Christopher Haster 79:43a7e8c0d6cc 14 * limitations under the License.
Christopher Haster 79:43a7e8c0d6cc 15 */
Christopher Haster 79:43a7e8c0d6cc 16
Christopher Haster 79:43a7e8c0d6cc 17 #include "UDPSocket.h"
Christopher Haster 82:97d166c4a193 18 #include "Timer.h"
Christopher Haster 79:43a7e8c0d6cc 19
Christopher Haster 90:0a988e4abb72 20 UDPSocket::UDPSocket()
Christopher Haster 90:0a988e4abb72 21 {
Christopher Haster 90:0a988e4abb72 22 }
Christopher Haster 90:0a988e4abb72 23
Christopher Haster 79:43a7e8c0d6cc 24 UDPSocket::UDPSocket(NetworkInterface *iface)
Christopher Haster 79:43a7e8c0d6cc 25 {
Christopher Haster 90:0a988e4abb72 26 open(iface);
Christopher Haster 90:0a988e4abb72 27 }
Christopher Haster 90:0a988e4abb72 28
Christopher Haster 90:0a988e4abb72 29 int UDPSocket::open(NetworkInterface *iface)
Christopher Haster 90:0a988e4abb72 30 {
Christopher Haster 90:0a988e4abb72 31 return Socket::open(iface, NSAPI_UDP);
Christopher Haster 79:43a7e8c0d6cc 32 }
Christopher Haster 79:43a7e8c0d6cc 33
Christopher Haster 79:43a7e8c0d6cc 34 int UDPSocket::bind(uint16_t port)
Christopher Haster 79:43a7e8c0d6cc 35 {
Christopher Haster 79:43a7e8c0d6cc 36 if (!_socket) {
geky 86:7ca9776b9cc0 37 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 79:43a7e8c0d6cc 38 }
Christopher Haster 79:43a7e8c0d6cc 39
Christopher Haster 79:43a7e8c0d6cc 40 return _iface->socket_bind(_socket, port);
Christopher Haster 79:43a7e8c0d6cc 41 }
Christopher Haster 79:43a7e8c0d6cc 42
Christopher Haster 80:9c6673c93082 43 int UDPSocket::sendto(const SocketAddress &address, const void *data, unsigned size)
Christopher Haster 79:43a7e8c0d6cc 44 {
Christopher Haster 82:97d166c4a193 45 mbed::Timer timer;
Christopher Haster 82:97d166c4a193 46 timer.start();
Christopher Haster 82:97d166c4a193 47
Christopher Haster 82:97d166c4a193 48 while (true) {
Christopher Haster 82:97d166c4a193 49 if (!_socket) {
Christopher Haster 82:97d166c4a193 50 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 82:97d166c4a193 51 }
Christopher Haster 82:97d166c4a193 52
Christopher Haster 82:97d166c4a193 53 int sent = _iface->socket_sendto(_socket, address, data, size);
Christopher Haster 82:97d166c4a193 54 if (sent != NSAPI_ERROR_WOULD_BLOCK || !_blocking ||
Christopher Haster 82:97d166c4a193 55 (_timeout && timer.read_ms() > _timeout)) {
Christopher Haster 82:97d166c4a193 56 return sent;
Christopher Haster 82:97d166c4a193 57 }
Christopher Haster 79:43a7e8c0d6cc 58 }
Christopher Haster 79:43a7e8c0d6cc 59 }
Christopher Haster 79:43a7e8c0d6cc 60
Christopher Haster 79:43a7e8c0d6cc 61 int UDPSocket::recvfrom(SocketAddress *address, void *buffer, unsigned size)
Christopher Haster 79:43a7e8c0d6cc 62 {
Christopher Haster 82:97d166c4a193 63 mbed::Timer timer;
Christopher Haster 82:97d166c4a193 64 timer.start();
Christopher Haster 82:97d166c4a193 65
Christopher Haster 82:97d166c4a193 66 while (true) {
Christopher Haster 82:97d166c4a193 67 if (!_socket) {
Christopher Haster 82:97d166c4a193 68 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 82:97d166c4a193 69 }
Christopher Haster 82:97d166c4a193 70
Christopher Haster 82:97d166c4a193 71 int recv = _iface->socket_recvfrom(_socket, address, buffer, size);
Christopher Haster 82:97d166c4a193 72 if (recv != NSAPI_ERROR_WOULD_BLOCK || !_blocking ||
Christopher Haster 82:97d166c4a193 73 (_timeout && timer.read_ms() > _timeout)) {
Christopher Haster 82:97d166c4a193 74 return recv;
Christopher Haster 82:97d166c4a193 75 }
Christopher Haster 79:43a7e8c0d6cc 76 }
Christopher Haster 79:43a7e8c0d6cc 77 }