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.

TCPSocket.h@92:dd5f19874adf, 2016-04-19 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 19 18:23:29 2016 -0500
Revision:
92:dd5f19874adf
Parent:
90:0a988e4abb72
Child:
102:9002476b9136
Move to single state-change interrupt



Pros

- Easier to implement

- More similar to SIGIO in BDS sockets



Cons

- Less information, but this information had a high risk of being

  faulty/spurious

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Christopher Haster 78:0914f9b9b24b 1 /* Socket
Christopher Haster 78:0914f9b9b24b 2 * Copyright (c) 2015 ARM Limited
Christopher Haster 72:6a8b52ee83ed 3 *
Christopher Haster 78:0914f9b9b24b 4 * Licensed under the Apache License, Version 2.0 (the "License");
Christopher Haster 78:0914f9b9b24b 5 * you may not use this file except in compliance with the License.
Christopher Haster 78:0914f9b9b24b 6 * You may obtain a copy of the License at
Christopher Haster 72:6a8b52ee83ed 7 *
Christopher Haster 78:0914f9b9b24b 8 * http://www.apache.org/licenses/LICENSE-2.0
Christopher Haster 72:6a8b52ee83ed 9 *
Christopher Haster 78:0914f9b9b24b 10 * Unless required by applicable law or agreed to in writing, software
Christopher Haster 78:0914f9b9b24b 11 * distributed under the License is distributed on an "AS IS" BASIS,
Christopher Haster 78:0914f9b9b24b 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Christopher Haster 78:0914f9b9b24b 13 * See the License for the specific language governing permissions and
Christopher Haster 78:0914f9b9b24b 14 * limitations under the License.
Christopher Haster 72:6a8b52ee83ed 15 */
Christopher Haster 72:6a8b52ee83ed 16
Christopher Haster 72:6a8b52ee83ed 17 #ifndef TCPSOCKET_H
Christopher Haster 72:6a8b52ee83ed 18 #define TCPSOCKET_H
Christopher Haster 72:6a8b52ee83ed 19
Christopher Haster 72:6a8b52ee83ed 20 #include "Socket.h"
Christopher Haster 77:b66a6984ed2d 21 #include "NetworkInterface.h"
Christopher Haster 72:6a8b52ee83ed 22
Christopher Haster 89:b1d417383c0d 23 /** TCP socket connection
Christopher Haster 89:b1d417383c0d 24 */
Christopher Haster 72:6a8b52ee83ed 25 class TCPSocket : public Socket {
Christopher Haster 72:6a8b52ee83ed 26 public:
Christopher Haster 72:6a8b52ee83ed 27 /** TCP socket lifetime
Christopher Haster 89:b1d417383c0d 28 */
Christopher Haster 90:0a988e4abb72 29 TCPSocket();
Christopher Haster 77:b66a6984ed2d 30 TCPSocket(NetworkInterface *iface);
Christopher Haster 90:0a988e4abb72 31
Christopher Haster 90:0a988e4abb72 32 /** Open the socket
Christopher Haster 90:0a988e4abb72 33 * @param iface Interface to open socket on
Christopher Haster 90:0a988e4abb72 34 */
Christopher Haster 90:0a988e4abb72 35 virtual int open(NetworkInterface *iface);
Christopher Haster 72:6a8b52ee83ed 36
Christopher Haster 72:6a8b52ee83ed 37 /** Connects this TCP socket to the server
Christopher Haster 89:b1d417383c0d 38 * @param host The host to connect to. It can either be an IP Address
Christopher Haster 89:b1d417383c0d 39 * or a hostname that will be resolved with DNS
Christopher Haster 89:b1d417383c0d 40 * @param port The host's port to connect to
Christopher Haster 89:b1d417383c0d 41 * @return 0 on success, negative on failure
Christopher Haster 89:b1d417383c0d 42 */
Christopher Haster 79:43a7e8c0d6cc 43 int connect(const char *host, uint16_t port);
Christopher Haster 75:dea0cdb42241 44
Christopher Haster 75:dea0cdb42241 45 /** Connects this TCP socket to the server
Christopher Haster 89:b1d417383c0d 46 * @param address SocketAddress to connect to
Christopher Haster 89:b1d417383c0d 47 * @return 0 on success, negative on failure
Christopher Haster 89:b1d417383c0d 48 */
Christopher Haster 80:9c6673c93082 49 int connect(const SocketAddress &address);
Christopher Haster 72:6a8b52ee83ed 50
Christopher Haster 72:6a8b52ee83ed 51 /** Check if the socket is connected
Christopher Haster 89:b1d417383c0d 52 * @return true if connected, false otherwise
Christopher Haster 89:b1d417383c0d 53 */
Christopher Haster 76:bbe51641f405 54 bool is_connected();
Christopher Haster 72:6a8b52ee83ed 55
Christopher Haster 72:6a8b52ee83ed 56 /** Send data to the remote host
Christopher Haster 89:b1d417383c0d 57 * @param data The buffer to send to the host
Christopher Haster 89:b1d417383c0d 58 * @param size The length of the buffer to send
Christopher Haster 89:b1d417383c0d 59 * @return Number of written bytes on success, negative on failure
Christopher Haster 89:b1d417383c0d 60 */
Christopher Haster 72:6a8b52ee83ed 61 int send(const void *data, unsigned size);
Christopher Haster 72:6a8b52ee83ed 62
Christopher Haster 72:6a8b52ee83ed 63 /** Receive data from the remote host
Christopher Haster 89:b1d417383c0d 64 * @param data The buffer in which to store the data received from the host
Christopher Haster 89:b1d417383c0d 65 * @param size The maximum length of the buffer
Christopher Haster 89:b1d417383c0d 66 * @return Number of received bytes on success, negative on failure
Christopher Haster 89:b1d417383c0d 67 */
Christopher Haster 73:968f7b32278f 68 int recv(void *data, unsigned size);
Christopher Haster 73:968f7b32278f 69
Christopher Haster 79:43a7e8c0d6cc 70 private:
Christopher Haster 79:43a7e8c0d6cc 71 friend class TCPServer;
Christopher Haster 72:6a8b52ee83ed 72 };
Christopher Haster 72:6a8b52ee83ed 73
Christopher Haster 72:6a8b52ee83ed 74 #endif