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.

Committer:
Christopher Haster
Date:
Tue Apr 19 18:26:21 2016 -0500
Revision:
104:d28d8b508e7c
Parent:
89:b1d417383c0d
Revised documentation for Interface classes

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Christopher Haster 104:d28d8b508e7c 1 /* MeshInterface
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 #ifndef MESH_INTERFACE_H
Christopher Haster 89:b1d417383c0d 18 #define MESH_INTERFACE_H
Christopher Haster 89:b1d417383c0d 19
Christopher Haster 89:b1d417383c0d 20 #include "NetworkInterface.h"
Christopher Haster 89:b1d417383c0d 21
Christopher Haster 89:b1d417383c0d 22 /** MeshInterface class
Christopher Haster 104:d28d8b508e7c 23 *
Christopher Haster 104:d28d8b508e7c 24 * Common interface that is shared between mesh hardware
Christopher Haster 89:b1d417383c0d 25 */
Christopher Haster 89:b1d417383c0d 26 class MeshInterface : public NetworkInterface
Christopher Haster 89:b1d417383c0d 27 {
Christopher Haster 89:b1d417383c0d 28 public:
Christopher Haster 89:b1d417383c0d 29 /** Start the interface
Christopher Haster 104:d28d8b508e7c 30 *
Christopher Haster 89:b1d417383c0d 31 * @return 0 on success, negative on failure
Christopher Haster 89:b1d417383c0d 32 */
Christopher Haster 89:b1d417383c0d 33 virtual int connect() = 0;
Christopher Haster 89:b1d417383c0d 34
Christopher Haster 89:b1d417383c0d 35 /** Stop the interface
Christopher Haster 104:d28d8b508e7c 36 *
Christopher Haster 89:b1d417383c0d 37 * @return 0 on success, negative on failure
Christopher Haster 89:b1d417383c0d 38 */
Christopher Haster 89:b1d417383c0d 39 virtual int disconnect() = 0;
Christopher Haster 89:b1d417383c0d 40 };
Christopher Haster 89:b1d417383c0d 41
Christopher Haster 89:b1d417383c0d 42 #endif