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@87:94e2cf3a06be, 2016-04-05 (annotated)

Committer:
geky
Date:
Tue Apr 05 23:47:04 2016 +0000
Revision:
87:94e2cf3a06be
Parent:
86:7ca9776b9cc0
Child:
89:b1d417383c0d
Refactored enums

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 79:43a7e8c0d6cc 20 UDPSocket::UDPSocket(NetworkInterface *iface)
geky 87:94e2cf3a06be 21 : Socket(iface, NSAPI_UDP)
Christopher Haster 79:43a7e8c0d6cc 22 {
Christopher Haster 79:43a7e8c0d6cc 23 }
Christopher Haster 79:43a7e8c0d6cc 24
Christopher Haster 79:43a7e8c0d6cc 25 int UDPSocket::bind(uint16_t port)
Christopher Haster 79:43a7e8c0d6cc 26 {
Christopher Haster 79:43a7e8c0d6cc 27 if (!_socket) {
geky 86:7ca9776b9cc0 28 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 79:43a7e8c0d6cc 29 }
Christopher Haster 79:43a7e8c0d6cc 30
Christopher Haster 79:43a7e8c0d6cc 31 return _iface->socket_bind(_socket, port);
Christopher Haster 79:43a7e8c0d6cc 32 }
Christopher Haster 79:43a7e8c0d6cc 33
Christopher Haster 80:9c6673c93082 34 int UDPSocket::sendto(const SocketAddress &address, const void *data, unsigned size)
Christopher Haster 79:43a7e8c0d6cc 35 {
Christopher Haster 82:97d166c4a193 36 mbed::Timer timer;
Christopher Haster 82:97d166c4a193 37 timer.start();
Christopher Haster 82:97d166c4a193 38
Christopher Haster 82:97d166c4a193 39 while (true) {
Christopher Haster 82:97d166c4a193 40 if (!_socket) {
Christopher Haster 82:97d166c4a193 41 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 82:97d166c4a193 42 }
Christopher Haster 82:97d166c4a193 43
Christopher Haster 82:97d166c4a193 44 int sent = _iface->socket_sendto(_socket, address, data, size);
Christopher Haster 82:97d166c4a193 45 if (sent != NSAPI_ERROR_WOULD_BLOCK || !_blocking ||
Christopher Haster 82:97d166c4a193 46 (_timeout && timer.read_ms() > _timeout)) {
Christopher Haster 82:97d166c4a193 47 return sent;
Christopher Haster 82:97d166c4a193 48 }
Christopher Haster 79:43a7e8c0d6cc 49 }
Christopher Haster 79:43a7e8c0d6cc 50 }
Christopher Haster 79:43a7e8c0d6cc 51
Christopher Haster 79:43a7e8c0d6cc 52 int UDPSocket::recvfrom(SocketAddress *address, void *buffer, unsigned size)
Christopher Haster 79:43a7e8c0d6cc 53 {
Christopher Haster 82:97d166c4a193 54 mbed::Timer timer;
Christopher Haster 82:97d166c4a193 55 timer.start();
Christopher Haster 82:97d166c4a193 56
Christopher Haster 82:97d166c4a193 57 while (true) {
Christopher Haster 82:97d166c4a193 58 if (!_socket) {
Christopher Haster 82:97d166c4a193 59 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 82:97d166c4a193 60 }
Christopher Haster 82:97d166c4a193 61
Christopher Haster 82:97d166c4a193 62 int recv = _iface->socket_recvfrom(_socket, address, buffer, size);
Christopher Haster 82:97d166c4a193 63 if (recv != NSAPI_ERROR_WOULD_BLOCK || !_blocking ||
Christopher Haster 82:97d166c4a193 64 (_timeout && timer.read_ms() > _timeout)) {
Christopher Haster 82:97d166c4a193 65 return recv;
Christopher Haster 82:97d166c4a193 66 }
Christopher Haster 79:43a7e8c0d6cc 67 }
Christopher Haster 79:43a7e8c0d6cc 68 }
Christopher Haster 81:1600369a29dd 69
Christopher Haster 81:1600369a29dd 70
Christopher Haster 81:1600369a29dd 71 void UDPSocket::attach_send(mbed::FuncPtr<void()> callback)
Christopher Haster 81:1600369a29dd 72 {
Christopher Haster 81:1600369a29dd 73 _send_cb = callback;
Christopher Haster 81:1600369a29dd 74 if (_socket && _send_cb) {
Christopher Haster 81:1600369a29dd 75 return _iface->socket_attach_send(_socket, Socket::thunk, &_send_cb);
Christopher Haster 81:1600369a29dd 76 } else if (_socket) {
Christopher Haster 81:1600369a29dd 77 return _iface->socket_attach_send(_socket, 0, 0);
Christopher Haster 81:1600369a29dd 78 }
Christopher Haster 81:1600369a29dd 79 }
Christopher Haster 81:1600369a29dd 80
Christopher Haster 81:1600369a29dd 81 void UDPSocket::attach_recv(mbed::FuncPtr<void()> callback)
Christopher Haster 81:1600369a29dd 82 {
Christopher Haster 81:1600369a29dd 83 _recv_cb = callback;
Christopher Haster 81:1600369a29dd 84 if (_socket && _recv_cb) {
Christopher Haster 81:1600369a29dd 85 return _iface->socket_attach_recv(_socket, Socket::thunk, &_recv_cb);
Christopher Haster 81:1600369a29dd 86 } else if (_socket) {
Christopher Haster 81:1600369a29dd 87 return _iface->socket_attach_recv(_socket, 0, 0);
Christopher Haster 81:1600369a29dd 88 }
Christopher Haster 81:1600369a29dd 89 }
Christopher Haster 81:1600369a29dd 90
Christopher Haster 81:1600369a29dd 91 UDPSocket::~UDPSocket()
Christopher Haster 81:1600369a29dd 92 {
Christopher Haster 81:1600369a29dd 93 if (_socket && _send_cb) {
Christopher Haster 81:1600369a29dd 94 _iface->socket_attach_send(_socket, 0, 0);
Christopher Haster 81:1600369a29dd 95 }
Christopher Haster 81:1600369a29dd 96
Christopher Haster 81:1600369a29dd 97 if (_socket && _recv_cb) {
Christopher Haster 81:1600369a29dd 98 _iface->socket_attach_recv(_socket, 0, 0);
Christopher Haster 81:1600369a29dd 99 }
Christopher Haster 81:1600369a29dd 100 }