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@89:b1d417383c0d, 2016-04-19 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 19 18:20:38 2016 -0500
Revision:
89:b1d417383c0d
Parent:
86:7ca9776b9cc0
Child:
94:644df37bb05b
Adopt mbed style doxygen comments

Who changed what in which revision?

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