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@81:1600369a29dd, 2016-04-05 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 05 12:52:07 2016 -0500
Revision:
81:1600369a29dd
Parent:
80:9c6673c93082
Child:
82:97d166c4a193
Added proper forwarding for interrupt driven callbacks

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 79:43a7e8c0d6cc 18
Christopher Haster 79:43a7e8c0d6cc 19 UDPSocket::UDPSocket(NetworkInterface *iface)
Christopher Haster 79:43a7e8c0d6cc 20 : Socket(iface, NetworkInterface::UDP)
Christopher Haster 79:43a7e8c0d6cc 21 {
Christopher Haster 79:43a7e8c0d6cc 22 }
Christopher Haster 79:43a7e8c0d6cc 23
Christopher Haster 79:43a7e8c0d6cc 24 int UDPSocket::bind(uint16_t port)
Christopher Haster 79:43a7e8c0d6cc 25 {
Christopher Haster 79:43a7e8c0d6cc 26 if (!_socket) {
Christopher Haster 79:43a7e8c0d6cc 27 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 79:43a7e8c0d6cc 28 }
Christopher Haster 79:43a7e8c0d6cc 29
Christopher Haster 79:43a7e8c0d6cc 30 return _iface->socket_bind(_socket, port);
Christopher Haster 79:43a7e8c0d6cc 31 }
Christopher Haster 79:43a7e8c0d6cc 32
Christopher Haster 80:9c6673c93082 33 int UDPSocket::sendto(const SocketAddress &address, const void *data, unsigned size)
Christopher Haster 79:43a7e8c0d6cc 34 {
Christopher Haster 79:43a7e8c0d6cc 35 if (!_socket) {
Christopher Haster 79:43a7e8c0d6cc 36 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 79:43a7e8c0d6cc 37 }
Christopher Haster 79:43a7e8c0d6cc 38
Christopher Haster 79:43a7e8c0d6cc 39 return _iface->socket_sendto(_socket, address, data, size);
Christopher Haster 79:43a7e8c0d6cc 40 }
Christopher Haster 79:43a7e8c0d6cc 41
Christopher Haster 79:43a7e8c0d6cc 42 int UDPSocket::recvfrom(SocketAddress *address, void *buffer, unsigned size)
Christopher Haster 79:43a7e8c0d6cc 43 {
Christopher Haster 79:43a7e8c0d6cc 44 if (!_socket) {
Christopher Haster 79:43a7e8c0d6cc 45 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 79:43a7e8c0d6cc 46 }
Christopher Haster 79:43a7e8c0d6cc 47
Christopher Haster 79:43a7e8c0d6cc 48 return _iface->socket_recvfrom(_socket, address, buffer, size);
Christopher Haster 79:43a7e8c0d6cc 49 }
Christopher Haster 81:1600369a29dd 50
Christopher Haster 81:1600369a29dd 51
Christopher Haster 81:1600369a29dd 52 void UDPSocket::attach_send(mbed::FuncPtr<void()> callback)
Christopher Haster 81:1600369a29dd 53 {
Christopher Haster 81:1600369a29dd 54 _send_cb = callback;
Christopher Haster 81:1600369a29dd 55 if (_socket && _send_cb) {
Christopher Haster 81:1600369a29dd 56 return _iface->socket_attach_send(_socket, Socket::thunk, &_send_cb);
Christopher Haster 81:1600369a29dd 57 } else if (_socket) {
Christopher Haster 81:1600369a29dd 58 return _iface->socket_attach_send(_socket, 0, 0);
Christopher Haster 81:1600369a29dd 59 }
Christopher Haster 81:1600369a29dd 60 }
Christopher Haster 81:1600369a29dd 61
Christopher Haster 81:1600369a29dd 62 void UDPSocket::attach_recv(mbed::FuncPtr<void()> callback)
Christopher Haster 81:1600369a29dd 63 {
Christopher Haster 81:1600369a29dd 64 _recv_cb = callback;
Christopher Haster 81:1600369a29dd 65 if (_socket && _recv_cb) {
Christopher Haster 81:1600369a29dd 66 return _iface->socket_attach_recv(_socket, Socket::thunk, &_recv_cb);
Christopher Haster 81:1600369a29dd 67 } else if (_socket) {
Christopher Haster 81:1600369a29dd 68 return _iface->socket_attach_recv(_socket, 0, 0);
Christopher Haster 81:1600369a29dd 69 }
Christopher Haster 81:1600369a29dd 70 }
Christopher Haster 81:1600369a29dd 71
Christopher Haster 81:1600369a29dd 72 UDPSocket::~UDPSocket()
Christopher Haster 81:1600369a29dd 73 {
Christopher Haster 81:1600369a29dd 74 if (_socket && _send_cb) {
Christopher Haster 81:1600369a29dd 75 _iface->socket_attach_send(_socket, 0, 0);
Christopher Haster 81:1600369a29dd 76 }
Christopher Haster 81:1600369a29dd 77
Christopher Haster 81:1600369a29dd 78 if (_socket && _recv_cb) {
Christopher Haster 81:1600369a29dd 79 _iface->socket_attach_recv(_socket, 0, 0);
Christopher Haster 81:1600369a29dd 80 }
Christopher Haster 81:1600369a29dd 81 }