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.

Socket.cpp@25:ed7b2a52e8ac, 2016-02-18 (annotated)

Committer:
Christopher Haster
Date:
Thu Feb 18 06:01:55 2016 -0600
Branch:
api-changes
Revision:
25:ed7b2a52e8ac
Child:
27:d7ed39727306
Added abstract base case for Sockets

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Christopher Haster 25:ed7b2a52e8ac 1 /* Socket
Christopher Haster 25:ed7b2a52e8ac 2 * Copyright (c) 2015 ARM Limited
Christopher Haster 25:ed7b2a52e8ac 3 *
Christopher Haster 25:ed7b2a52e8ac 4 * Licensed under the Apache License, Version 2.0 (the "License");
Christopher Haster 25:ed7b2a52e8ac 5 * you may not use this file except in compliance with the License.
Christopher Haster 25:ed7b2a52e8ac 6 * You may obtain a copy of the License at
Christopher Haster 25:ed7b2a52e8ac 7 *
Christopher Haster 25:ed7b2a52e8ac 8 * http://www.apache.org/licenses/LICENSE-2.0
Christopher Haster 25:ed7b2a52e8ac 9 *
Christopher Haster 25:ed7b2a52e8ac 10 * Unless required by applicable law or agreed to in writing, software
Christopher Haster 25:ed7b2a52e8ac 11 * distributed under the License is distributed on an "AS IS" BASIS,
Christopher Haster 25:ed7b2a52e8ac 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Christopher Haster 25:ed7b2a52e8ac 13 * See the License for the specific language governing permissions and
Christopher Haster 25:ed7b2a52e8ac 14 * limitations under the License.
Christopher Haster 25:ed7b2a52e8ac 15 */
Christopher Haster 25:ed7b2a52e8ac 16
Christopher Haster 25:ed7b2a52e8ac 17 #include "Socket.h"
Christopher Haster 25:ed7b2a52e8ac 18
Christopher Haster 25:ed7b2a52e8ac 19 Socket::Socket(
Christopher Haster 25:ed7b2a52e8ac 20 NetworkInterface *iface,
Christopher Haster 25:ed7b2a52e8ac 21 socket_protocol_t proto,
Christopher Haster 25:ed7b2a52e8ac 22 const char *url,
Christopher Haster 25:ed7b2a52e8ac 23 uint16_t port)
Christopher Haster 25:ed7b2a52e8ac 24 : _iface(iface)
Christopher Haster 25:ed7b2a52e8ac 25 , _proto(proto)
Christopher Haster 25:ed7b2a52e8ac 26 , _socket(0) {
Christopher Haster 25:ed7b2a52e8ac 27 if (url) setURL(url);
Christopher Haster 25:ed7b2a52e8ac 28 if (port) setPort(port);
Christopher Haster 25:ed7b2a52e8ac 29 }
Christopher Haster 25:ed7b2a52e8ac 30
Christopher Haster 25:ed7b2a52e8ac 31 Socket::~Socket() {
Christopher Haster 25:ed7b2a52e8ac 32 if (_socket) _iface->destroySocket(_socket);
Christopher Haster 25:ed7b2a52e8ac 33 }
Christopher Haster 25:ed7b2a52e8ac 34
Christopher Haster 25:ed7b2a52e8ac 35 SocketInterface *Socket::_get_socket() {
Christopher Haster 25:ed7b2a52e8ac 36 if (!_socket) _socket = _iface->createSocket(_proto);
Christopher Haster 25:ed7b2a52e8ac 37 return _socket;
Christopher Haster 25:ed7b2a52e8ac 38 }
Christopher Haster 25:ed7b2a52e8ac 39
Christopher Haster 25:ed7b2a52e8ac 40 void Socket::setURL(const char *url) {
Christopher Haster 25:ed7b2a52e8ac 41 SocketInterface *s = _get_socket();
Christopher Haster 25:ed7b2a52e8ac 42 if (!s) return;
Christopher Haster 25:ed7b2a52e8ac 43 s->setURL(url);
Christopher Haster 25:ed7b2a52e8ac 44 }
Christopher Haster 25:ed7b2a52e8ac 45
Christopher Haster 25:ed7b2a52e8ac 46 void Socket::setIPAddress(const char *ip) {
Christopher Haster 25:ed7b2a52e8ac 47 SocketInterface *s = _get_socket();
Christopher Haster 25:ed7b2a52e8ac 48 if (!s) return;
Christopher Haster 25:ed7b2a52e8ac 49 s->setIPAddress(ip);
Christopher Haster 25:ed7b2a52e8ac 50 }
Christopher Haster 25:ed7b2a52e8ac 51
Christopher Haster 25:ed7b2a52e8ac 52 void Socket::setPort(uint16_t port) {
Christopher Haster 25:ed7b2a52e8ac 53 SocketInterface *s = _get_socket();
Christopher Haster 25:ed7b2a52e8ac 54 if (!s) return;
Christopher Haster 25:ed7b2a52e8ac 55 s->setPort(port);
Christopher Haster 25:ed7b2a52e8ac 56 }
Christopher Haster 25:ed7b2a52e8ac 57
Christopher Haster 25:ed7b2a52e8ac 58 const char *Socket::getIPAddress() {
Christopher Haster 25:ed7b2a52e8ac 59 SocketInterface *s = _get_socket();
Christopher Haster 25:ed7b2a52e8ac 60 if (!s) return 0;
Christopher Haster 25:ed7b2a52e8ac 61 return s->getIPAddress();
Christopher Haster 25:ed7b2a52e8ac 62 }
Christopher Haster 25:ed7b2a52e8ac 63
Christopher Haster 25:ed7b2a52e8ac 64 uint16_t Socket::getPort() {
Christopher Haster 25:ed7b2a52e8ac 65 SocketInterface *s = _get_socket();
Christopher Haster 25:ed7b2a52e8ac 66 if (!s) return 0;
Christopher Haster 25:ed7b2a52e8ac 67 return s->getPort();
Christopher Haster 25:ed7b2a52e8ac 68 }
Christopher Haster 25:ed7b2a52e8ac 69
Christopher Haster 25:ed7b2a52e8ac 70 int32_t Socket::send(const void *data, uint32_t len, uint32_t timeout_ms) {
Christopher Haster 25:ed7b2a52e8ac 71 SocketInterface *s = _get_socket();
Christopher Haster 25:ed7b2a52e8ac 72 if (!s) return -2;
Christopher Haster 25:ed7b2a52e8ac 73 return s->send(data, len, timeout_ms);
Christopher Haster 25:ed7b2a52e8ac 74 }
Christopher Haster 25:ed7b2a52e8ac 75
Christopher Haster 25:ed7b2a52e8ac 76 int32_t Socket::recv(void *data, uint32_t len, uint32_t timeout_ms) {
Christopher Haster 25:ed7b2a52e8ac 77 SocketInterface *s = _get_socket();
Christopher Haster 25:ed7b2a52e8ac 78 if (!s) return -2;
Christopher Haster 25:ed7b2a52e8ac 79 return s->recv(data, len, timeout_ms);
Christopher Haster 25:ed7b2a52e8ac 80 }
Christopher Haster 25:ed7b2a52e8ac 81