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.
MeshInterface.h@113:80ba92c5e5ca, 2016-04-20 (annotated)
- Committer:
- Christopher Haster
- Date:
- Wed Apr 20 11:04:24 2016 -0500
- Revision:
- 113:80ba92c5e5ca
- Child:
- 114:964eba6394bc
Separate Stack/Interface concept into two distinct classes
Fixes issue with virtual inheritance and provides a better
separation of concerns.
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Christopher Haster |
113:80ba92c5e5ca | 1 | /* MeshInterface |
Christopher Haster |
113:80ba92c5e5ca | 2 | * Copyright (c) 2015 ARM Limited |
Christopher Haster |
113:80ba92c5e5ca | 3 | * |
Christopher Haster |
113:80ba92c5e5ca | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
Christopher Haster |
113:80ba92c5e5ca | 5 | * you may not use this file except in compliance with the License. |
Christopher Haster |
113:80ba92c5e5ca | 6 | * You may obtain a copy of the License at |
Christopher Haster |
113:80ba92c5e5ca | 7 | * |
Christopher Haster |
113:80ba92c5e5ca | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
Christopher Haster |
113:80ba92c5e5ca | 9 | * |
Christopher Haster |
113:80ba92c5e5ca | 10 | * Unless required by applicable law or agreed to in writing, software |
Christopher Haster |
113:80ba92c5e5ca | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
Christopher Haster |
113:80ba92c5e5ca | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
Christopher Haster |
113:80ba92c5e5ca | 13 | * See the License for the specific language governing permissions and |
Christopher Haster |
113:80ba92c5e5ca | 14 | * limitations under the License. |
Christopher Haster |
113:80ba92c5e5ca | 15 | */ |
Christopher Haster |
113:80ba92c5e5ca | 16 | |
Christopher Haster |
113:80ba92c5e5ca | 17 | #ifndef MESH_INTERFACE_H |
Christopher Haster |
113:80ba92c5e5ca | 18 | #define MESH_INTERFACE_H |
Christopher Haster |
113:80ba92c5e5ca | 19 | |
Christopher Haster |
113:80ba92c5e5ca | 20 | #include "NetworkStack.h" |
Christopher Haster |
113:80ba92c5e5ca | 21 | |
Christopher Haster |
113:80ba92c5e5ca | 22 | /** MeshInterface class |
Christopher Haster |
113:80ba92c5e5ca | 23 | * |
Christopher Haster |
113:80ba92c5e5ca | 24 | * Common interface that is shared between mesh hardware |
Christopher Haster |
113:80ba92c5e5ca | 25 | */ |
Christopher Haster |
113:80ba92c5e5ca | 26 | class MeshInterface |
Christopher Haster |
113:80ba92c5e5ca | 27 | { |
Christopher Haster |
113:80ba92c5e5ca | 28 | public: |
Christopher Haster |
113:80ba92c5e5ca | 29 | /** Start the interface |
Christopher Haster |
113:80ba92c5e5ca | 30 | * |
Christopher Haster |
113:80ba92c5e5ca | 31 | * @return 0 on success, negative on failure |
Christopher Haster |
113:80ba92c5e5ca | 32 | */ |
Christopher Haster |
113:80ba92c5e5ca | 33 | virtual int connect() = 0; |
Christopher Haster |
113:80ba92c5e5ca | 34 | |
Christopher Haster |
113:80ba92c5e5ca | 35 | /** Stop the interface |
Christopher Haster |
113:80ba92c5e5ca | 36 | * |
Christopher Haster |
113:80ba92c5e5ca | 37 | * @return 0 on success, negative on failure |
Christopher Haster |
113:80ba92c5e5ca | 38 | */ |
Christopher Haster |
113:80ba92c5e5ca | 39 | virtual int disconnect() = 0; |
Christopher Haster |
113:80ba92c5e5ca | 40 | }; |
Christopher Haster |
113:80ba92c5e5ca | 41 | |
Christopher Haster |
113:80ba92c5e5ca | 42 | #endif |