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

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

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 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 UDPSocket::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 UDPSocket::bind(const SocketAddress &address)
Christopher Haster 96:656011e49d9f 47 {
Christopher Haster 79:43a7e8c0d6cc 48 if (!_socket) {
geky 86:7ca9776b9cc0 49 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 79:43a7e8c0d6cc 50 }
Christopher Haster 79:43a7e8c0d6cc 51
Christopher Haster 96:656011e49d9f 52 return _iface->socket_bind(_socket, address);
Christopher Haster 96:656011e49d9f 53 }
Christopher Haster 96:656011e49d9f 54
Christopher Haster 96:656011e49d9f 55 int UDPSocket::sendto(const char *host, uint16_t port, const void *data, unsigned size)
Christopher Haster 96:656011e49d9f 56 {
Christopher Haster 96:656011e49d9f 57 SocketAddress addr(_iface, host, port);
Christopher Haster 96:656011e49d9f 58 if (!addr) {
Christopher Haster 96:656011e49d9f 59 return NSAPI_ERROR_DNS_FAILURE;
Christopher Haster 96:656011e49d9f 60 }
Christopher Haster 96:656011e49d9f 61
Christopher Haster 96:656011e49d9f 62 return sendto(addr, data, size);
Christopher Haster 79:43a7e8c0d6cc 63 }
Christopher Haster 79:43a7e8c0d6cc 64
Christopher Haster 80:9c6673c93082 65 int UDPSocket::sendto(const SocketAddress &address, const void *data, unsigned size)
Christopher Haster 79:43a7e8c0d6cc 66 {
Christopher Haster 82:97d166c4a193 67 mbed::Timer timer;
Christopher Haster 82:97d166c4a193 68 timer.start();
Christopher Haster 82:97d166c4a193 69
Christopher Haster 82:97d166c4a193 70 while (true) {
Christopher Haster 82:97d166c4a193 71 if (!_socket) {
Christopher Haster 82:97d166c4a193 72 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 82:97d166c4a193 73 }
Christopher Haster 82:97d166c4a193 74
Christopher Haster 82:97d166c4a193 75 int sent = _iface->socket_sendto(_socket, address, data, size);
Christopher Haster 82:97d166c4a193 76 if (sent != NSAPI_ERROR_WOULD_BLOCK || !_blocking ||
Christopher Haster 82:97d166c4a193 77 (_timeout && timer.read_ms() > _timeout)) {
Christopher Haster 82:97d166c4a193 78 return sent;
Christopher Haster 82:97d166c4a193 79 }
Christopher Haster 79:43a7e8c0d6cc 80 }
Christopher Haster 79:43a7e8c0d6cc 81 }
Christopher Haster 79:43a7e8c0d6cc 82
Christopher Haster 79:43a7e8c0d6cc 83 int UDPSocket::recvfrom(SocketAddress *address, void *buffer, unsigned size)
Christopher Haster 79:43a7e8c0d6cc 84 {
Christopher Haster 82:97d166c4a193 85 mbed::Timer timer;
Christopher Haster 82:97d166c4a193 86 timer.start();
Christopher Haster 82:97d166c4a193 87
Christopher Haster 82:97d166c4a193 88 while (true) {
Christopher Haster 82:97d166c4a193 89 if (!_socket) {
Christopher Haster 82:97d166c4a193 90 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 82:97d166c4a193 91 }
Christopher Haster 82:97d166c4a193 92
Christopher Haster 82:97d166c4a193 93 int recv = _iface->socket_recvfrom(_socket, address, buffer, size);
Christopher Haster 82:97d166c4a193 94 if (recv != NSAPI_ERROR_WOULD_BLOCK || !_blocking ||
Christopher Haster 82:97d166c4a193 95 (_timeout && timer.read_ms() > _timeout)) {
Christopher Haster 82:97d166c4a193 96 return recv;
Christopher Haster 82:97d166c4a193 97 }
Christopher Haster 79:43a7e8c0d6cc 98 }
Christopher Haster 79:43a7e8c0d6cc 99 }