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@93:65a9f84862f0, 2016-04-19 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 19 18:23:42 2016 -0500
Revision:
93:65a9f84862f0
Parent:
92:dd5f19874adf
Child:
98:0f614f1d0398
Renamed NetworkInterface create/destroy methods to match Socket methods



- socket_create -> socket_open

- socket_destroy -> socket_close

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Christopher Haster 89:b1d417383c0d 1 /* Socket
Christopher Haster 89:b1d417383c0d 2 * Copyright (c) 2015 ARM Limited
Christopher Haster 89:b1d417383c0d 3 *
Christopher Haster 89:b1d417383c0d 4 * Licensed under the Apache License, Version 2.0 (the "License");
Christopher Haster 89:b1d417383c0d 5 * you may not use this file except in compliance with the License.
Christopher Haster 89:b1d417383c0d 6 * You may obtain a copy of the License at
Christopher Haster 89:b1d417383c0d 7 *
Christopher Haster 89:b1d417383c0d 8 * http://www.apache.org/licenses/LICENSE-2.0
Christopher Haster 89:b1d417383c0d 9 *
Christopher Haster 89:b1d417383c0d 10 * Unless required by applicable law or agreed to in writing, software
Christopher Haster 89:b1d417383c0d 11 * distributed under the License is distributed on an "AS IS" BASIS,
Christopher Haster 89:b1d417383c0d 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Christopher Haster 89:b1d417383c0d 13 * See the License for the specific language governing permissions and
Christopher Haster 89:b1d417383c0d 14 * limitations under the License.
Christopher Haster 89:b1d417383c0d 15 */
Christopher Haster 89:b1d417383c0d 16
Christopher Haster 89:b1d417383c0d 17 #include "Socket.h"
Christopher Haster 89:b1d417383c0d 18
Christopher Haster 90:0a988e4abb72 19 Socket::Socket()
Christopher Haster 90:0a988e4abb72 20 : _iface(0)
Christopher Haster 90:0a988e4abb72 21 , _socket(0)
Christopher Haster 89:b1d417383c0d 22 , _blocking(true)
Christopher Haster 89:b1d417383c0d 23 , _timeout(0)
Christopher Haster 89:b1d417383c0d 24 {
Christopher Haster 89:b1d417383c0d 25 }
Christopher Haster 89:b1d417383c0d 26
Christopher Haster 89:b1d417383c0d 27 Socket::~Socket()
Christopher Haster 89:b1d417383c0d 28 {
Christopher Haster 89:b1d417383c0d 29 if (_socket) {
Christopher Haster 91:cad29ce6a01c 30 close();
Christopher Haster 89:b1d417383c0d 31 }
Christopher Haster 89:b1d417383c0d 32 }
Christopher Haster 89:b1d417383c0d 33
Christopher Haster 90:0a988e4abb72 34 int Socket::open(NetworkInterface *iface, nsapi_protocol_t proto)
Christopher Haster 90:0a988e4abb72 35 {
Christopher Haster 90:0a988e4abb72 36 _iface = iface;
Christopher Haster 93:65a9f84862f0 37
Christopher Haster 93:65a9f84862f0 38 void *socket;
Christopher Haster 93:65a9f84862f0 39 int err = _iface->socket_open(&socket, proto);
Christopher Haster 93:65a9f84862f0 40 if (err) {
Christopher Haster 93:65a9f84862f0 41 return err;
Christopher Haster 93:65a9f84862f0 42 }
Christopher Haster 93:65a9f84862f0 43
Christopher Haster 93:65a9f84862f0 44 _socket = socket;
Christopher Haster 92:dd5f19874adf 45 _iface->socket_attach(_socket, &Socket::thunk, this);
Christopher Haster 93:65a9f84862f0 46
Christopher Haster 93:65a9f84862f0 47 return 0;
Christopher Haster 90:0a988e4abb72 48 }
Christopher Haster 90:0a988e4abb72 49
Christopher Haster 91:cad29ce6a01c 50 int Socket::close()
Christopher Haster 90:0a988e4abb72 51 {
Christopher Haster 90:0a988e4abb72 52 if (!_socket) {
Christopher Haster 90:0a988e4abb72 53 return 0;
Christopher Haster 90:0a988e4abb72 54 }
Christopher Haster 90:0a988e4abb72 55
Christopher Haster 93:65a9f84862f0 56 void *socket = _socket;
Christopher Haster 93:65a9f84862f0 57 _socket = 0;
Christopher Haster 93:65a9f84862f0 58 return _iface->socket_close(socket);
Christopher Haster 90:0a988e4abb72 59 }
Christopher Haster 90:0a988e4abb72 60
Christopher Haster 89:b1d417383c0d 61 void Socket::set_blocking(bool blocking)
Christopher Haster 89:b1d417383c0d 62 {
Christopher Haster 89:b1d417383c0d 63 _blocking = blocking;
Christopher Haster 89:b1d417383c0d 64 }
Christopher Haster 89:b1d417383c0d 65
Christopher Haster 89:b1d417383c0d 66 void Socket::set_timeout(unsigned timeout)
Christopher Haster 89:b1d417383c0d 67 {
Christopher Haster 89:b1d417383c0d 68 _timeout = timeout;
Christopher Haster 89:b1d417383c0d 69 }
Christopher Haster 89:b1d417383c0d 70
Christopher Haster 89:b1d417383c0d 71 int Socket::set_option(int optname, const void *optval, unsigned int optlen)
Christopher Haster 89:b1d417383c0d 72 {
Christopher Haster 89:b1d417383c0d 73 if (!_socket) {
Christopher Haster 89:b1d417383c0d 74 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 89:b1d417383c0d 75 }
Christopher Haster 89:b1d417383c0d 76
Christopher Haster 89:b1d417383c0d 77 return _iface->socket_set_option(_socket, optname, optval, optlen);
Christopher Haster 89:b1d417383c0d 78 }
Christopher Haster 89:b1d417383c0d 79
Christopher Haster 89:b1d417383c0d 80 int Socket::get_option(int optname, void *optval, unsigned int *optlen)
Christopher Haster 89:b1d417383c0d 81 {
Christopher Haster 89:b1d417383c0d 82 if (!_socket) {
Christopher Haster 89:b1d417383c0d 83 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 89:b1d417383c0d 84 }
Christopher Haster 89:b1d417383c0d 85
Christopher Haster 89:b1d417383c0d 86 return _iface->socket_get_option(_socket, optname, optval, optlen);
Christopher Haster 89:b1d417383c0d 87 }
Christopher Haster 89:b1d417383c0d 88
Christopher Haster 92:dd5f19874adf 89 void Socket::thunk(void *data)
Christopher Haster 89:b1d417383c0d 90 {
Christopher Haster 92:dd5f19874adf 91 Socket *self = (Socket *)data;
Christopher Haster 92:dd5f19874adf 92 if (self->_callback) {
Christopher Haster 92:dd5f19874adf 93 self->_callback();
Christopher Haster 92:dd5f19874adf 94 }
Christopher Haster 89:b1d417383c0d 95 }
Christopher Haster 92:dd5f19874adf 96
Christopher Haster 92:dd5f19874adf 97 void Socket::attach(FunctionPointer callback)
Christopher Haster 92:dd5f19874adf 98 {
Christopher Haster 92:dd5f19874adf 99 _callback = callback;
Christopher Haster 92:dd5f19874adf 100 }