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.

SocketAddress.cpp@80:9c6673c93082, 2016-04-05 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 05 12:02:56 2016 -0500
Revision:
80:9c6673c93082
Parent:
79:43a7e8c0d6cc
Child:
86:7ca9776b9cc0
Added support for DNS resolution

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Christopher Haster 79:43a7e8c0d6cc 1 /* Socket
Christopher Haster 79:43a7e8c0d6cc 2 * Copyright (c) 2015 ARM Limited
Christopher Haster 79:43a7e8c0d6cc 3 *
Christopher Haster 79:43a7e8c0d6cc 4 * Licensed under the Apache License, Version 2.0 (the "License");
Christopher Haster 79:43a7e8c0d6cc 5 * you may not use this file except in compliance with the License.
Christopher Haster 79:43a7e8c0d6cc 6 * You may obtain a copy of the License at
Christopher Haster 79:43a7e8c0d6cc 7 *
Christopher Haster 79:43a7e8c0d6cc 8 * http://www.apache.org/licenses/LICENSE-2.0
Christopher Haster 79:43a7e8c0d6cc 9 *
Christopher Haster 79:43a7e8c0d6cc 10 * Unless required by applicable law or agreed to in writing, software
Christopher Haster 79:43a7e8c0d6cc 11 * distributed under the License is distributed on an "AS IS" BASIS,
Christopher Haster 79:43a7e8c0d6cc 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Christopher Haster 79:43a7e8c0d6cc 13 * See the License for the specific language governing permissions and
Christopher Haster 79:43a7e8c0d6cc 14 * limitations under the License.
Christopher Haster 79:43a7e8c0d6cc 15 */
Christopher Haster 79:43a7e8c0d6cc 16
Christopher Haster 79:43a7e8c0d6cc 17 #include "SocketAddress.h"
Christopher Haster 80:9c6673c93082 18 #include "NetworkInterface.h"
Christopher Haster 79:43a7e8c0d6cc 19 #include <string.h>
Christopher Haster 79:43a7e8c0d6cc 20
Christopher Haster 80:9c6673c93082 21 SocketAddress::SocketAddress(NetworkInterface *iface, const char *host, uint16_t port)
Christopher Haster 80:9c6673c93082 22 {
Christopher Haster 80:9c6673c93082 23 int err = iface->gethostbyname(host, _ip_address);
Christopher Haster 80:9c6673c93082 24 set_port(port);
Christopher Haster 80:9c6673c93082 25
Christopher Haster 80:9c6673c93082 26 if (err) {
Christopher Haster 80:9c6673c93082 27 _ip_address[0] = '\0';
Christopher Haster 80:9c6673c93082 28 _port = 0;
Christopher Haster 80:9c6673c93082 29 }
Christopher Haster 80:9c6673c93082 30 }
Christopher Haster 80:9c6673c93082 31
Christopher Haster 79:43a7e8c0d6cc 32 SocketAddress::SocketAddress(const char *addr, uint16_t port)
Christopher Haster 79:43a7e8c0d6cc 33 {
Christopher Haster 79:43a7e8c0d6cc 34 set_ip_address(addr);
Christopher Haster 79:43a7e8c0d6cc 35 set_port(port);
Christopher Haster 79:43a7e8c0d6cc 36 }
Christopher Haster 79:43a7e8c0d6cc 37
Christopher Haster 79:43a7e8c0d6cc 38 SocketAddress::SocketAddress(const SocketAddress &addr)
Christopher Haster 79:43a7e8c0d6cc 39 {
Christopher Haster 79:43a7e8c0d6cc 40 set_ip_address(addr.get_ip_address());
Christopher Haster 79:43a7e8c0d6cc 41 set_port(addr.get_port());
Christopher Haster 79:43a7e8c0d6cc 42 }
Christopher Haster 79:43a7e8c0d6cc 43
Christopher Haster 79:43a7e8c0d6cc 44 void SocketAddress::set_ip_address(const char *addr)
Christopher Haster 79:43a7e8c0d6cc 45 {
Christopher Haster 79:43a7e8c0d6cc 46 strncpy(_ip_address, addr, sizeof _ip_address);
Christopher Haster 79:43a7e8c0d6cc 47 _ip_address[sizeof _ip_address - 1] = '\0';
Christopher Haster 79:43a7e8c0d6cc 48 }
Christopher Haster 79:43a7e8c0d6cc 49
Christopher Haster 79:43a7e8c0d6cc 50 void SocketAddress::set_port(uint16_t port)
Christopher Haster 79:43a7e8c0d6cc 51 {
Christopher Haster 79:43a7e8c0d6cc 52 _port = port;
Christopher Haster 79:43a7e8c0d6cc 53 }
Christopher Haster 79:43a7e8c0d6cc 54
Christopher Haster 79:43a7e8c0d6cc 55 const char *SocketAddress::get_ip_address() const
Christopher Haster 79:43a7e8c0d6cc 56 {
Christopher Haster 80:9c6673c93082 57 if (!_ip_address[0]) {
Christopher Haster 80:9c6673c93082 58 return 0;
Christopher Haster 80:9c6673c93082 59 }
Christopher Haster 79:43a7e8c0d6cc 60 return _ip_address;
Christopher Haster 79:43a7e8c0d6cc 61 }
Christopher Haster 79:43a7e8c0d6cc 62
Christopher Haster 79:43a7e8c0d6cc 63 uint16_t SocketAddress::get_port() const
Christopher Haster 79:43a7e8c0d6cc 64 {
Christopher Haster 79:43a7e8c0d6cc 65 return _port;
Christopher Haster 79:43a7e8c0d6cc 66 }