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@79:43a7e8c0d6cc, 2016-04-05 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 05 10:40:34 2016 -0500
Revision:
79:43a7e8c0d6cc
Child:
80:9c6673c93082
Added rough implementation of the API shim

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 79:43a7e8c0d6cc 18
Christopher Haster 79:43a7e8c0d6cc 19 TCPSocket::TCPSocket(NetworkInterface *iface)
Christopher Haster 79:43a7e8c0d6cc 20 : Socket(iface, NetworkInterface::TCP)
Christopher Haster 79:43a7e8c0d6cc 21 {
Christopher Haster 79:43a7e8c0d6cc 22 }
Christopher Haster 79:43a7e8c0d6cc 23
Christopher Haster 79:43a7e8c0d6cc 24 int TCPSocket::connect(SocketAddress addr)
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_connect(_socket, addr);
Christopher Haster 79:43a7e8c0d6cc 31 }
Christopher Haster 79:43a7e8c0d6cc 32
Christopher Haster 79:43a7e8c0d6cc 33 int TCPSocket::connect(const char *host, uint16_t port)
Christopher Haster 79:43a7e8c0d6cc 34 {
Christopher Haster 79:43a7e8c0d6cc 35 SocketAddress addr = _iface->gethostbyname(host, port);
Christopher Haster 79:43a7e8c0d6cc 36 if (!addr.get_ip_address()) {
Christopher Haster 79:43a7e8c0d6cc 37 return NSAPI_ERROR_DNS_FAILURE;
Christopher Haster 79:43a7e8c0d6cc 38 }
Christopher Haster 79:43a7e8c0d6cc 39
Christopher Haster 79:43a7e8c0d6cc 40 return connect(addr);
Christopher Haster 79:43a7e8c0d6cc 41 }
Christopher Haster 79:43a7e8c0d6cc 42
Christopher Haster 79:43a7e8c0d6cc 43 bool TCPSocket::is_connected()
Christopher Haster 79:43a7e8c0d6cc 44 {
Christopher Haster 79:43a7e8c0d6cc 45 return _socket && _iface->socket_is_connected(_socket);
Christopher Haster 79:43a7e8c0d6cc 46 }
Christopher Haster 79:43a7e8c0d6cc 47
Christopher Haster 79:43a7e8c0d6cc 48 int TCPSocket::send(const void *data, unsigned size)
Christopher Haster 79:43a7e8c0d6cc 49 {
Christopher Haster 79:43a7e8c0d6cc 50 if (!_socket) {
Christopher Haster 79:43a7e8c0d6cc 51 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 79:43a7e8c0d6cc 52 }
Christopher Haster 79:43a7e8c0d6cc 53
Christopher Haster 79:43a7e8c0d6cc 54 return _iface->socket_send(_socket, data, size);
Christopher Haster 79:43a7e8c0d6cc 55 }
Christopher Haster 79:43a7e8c0d6cc 56
Christopher Haster 79:43a7e8c0d6cc 57 int TCPSocket::recv(void *data, unsigned size)
Christopher Haster 79:43a7e8c0d6cc 58 {
Christopher Haster 79:43a7e8c0d6cc 59 if (!_socket) {
Christopher Haster 79:43a7e8c0d6cc 60 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 79:43a7e8c0d6cc 61 }
Christopher Haster 79:43a7e8c0d6cc 62
Christopher Haster 79:43a7e8c0d6cc 63 return _iface->socket_recv(_socket, data, size);
Christopher Haster 79:43a7e8c0d6cc 64 }