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@87:94e2cf3a06be, 2016-04-05 (annotated)

Committer:
geky
Date:
Tue Apr 05 23:47:04 2016 +0000
Revision:
87:94e2cf3a06be
Parent:
86:7ca9776b9cc0
Child:
89:b1d417383c0d
Refactored enums

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 "Socket.h"
Christopher Haster 79:43a7e8c0d6cc 18
geky 87:94e2cf3a06be 19 Socket::Socket(NetworkInterface *iface, nsapi_protocol_t proto)
Christopher Haster 79:43a7e8c0d6cc 20 : _iface(iface)
geky 86:7ca9776b9cc0 21 , _blocking(true)
geky 86:7ca9776b9cc0 22 , _timeout(0)
Christopher Haster 79:43a7e8c0d6cc 23 {
Christopher Haster 79:43a7e8c0d6cc 24 _socket = _iface->socket_create(proto);
Christopher Haster 79:43a7e8c0d6cc 25 }
Christopher Haster 79:43a7e8c0d6cc 26
Christopher Haster 79:43a7e8c0d6cc 27 Socket::~Socket()
Christopher Haster 79:43a7e8c0d6cc 28 {
Christopher Haster 79:43a7e8c0d6cc 29 if (_socket) {
Christopher Haster 79:43a7e8c0d6cc 30 close(false);
Christopher Haster 79:43a7e8c0d6cc 31 }
Christopher Haster 79:43a7e8c0d6cc 32 }
Christopher Haster 79:43a7e8c0d6cc 33
Christopher Haster 79:43a7e8c0d6cc 34 void Socket::set_blocking(bool blocking)
Christopher Haster 79:43a7e8c0d6cc 35 {
Christopher Haster 79:43a7e8c0d6cc 36 _blocking = blocking;
Christopher Haster 79:43a7e8c0d6cc 37 }
Christopher Haster 79:43a7e8c0d6cc 38
Christopher Haster 79:43a7e8c0d6cc 39 void Socket::set_timeout(unsigned timeout)
Christopher Haster 79:43a7e8c0d6cc 40 {
Christopher Haster 79:43a7e8c0d6cc 41 _timeout = timeout;
Christopher Haster 79:43a7e8c0d6cc 42 }
Christopher Haster 79:43a7e8c0d6cc 43
Christopher Haster 79:43a7e8c0d6cc 44 int Socket::set_option(int optname, const void *optval, unsigned int optlen)
Christopher Haster 79:43a7e8c0d6cc 45 {
Christopher Haster 79:43a7e8c0d6cc 46 if (!_socket) {
Christopher Haster 79:43a7e8c0d6cc 47 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 79:43a7e8c0d6cc 48 }
Christopher Haster 79:43a7e8c0d6cc 49
Christopher Haster 79:43a7e8c0d6cc 50 return _iface->socket_set_option(_socket, optname, optval, optlen);
Christopher Haster 79:43a7e8c0d6cc 51 }
Christopher Haster 79:43a7e8c0d6cc 52
Christopher Haster 79:43a7e8c0d6cc 53 int Socket::get_option(int optname, void *optval, unsigned int *optlen)
Christopher Haster 79:43a7e8c0d6cc 54 {
Christopher Haster 79:43a7e8c0d6cc 55 if (!_socket) {
Christopher Haster 79:43a7e8c0d6cc 56 return NSAPI_ERROR_NO_SOCKET;
Christopher Haster 79:43a7e8c0d6cc 57 }
Christopher Haster 79:43a7e8c0d6cc 58
Christopher Haster 79:43a7e8c0d6cc 59 return _iface->socket_get_option(_socket, optname, optval, optlen);
Christopher Haster 79:43a7e8c0d6cc 60 }
Christopher Haster 79:43a7e8c0d6cc 61
Christopher Haster 79:43a7e8c0d6cc 62 int Socket::close(bool shutdown)
Christopher Haster 79:43a7e8c0d6cc 63 {
Christopher Haster 79:43a7e8c0d6cc 64 if (!_socket) {
Christopher Haster 79:43a7e8c0d6cc 65 return 0;
Christopher Haster 79:43a7e8c0d6cc 66 }
Christopher Haster 79:43a7e8c0d6cc 67
Christopher Haster 79:43a7e8c0d6cc 68 int err = _iface->socket_close(_socket, shutdown);
Christopher Haster 79:43a7e8c0d6cc 69 if (!err) {
Christopher Haster 79:43a7e8c0d6cc 70 void *socket = _socket;
Christopher Haster 79:43a7e8c0d6cc 71 _socket = 0;
Christopher Haster 79:43a7e8c0d6cc 72 _iface->socket_destroy(socket);
Christopher Haster 79:43a7e8c0d6cc 73 }
Christopher Haster 79:43a7e8c0d6cc 74
Christopher Haster 79:43a7e8c0d6cc 75 return err;
Christopher Haster 79:43a7e8c0d6cc 76 }
Christopher Haster 79:43a7e8c0d6cc 77
geky 84:d317e056fd20 78 void Socket::thunk(void *p)
geky 84:d317e056fd20 79 {
geky 84:d317e056fd20 80 mbed::FuncPtr<void()> *fptr = (mbed::FuncPtr<void()> *)p;
geky 84:d317e056fd20 81 (*fptr)();
geky 84:d317e056fd20 82 }