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.

TCPSocket.cpp@82:97d166c4a193, 2016-04-05 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 05 13:09:43 2016 -0500
Revision:
82:97d166c4a193
Parent:
81:1600369a29dd
Child:
87:94e2cf3a06be
Added temporary polling for blocking sockets

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 "TCPSocket.h"
Christopher Haster 82:97d166c4a193 18 #include "Timer.h"
Christopher Haster 79:43a7e8c0d6cc 19
Christopher Haster 79:43a7e8c0d6cc 20 TCPSocket::TCPSocket(NetworkInterface *iface)
Christopher Haster 79:43a7e8c0d6cc 21 : Socket(iface, NetworkInterface::TCP)
Christopher Haster 79:43a7e8c0d6cc 22 {
Christopher Haster 79:43a7e8c0d6cc 23 }
Christopher Haster 79:43a7e8c0d6cc 24
Christopher Haster 80:9c6673c93082 25 int TCPSocket::connect(const SocketAddress &addr)
Christopher Haster 79:43a7e8c0d6cc 26 {
Christopher Haster 79:43a7e8c0d6cc 27 if (!_socket) {
Christopher Haster 79:43a7e8c0d6cc 28 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 79:43a7e8c0d6cc 29 }
Christopher Haster 79:43a7e8c0d6cc 30
Christopher Haster 79:43a7e8c0d6cc 31 return _iface->socket_connect(_socket, addr);
Christopher Haster 79:43a7e8c0d6cc 32 }
Christopher Haster 79:43a7e8c0d6cc 33
Christopher Haster 79:43a7e8c0d6cc 34 int TCPSocket::connect(const char *host, uint16_t port)
Christopher Haster 79:43a7e8c0d6cc 35 {
Christopher Haster 80:9c6673c93082 36 SocketAddress addr(_iface, host, port);
Christopher Haster 79:43a7e8c0d6cc 37 if (!addr.get_ip_address()) {
Christopher Haster 79:43a7e8c0d6cc 38 return NSAPI_ERROR_DNS_FAILURE;
Christopher Haster 79:43a7e8c0d6cc 39 }
Christopher Haster 79:43a7e8c0d6cc 40
Christopher Haster 79:43a7e8c0d6cc 41 return connect(addr);
Christopher Haster 79:43a7e8c0d6cc 42 }
Christopher Haster 79:43a7e8c0d6cc 43
Christopher Haster 79:43a7e8c0d6cc 44 bool TCPSocket::is_connected()
Christopher Haster 79:43a7e8c0d6cc 45 {
Christopher Haster 79:43a7e8c0d6cc 46 return _socket && _iface->socket_is_connected(_socket);
Christopher Haster 79:43a7e8c0d6cc 47 }
Christopher Haster 79:43a7e8c0d6cc 48
Christopher Haster 79:43a7e8c0d6cc 49 int TCPSocket::send(const void *data, unsigned size)
Christopher Haster 79:43a7e8c0d6cc 50 {
Christopher Haster 82:97d166c4a193 51 mbed::Timer timer;
Christopher Haster 82:97d166c4a193 52 timer.start();
Christopher Haster 82:97d166c4a193 53
Christopher Haster 82:97d166c4a193 54 while (true) {
Christopher Haster 82:97d166c4a193 55 if (!_socket) {
Christopher Haster 82:97d166c4a193 56 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 82:97d166c4a193 57 }
Christopher Haster 82:97d166c4a193 58
Christopher Haster 82:97d166c4a193 59 int sent = _iface->socket_send(_socket, data, size);
Christopher Haster 82:97d166c4a193 60 if (sent != NSAPI_ERROR_WOULD_BLOCK || !_blocking ||
Christopher Haster 82:97d166c4a193 61 (_timeout && timer.read_ms() > _timeout)) {
Christopher Haster 82:97d166c4a193 62 return sent;
Christopher Haster 82:97d166c4a193 63 }
Christopher Haster 79:43a7e8c0d6cc 64 }
Christopher Haster 79:43a7e8c0d6cc 65 }
Christopher Haster 79:43a7e8c0d6cc 66
Christopher Haster 79:43a7e8c0d6cc 67 int TCPSocket::recv(void *data, unsigned size)
Christopher Haster 79:43a7e8c0d6cc 68 {
Christopher Haster 82:97d166c4a193 69 mbed::Timer timer;
Christopher Haster 82:97d166c4a193 70 timer.start();
Christopher Haster 82:97d166c4a193 71
Christopher Haster 82:97d166c4a193 72 while (true) {
Christopher Haster 82:97d166c4a193 73 if (!_socket) {
Christopher Haster 82:97d166c4a193 74 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 82:97d166c4a193 75 }
Christopher Haster 82:97d166c4a193 76
Christopher Haster 82:97d166c4a193 77 int recv = _iface->socket_recv(_socket, data, size);
Christopher Haster 82:97d166c4a193 78 if (recv != NSAPI_ERROR_WOULD_BLOCK || !_blocking ||
Christopher Haster 82:97d166c4a193 79 (_timeout && timer.read_ms() > _timeout)) {
Christopher Haster 82:97d166c4a193 80 return recv;
Christopher Haster 82:97d166c4a193 81 }
Christopher Haster 79:43a7e8c0d6cc 82 }
Christopher Haster 79:43a7e8c0d6cc 83 }
Christopher Haster 81:1600369a29dd 84
Christopher Haster 81:1600369a29dd 85
Christopher Haster 81:1600369a29dd 86 void TCPSocket::attach_send(mbed::FuncPtr<void()> callback)
Christopher Haster 81:1600369a29dd 87 {
Christopher Haster 81:1600369a29dd 88 _send_cb = callback;
Christopher Haster 81:1600369a29dd 89
Christopher Haster 81:1600369a29dd 90 if (_socket && _send_cb) {
Christopher Haster 81:1600369a29dd 91 return _iface->socket_attach_send(_socket, Socket::thunk, &_send_cb);
Christopher Haster 81:1600369a29dd 92 } else if (_socket) {
Christopher Haster 81:1600369a29dd 93 return _iface->socket_attach_send(_socket, 0, 0);
Christopher Haster 81:1600369a29dd 94 }
Christopher Haster 81:1600369a29dd 95 }
Christopher Haster 81:1600369a29dd 96
Christopher Haster 81:1600369a29dd 97 void TCPSocket::attach_recv(mbed::FuncPtr<void()> callback)
Christopher Haster 81:1600369a29dd 98 {
Christopher Haster 81:1600369a29dd 99 _recv_cb = callback;
Christopher Haster 81:1600369a29dd 100
Christopher Haster 81:1600369a29dd 101 if (_socket && _recv_cb) {
Christopher Haster 81:1600369a29dd 102 return _iface->socket_attach_recv(_socket, Socket::thunk, &_recv_cb);
Christopher Haster 81:1600369a29dd 103 } else if (_socket) {
Christopher Haster 81:1600369a29dd 104 return _iface->socket_attach_recv(_socket, 0, 0);
Christopher Haster 81:1600369a29dd 105 }
Christopher Haster 81:1600369a29dd 106 }
Christopher Haster 81:1600369a29dd 107
Christopher Haster 81:1600369a29dd 108 TCPSocket::~TCPSocket()
Christopher Haster 81:1600369a29dd 109 {
Christopher Haster 81:1600369a29dd 110 if (_socket && _send_cb) {
Christopher Haster 81:1600369a29dd 111 _iface->socket_attach_send(_socket, 0, 0);
Christopher Haster 81:1600369a29dd 112 }
Christopher Haster 81:1600369a29dd 113
Christopher Haster 81:1600369a29dd 114 if (_socket && _recv_cb) {
Christopher Haster 81:1600369a29dd 115 _iface->socket_attach_recv(_socket, 0, 0);
Christopher Haster 81:1600369a29dd 116 }
Christopher Haster 81:1600369a29dd 117 }