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.

Committer:
dkato
Date:
Wed May 25 02:45:51 2016 +0000
Revision:
125:ea3a618e0818
Parent:
105:2fd212f8da61
Fix the path of DnsQuery.lib

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Christopher Haster 105:2fd212f8da61 1 /* Socket
Christopher Haster 105:2fd212f8da61 2 * Copyright (c) 2015 ARM Limited
Christopher Haster 105:2fd212f8da61 3 *
Christopher Haster 105:2fd212f8da61 4 * Licensed under the Apache License, Version 2.0 (the "License");
Christopher Haster 105:2fd212f8da61 5 * you may not use this file except in compliance with the License.
Christopher Haster 105:2fd212f8da61 6 * You may obtain a copy of the License at
Christopher Haster 105:2fd212f8da61 7 *
Christopher Haster 105:2fd212f8da61 8 * http://www.apache.org/licenses/LICENSE-2.0
Christopher Haster 105:2fd212f8da61 9 *
Christopher Haster 105:2fd212f8da61 10 * Unless required by applicable law or agreed to in writing, software
Christopher Haster 105:2fd212f8da61 11 * distributed under the License is distributed on an "AS IS" BASIS,
Christopher Haster 105:2fd212f8da61 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Christopher Haster 105:2fd212f8da61 13 * See the License for the specific language governing permissions and
Christopher Haster 105:2fd212f8da61 14 * limitations under the License.
Christopher Haster 105:2fd212f8da61 15 */
Christopher Haster 105:2fd212f8da61 16
Christopher Haster 105:2fd212f8da61 17 #include "DnsQuery.h"
Christopher Haster 105:2fd212f8da61 18 #include "mbed.h"
Christopher Haster 105:2fd212f8da61 19
Christopher Haster 105:2fd212f8da61 20 int NetworkStack::gethostbyname(SocketAddress *address, const char *name)
Christopher Haster 105:2fd212f8da61 21 {
Christopher Haster 105:2fd212f8da61 22 char buffer[NSAPI_IP_SIZE];
Christopher Haster 105:2fd212f8da61 23 int err = dnsQuery(this, name, buffer);
Christopher Haster 105:2fd212f8da61 24 if (err) {
Christopher Haster 105:2fd212f8da61 25 return err;
Christopher Haster 105:2fd212f8da61 26 }
Christopher Haster 105:2fd212f8da61 27
Christopher Haster 105:2fd212f8da61 28 address->set_ip_address(buffer);
Christopher Haster 105:2fd212f8da61 29 return 0;
Christopher Haster 105:2fd212f8da61 30 }
Christopher Haster 105:2fd212f8da61 31
Christopher Haster 105:2fd212f8da61 32 int NetworkStack::setstackopt(int level, int optname, const void *optval, unsigned optlen)
Christopher Haster 105:2fd212f8da61 33 {
Christopher Haster 105:2fd212f8da61 34 return NSAPI_ERROR_UNSUPPORTED;
Christopher Haster 105:2fd212f8da61 35 }
Christopher Haster 105:2fd212f8da61 36
Christopher Haster 105:2fd212f8da61 37 int NetworkStack::getstackopt(int level, int optname, void *optval, unsigned *optlen)
Christopher Haster 105:2fd212f8da61 38 {
Christopher Haster 105:2fd212f8da61 39 return NSAPI_ERROR_UNSUPPORTED;
Christopher Haster 105:2fd212f8da61 40 }
Christopher Haster 105:2fd212f8da61 41
Christopher Haster 105:2fd212f8da61 42 int NetworkStack::setsockopt(void *handle, int level, int optname, const void *optval, unsigned optlen)
Christopher Haster 105:2fd212f8da61 43 {
Christopher Haster 105:2fd212f8da61 44 return NSAPI_ERROR_UNSUPPORTED;
Christopher Haster 105:2fd212f8da61 45 }
Christopher Haster 105:2fd212f8da61 46
Christopher Haster 105:2fd212f8da61 47 int NetworkStack::getsockopt(void *handle, int level, int optname, void *optval, unsigned *optlen)
Christopher Haster 105:2fd212f8da61 48 {
Christopher Haster 105:2fd212f8da61 49 return NSAPI_ERROR_UNSUPPORTED;
Christopher Haster 105:2fd212f8da61 50 }