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.h@38:157fb2ab965f, 2016-02-22 (annotated)

Committer:
Christopher Haster
Date:
Mon Feb 22 20:51:09 2016 -0600
Branch:
api-changes
Revision:
38:157fb2ab965f
Parent:
34:c17745683385
Child:
41:3ec1c97e9bbf
Added isConnected method to Socket/SocketInterface

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Christopher Haster 25:ed7b2a52e8ac 1 /* Socket
Christopher Haster 25:ed7b2a52e8ac 2 * Copyright (c) 2015 ARM Limited
Christopher Haster 25:ed7b2a52e8ac 3 *
Christopher Haster 25:ed7b2a52e8ac 4 * Licensed under the Apache License, Version 2.0 (the "License");
Christopher Haster 25:ed7b2a52e8ac 5 * you may not use this file except in compliance with the License.
Christopher Haster 25:ed7b2a52e8ac 6 * You may obtain a copy of the License at
Christopher Haster 25:ed7b2a52e8ac 7 *
Christopher Haster 25:ed7b2a52e8ac 8 * http://www.apache.org/licenses/LICENSE-2.0
Christopher Haster 25:ed7b2a52e8ac 9 *
Christopher Haster 25:ed7b2a52e8ac 10 * Unless required by applicable law or agreed to in writing, software
Christopher Haster 25:ed7b2a52e8ac 11 * distributed under the License is distributed on an "AS IS" BASIS,
Christopher Haster 25:ed7b2a52e8ac 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Christopher Haster 25:ed7b2a52e8ac 13 * See the License for the specific language governing permissions and
Christopher Haster 25:ed7b2a52e8ac 14 * limitations under the License.
Christopher Haster 25:ed7b2a52e8ac 15 */
Christopher Haster 25:ed7b2a52e8ac 16
Christopher Haster 25:ed7b2a52e8ac 17 #ifndef SOCKET_H
Christopher Haster 25:ed7b2a52e8ac 18 #define SOCKET_H
Christopher Haster 25:ed7b2a52e8ac 19
Christopher Haster 25:ed7b2a52e8ac 20 #include "NetworkInterface.h"
Christopher Haster 25:ed7b2a52e8ac 21
Christopher Haster 25:ed7b2a52e8ac 22 /** Abstract socket class
Christopher Haster 25:ed7b2a52e8ac 23 * API for handling general sockets. Supports IP address operations
Christopher Haster 25:ed7b2a52e8ac 24 * and sending/recieving data.
Christopher Haster 25:ed7b2a52e8ac 25 */
Christopher Haster 25:ed7b2a52e8ac 26 class Socket
Christopher Haster 25:ed7b2a52e8ac 27 {
Christopher Haster 25:ed7b2a52e8ac 28 public:
Christopher Haster 25:ed7b2a52e8ac 29 /** Set the URL of the socket
Christopher Haster 25:ed7b2a52e8ac 30 * Performs DNS lookup if necessary
Christopher Haster 25:ed7b2a52e8ac 31 * @param url URL to connect to
Christopher Haster 27:d7ed39727306 32 * @return 0 on success
Christopher Haster 25:ed7b2a52e8ac 33 */
Christopher Haster 34:c17745683385 34 int32_t setURL(const char *url);
Christopher Haster 25:ed7b2a52e8ac 35
Christopher Haster 25:ed7b2a52e8ac 36 /** Set the IP address of the socket
Christopher Haster 25:ed7b2a52e8ac 37 * @param ip IP address to connect to, copied internally
Christopher Haster 25:ed7b2a52e8ac 38 */
Christopher Haster 34:c17745683385 39 void setIPAddress(const char *ip);
Christopher Haster 25:ed7b2a52e8ac 40
Christopher Haster 25:ed7b2a52e8ac 41 /** Set the port of the socket
Christopher Haster 25:ed7b2a52e8ac 42 * @param port Port to connect to
Christopher Haster 25:ed7b2a52e8ac 43 */
Christopher Haster 25:ed7b2a52e8ac 44 void setPort(uint16_t port);
Christopher Haster 25:ed7b2a52e8ac 45
Christopher Haster 25:ed7b2a52e8ac 46 /** Gets the IP address
Christopher Haster 25:ed7b2a52e8ac 47 * @return IP address to connect to
Christopher Haster 25:ed7b2a52e8ac 48 */
Christopher Haster 28:163fbe3263f4 49 const char *getIPAddress() const;
Christopher Haster 25:ed7b2a52e8ac 50
Christopher Haster 25:ed7b2a52e8ac 51 /** Gets the port
Christopher Haster 25:ed7b2a52e8ac 52 * @return Port to connect to
Christopher Haster 25:ed7b2a52e8ac 53 */
Christopher Haster 28:163fbe3263f4 54 uint16_t getPort() const;
Christopher Haster 25:ed7b2a52e8ac 55
Christopher Haster 38:157fb2ab965f 56 /** Returns status of socket
Christopher Haster 38:157fb2ab965f 57 * @return true if connected
Christopher Haster 38:157fb2ab965f 58 */
Christopher Haster 38:157fb2ab965f 59 bool isConnected();
Christopher Haster 38:157fb2ab965f 60
Christopher Haster 25:ed7b2a52e8ac 61
Christopher Haster 32:2c5fc105fc50 62 /** Open a connection to the underlying address
Christopher Haster 34:c17745683385 63 * @param url Optional URL or IP address to connect to
Christopher Haster 34:c17745683385 64 * @param port Optional port to connect to
Christopher Haster 32:2c5fc105fc50 65 * @return 0 on success
Christopher Haster 32:2c5fc105fc50 66 */
Christopher Haster 34:c17745683385 67 int32_t open(const char *url = 0, uint16_t port = 0);
Christopher Haster 32:2c5fc105fc50 68
Christopher Haster 32:2c5fc105fc50 69 /** Close an open connection
Christopher Haster 32:2c5fc105fc50 70 * @return 0 on success
Christopher Haster 32:2c5fc105fc50 71 */
Christopher Haster 32:2c5fc105fc50 72 int32_t close();
Christopher Haster 32:2c5fc105fc50 73
Christopher Haster 25:ed7b2a52e8ac 74 /** Send data over the socket
Christopher Haster 25:ed7b2a52e8ac 75 * @param data Buffer of data to send
Christopher Haster 25:ed7b2a52e8ac 76 * @param len Size of data to send
Christopher Haster 25:ed7b2a52e8ac 77 * @param timeout_ms Maximum amount of time to wait
Christopher Haster 25:ed7b2a52e8ac 78 * @return 0 on success
Christopher Haster 25:ed7b2a52e8ac 79 */
Christopher Haster 25:ed7b2a52e8ac 80 int32_t send(const void *data, uint32_t len, uint32_t timeout_ms = 15000);
Christopher Haster 25:ed7b2a52e8ac 81
Christopher Haster 25:ed7b2a52e8ac 82 /** Recieve data over the socket
Christopher Haster 25:ed7b2a52e8ac 83 * @param data Buffer to store recieved data
Christopher Haster 25:ed7b2a52e8ac 84 * @param len Size of provided buffer
Christopher Haster 25:ed7b2a52e8ac 85 * @param timeout_ms Maximum amount of time to wait
Christopher Haster 25:ed7b2a52e8ac 86 * @return Number of bytes sent or a negative value on failure
Christopher Haster 25:ed7b2a52e8ac 87 */
Christopher Haster 25:ed7b2a52e8ac 88 int32_t recv(void *data, uint32_t len, uint32_t timeout_ms = 15000);
Christopher Haster 25:ed7b2a52e8ac 89
Christopher Haster 25:ed7b2a52e8ac 90
Christopher Haster 25:ed7b2a52e8ac 91 protected:
Christopher Haster 28:163fbe3263f4 92 Socket(NetworkInterface *iface, socket_protocol_t proto);
Christopher Haster 25:ed7b2a52e8ac 93 ~Socket();
Christopher Haster 25:ed7b2a52e8ac 94
Christopher Haster 25:ed7b2a52e8ac 95 private:
Christopher Haster 25:ed7b2a52e8ac 96 NetworkInterface *_iface;
Christopher Haster 25:ed7b2a52e8ac 97 socket_protocol_t _proto;
Christopher Haster 25:ed7b2a52e8ac 98 SocketInterface *_socket;
Christopher Haster 27:d7ed39727306 99
Christopher Haster 28:163fbe3263f4 100 char _ip_address[SOCK_IP_SIZE];
Christopher Haster 28:163fbe3263f4 101 uint16_t _port;
Christopher Haster 25:ed7b2a52e8ac 102 };
Christopher Haster 25:ed7b2a52e8ac 103
Christopher Haster 25:ed7b2a52e8ac 104 #endif