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@90:0a988e4abb72, 2016-04-19 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 19 18:22:15 2016 -0500
Revision:
90:0a988e4abb72
Parent:
89:b1d417383c0d
Child:
91:cad29ce6a01c
Add open call as alternative to passing NetworkInterface at construction



Pros

- Allows memory to be statically allocated

- Avoids issues with Thread creation before entering main

- Matches existing APIs such as FunctionPointer and Ticker



Cons

- Does not enforce passing a NetworkInterface

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 89:b1d417383c0d 30 close(false);
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 90:0a988e4abb72 37 _socket = _iface->socket_create(proto);
Christopher Haster 90:0a988e4abb72 38 }
Christopher Haster 90:0a988e4abb72 39
Christopher Haster 90:0a988e4abb72 40 int Socket::close(bool shutdown)
Christopher Haster 90:0a988e4abb72 41 {
Christopher Haster 90:0a988e4abb72 42 if (!_socket) {
Christopher Haster 90:0a988e4abb72 43 return 0;
Christopher Haster 90:0a988e4abb72 44 }
Christopher Haster 90:0a988e4abb72 45
Christopher Haster 90:0a988e4abb72 46 int err = _iface->socket_close(_socket, shutdown);
Christopher Haster 90:0a988e4abb72 47 if (!err) {
Christopher Haster 90:0a988e4abb72 48 void *socket = _socket;
Christopher Haster 90:0a988e4abb72 49 _socket = 0;
Christopher Haster 90:0a988e4abb72 50 _iface->socket_destroy(socket);
Christopher Haster 90:0a988e4abb72 51 }
Christopher Haster 90:0a988e4abb72 52
Christopher Haster 90:0a988e4abb72 53 return err;
Christopher Haster 90:0a988e4abb72 54 }
Christopher Haster 90:0a988e4abb72 55
Christopher Haster 89:b1d417383c0d 56 void Socket::set_blocking(bool blocking)
Christopher Haster 89:b1d417383c0d 57 {
Christopher Haster 89:b1d417383c0d 58 _blocking = blocking;
Christopher Haster 89:b1d417383c0d 59 }
Christopher Haster 89:b1d417383c0d 60
Christopher Haster 89:b1d417383c0d 61 void Socket::set_timeout(unsigned timeout)
Christopher Haster 89:b1d417383c0d 62 {
Christopher Haster 89:b1d417383c0d 63 _timeout = timeout;
Christopher Haster 89:b1d417383c0d 64 }
Christopher Haster 89:b1d417383c0d 65
Christopher Haster 89:b1d417383c0d 66 int Socket::set_option(int optname, const void *optval, unsigned int optlen)
Christopher Haster 89:b1d417383c0d 67 {
Christopher Haster 89:b1d417383c0d 68 if (!_socket) {
Christopher Haster 89:b1d417383c0d 69 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 89:b1d417383c0d 70 }
Christopher Haster 89:b1d417383c0d 71
Christopher Haster 89:b1d417383c0d 72 return _iface->socket_set_option(_socket, optname, optval, optlen);
Christopher Haster 89:b1d417383c0d 73 }
Christopher Haster 89:b1d417383c0d 74
Christopher Haster 89:b1d417383c0d 75 int Socket::get_option(int optname, void *optval, unsigned int *optlen)
Christopher Haster 89:b1d417383c0d 76 {
Christopher Haster 89:b1d417383c0d 77 if (!_socket) {
Christopher Haster 89:b1d417383c0d 78 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 89:b1d417383c0d 79 }
Christopher Haster 89:b1d417383c0d 80
Christopher Haster 89:b1d417383c0d 81 return _iface->socket_get_option(_socket, optname, optval, optlen);
Christopher Haster 89:b1d417383c0d 82 }
Christopher Haster 89:b1d417383c0d 83
Christopher Haster 89:b1d417383c0d 84 void Socket::thunk(void *p)
Christopher Haster 89:b1d417383c0d 85 {
Christopher Haster 89:b1d417383c0d 86 FunctionPointer *fptr = (FunctionPointer *)p;
Christopher Haster 89:b1d417383c0d 87 (*fptr)();
Christopher Haster 89:b1d417383c0d 88 }