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.

UDPSocket.h@98:0f614f1d0398, 2016-04-19 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 19 18:24:57 2016 -0500
Revision:
98:0f614f1d0398
Parent:
96:656011e49d9f
Child:
103:37decbcb1108
Move bind to Socket



Bind can operate on any IP socket and is not specific to a protocol

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 UDPSOCKET_H
Christopher Haster 72:6a8b52ee83ed 18 #define UDPSOCKET_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 /** UDP Socket
Christopher Haster 89:b1d417383c0d 24 */
Christopher Haster 72:6a8b52ee83ed 25 class UDPSocket : public Socket {
Christopher Haster 72:6a8b52ee83ed 26 public:
Christopher Haster 72:6a8b52ee83ed 27 /** UDPSocket lifetime
Christopher Haster 89:b1d417383c0d 28 */
Christopher Haster 90:0a988e4abb72 29 UDPSocket();
Christopher Haster 77:b66a6984ed2d 30 UDPSocket(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 96:656011e49d9f 36
Christopher Haster 96:656011e49d9f 37 /** Send a packet to a remote endpoint
Christopher Haster 96:656011e49d9f 38 * @param host The host to connect to. It can either be an IP Address
Christopher Haster 96:656011e49d9f 39 * or a hostname that will be resolved with DNS
Christopher Haster 96:656011e49d9f 40 * @param port The remote port
Christopher Haster 96:656011e49d9f 41 * @param data The packet to be sent
Christopher Haster 96:656011e49d9f 42 * @param size The length of the packet to be sent
Christopher Haster 96:656011e49d9f 43 * @return The number of written bytes on success, negative on failure
Christopher Haster 96:656011e49d9f 44 */
Christopher Haster 96:656011e49d9f 45 int sendto(const char *host, uint16_t port, const void *data, unsigned size);
Christopher Haster 96:656011e49d9f 46
Christopher Haster 72:6a8b52ee83ed 47 /** Send a packet to a remote endpoint
Christopher Haster 89:b1d417383c0d 48 * @param address The remote SocketAddress
Christopher Haster 89:b1d417383c0d 49 * @param data The packet to be sent
Christopher Haster 89:b1d417383c0d 50 * @param size The length of the packet to be sent
Christopher Haster 89:b1d417383c0d 51 * @return The number of written bytes on success, negative on failure
Christopher Haster 89:b1d417383c0d 52 */
Christopher Haster 80:9c6673c93082 53 int sendto(const SocketAddress &address, const void *data, unsigned size);
Christopher Haster 75:dea0cdb42241 54
Christopher Haster 72:6a8b52ee83ed 55 /** Receive a packet from a remote endpoint
Christopher Haster 89:b1d417383c0d 56 * @param address Destination for the remote SocketAddress or null
Christopher Haster 89:b1d417383c0d 57 * @param buffer The buffer for storing the incoming packet data
Christopher Haster 89:b1d417383c0d 58 * If a packet is too long to fit in the supplied buffer,
Christopher Haster 89:b1d417383c0d 59 * excess bytes are discarded
Christopher Haster 89:b1d417383c0d 60 * @param size The length of the buffer
Christopher Haster 89:b1d417383c0d 61 * @return The number of received bytes on success, negative on failure
Christopher Haster 89:b1d417383c0d 62 */
Christopher Haster 75:dea0cdb42241 63 int recvfrom(SocketAddress *address, void *buffer, unsigned size);
Christopher Haster 72:6a8b52ee83ed 64 };
Christopher Haster 72:6a8b52ee83ed 65
Christopher Haster 72:6a8b52ee83ed 66 #endif