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@116:bc043343d753, 2016-04-20 (annotated)

Committer:
Christopher Haster
Date:
Wed Apr 20 19:20:51 2016 -0500
Revision:
116:bc043343d753
Parent:
115:950b19eb0f02
Child:
117:ff83eb6a1ab9
Added WFI to save power in temporary polling implementation

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 90:0a988e4abb72 20 TCPSocket::TCPSocket()
Christopher Haster 90:0a988e4abb72 21 {
Christopher Haster 90:0a988e4abb72 22 }
Christopher Haster 90:0a988e4abb72 23
Christopher Haster 105:2fd212f8da61 24 TCPSocket::TCPSocket(NetworkStack *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 105:2fd212f8da61 29 int TCPSocket::open(NetworkStack *iface)
Christopher Haster 90:0a988e4abb72 30 {
Christopher Haster 90:0a988e4abb72 31 return Socket::open(iface, NSAPI_TCP);
Christopher Haster 79:43a7e8c0d6cc 32 }
Christopher Haster 79:43a7e8c0d6cc 33
Christopher Haster 80:9c6673c93082 34 int TCPSocket::connect(const SocketAddress &addr)
Christopher Haster 79:43a7e8c0d6cc 35 {
Christopher Haster 79:43a7e8c0d6cc 36 if (!_socket) {
Christopher Haster 79:43a7e8c0d6cc 37 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 79:43a7e8c0d6cc 38 }
Christopher Haster 79:43a7e8c0d6cc 39
Christopher Haster 79:43a7e8c0d6cc 40 return _iface->socket_connect(_socket, addr);
Christopher Haster 79:43a7e8c0d6cc 41 }
Christopher Haster 79:43a7e8c0d6cc 42
Christopher Haster 79:43a7e8c0d6cc 43 int TCPSocket::connect(const char *host, uint16_t port)
Christopher Haster 79:43a7e8c0d6cc 44 {
Christopher Haster 80:9c6673c93082 45 SocketAddress addr(_iface, host, port);
Christopher Haster 96:656011e49d9f 46 if (!addr) {
Christopher Haster 79:43a7e8c0d6cc 47 return NSAPI_ERROR_DNS_FAILURE;
Christopher Haster 79:43a7e8c0d6cc 48 }
Christopher Haster 79:43a7e8c0d6cc 49
Christopher Haster 79:43a7e8c0d6cc 50 return connect(addr);
Christopher Haster 79:43a7e8c0d6cc 51 }
Christopher Haster 79:43a7e8c0d6cc 52
Christopher Haster 79:43a7e8c0d6cc 53 int TCPSocket::send(const void *data, unsigned size)
Christopher Haster 79:43a7e8c0d6cc 54 {
Christopher Haster 82:97d166c4a193 55 mbed::Timer timer;
Christopher Haster 82:97d166c4a193 56 timer.start();
Christopher Haster 82:97d166c4a193 57
Christopher Haster 82:97d166c4a193 58 while (true) {
Christopher Haster 82:97d166c4a193 59 if (!_socket) {
Christopher Haster 82:97d166c4a193 60 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 82:97d166c4a193 61 }
Christopher Haster 82:97d166c4a193 62
Christopher Haster 82:97d166c4a193 63 int sent = _iface->socket_send(_socket, data, size);
Christopher Haster 115:950b19eb0f02 64 if (sent != NSAPI_ERROR_WOULD_BLOCK
Christopher Haster 115:950b19eb0f02 65 || _timeout < 0
Christopher Haster 115:950b19eb0f02 66 || timer.read_ms() > _timeout) {
Christopher Haster 82:97d166c4a193 67 return sent;
Christopher Haster 82:97d166c4a193 68 }
Christopher Haster 116:bc043343d753 69
Christopher Haster 116:bc043343d753 70 __WFI();
Christopher Haster 79:43a7e8c0d6cc 71 }
Christopher Haster 79:43a7e8c0d6cc 72 }
Christopher Haster 79:43a7e8c0d6cc 73
Christopher Haster 79:43a7e8c0d6cc 74 int TCPSocket::recv(void *data, unsigned size)
Christopher Haster 79:43a7e8c0d6cc 75 {
Christopher Haster 82:97d166c4a193 76 mbed::Timer timer;
Christopher Haster 82:97d166c4a193 77 timer.start();
Christopher Haster 82:97d166c4a193 78
Christopher Haster 82:97d166c4a193 79 while (true) {
Christopher Haster 82:97d166c4a193 80 if (!_socket) {
Christopher Haster 82:97d166c4a193 81 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 82:97d166c4a193 82 }
Christopher Haster 82:97d166c4a193 83
Christopher Haster 82:97d166c4a193 84 int recv = _iface->socket_recv(_socket, data, size);
Christopher Haster 115:950b19eb0f02 85 if (recv != NSAPI_ERROR_WOULD_BLOCK
Christopher Haster 115:950b19eb0f02 86 || _timeout < 0
Christopher Haster 115:950b19eb0f02 87 || timer.read_ms() > _timeout) {
Christopher Haster 82:97d166c4a193 88 return recv;
Christopher Haster 82:97d166c4a193 89 }
Christopher Haster 116:bc043343d753 90
Christopher Haster 116:bc043343d753 91 __WFI();
Christopher Haster 79:43a7e8c0d6cc 92 }
Christopher Haster 79:43a7e8c0d6cc 93 }