ON Semiconductor / mbed-os

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

features/netsocket/NetworkInterface.h@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
group-onsemi 0:098463de4c5d 1
group-onsemi 0:098463de4c5d 2 /** \addtogroup netsocket */
group-onsemi 0:098463de4c5d 3 /** @{*/
group-onsemi 0:098463de4c5d 4 /* NetworkStack
group-onsemi 0:098463de4c5d 5 * Copyright (c) 2015 ARM Limited
group-onsemi 0:098463de4c5d 6 *
group-onsemi 0:098463de4c5d 7 * Licensed under the Apache License, Version 2.0 (the "License");
group-onsemi 0:098463de4c5d 8 * you may not use this file except in compliance with the License.
group-onsemi 0:098463de4c5d 9 * You may obtain a copy of the License at
group-onsemi 0:098463de4c5d 10 *
group-onsemi 0:098463de4c5d 11 * http://www.apache.org/licenses/LICENSE-2.0
group-onsemi 0:098463de4c5d 12 *
group-onsemi 0:098463de4c5d 13 * Unless required by applicable law or agreed to in writing, software
group-onsemi 0:098463de4c5d 14 * distributed under the License is distributed on an "AS IS" BASIS,
group-onsemi 0:098463de4c5d 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
group-onsemi 0:098463de4c5d 16 * See the License for the specific language governing permissions and
group-onsemi 0:098463de4c5d 17 * limitations under the License.
group-onsemi 0:098463de4c5d 18 */
group-onsemi 0:098463de4c5d 19
group-onsemi 0:098463de4c5d 20 #ifndef NETWORK_INTERFACE_H
group-onsemi 0:098463de4c5d 21 #define NETWORK_INTERFACE_H
group-onsemi 0:098463de4c5d 22
group-onsemi 0:098463de4c5d 23 #include "netsocket/nsapi_types.h"
group-onsemi 0:098463de4c5d 24 #include "netsocket/SocketAddress.h"
group-onsemi 0:098463de4c5d 25
group-onsemi 0:098463de4c5d 26 // Predeclared class
group-onsemi 0:098463de4c5d 27 class NetworkStack;
group-onsemi 0:098463de4c5d 28
group-onsemi 0:098463de4c5d 29
group-onsemi 0:098463de4c5d 30 /** NetworkInterface class
group-onsemi 0:098463de4c5d 31 *
group-onsemi 0:098463de4c5d 32 * Common interface that is shared between network devices
group-onsemi 0:098463de4c5d 33 */
group-onsemi 0:098463de4c5d 34 class NetworkInterface {
group-onsemi 0:098463de4c5d 35 public:
group-onsemi 0:098463de4c5d 36 virtual ~NetworkInterface() {};
group-onsemi 0:098463de4c5d 37
group-onsemi 0:098463de4c5d 38 /** Get the local MAC address
group-onsemi 0:098463de4c5d 39 *
group-onsemi 0:098463de4c5d 40 * Provided MAC address is intended for info or debug purposes and
group-onsemi 0:098463de4c5d 41 * may not be provided if the underlying network interface does not
group-onsemi 0:098463de4c5d 42 * provide a MAC address
group-onsemi 0:098463de4c5d 43 *
group-onsemi 0:098463de4c5d 44 * @return Null-terminated representation of the local MAC address
group-onsemi 0:098463de4c5d 45 * or null if no MAC address is available
group-onsemi 0:098463de4c5d 46 */
group-onsemi 0:098463de4c5d 47 virtual const char *get_mac_address();
group-onsemi 0:098463de4c5d 48
group-onsemi 0:098463de4c5d 49 /** Get the local IP address
group-onsemi 0:098463de4c5d 50 *
group-onsemi 0:098463de4c5d 51 * @return Null-terminated representation of the local IP address
group-onsemi 0:098463de4c5d 52 * or null if no IP address has been recieved
group-onsemi 0:098463de4c5d 53 */
group-onsemi 0:098463de4c5d 54 virtual const char *get_ip_address();
group-onsemi 0:098463de4c5d 55
group-onsemi 0:098463de4c5d 56 /** Get the local network mask
group-onsemi 0:098463de4c5d 57 *
group-onsemi 0:098463de4c5d 58 * @return Null-terminated representation of the local network mask
group-onsemi 0:098463de4c5d 59 * or null if no network mask has been recieved
group-onsemi 0:098463de4c5d 60 */
group-onsemi 0:098463de4c5d 61 virtual const char *get_netmask();
group-onsemi 0:098463de4c5d 62
group-onsemi 0:098463de4c5d 63 /** Get the local gateway
group-onsemi 0:098463de4c5d 64 *
group-onsemi 0:098463de4c5d 65 * @return Null-terminated representation of the local gateway
group-onsemi 0:098463de4c5d 66 * or null if no network mask has been recieved
group-onsemi 0:098463de4c5d 67 */
group-onsemi 0:098463de4c5d 68 virtual const char *get_gateway();
group-onsemi 0:098463de4c5d 69
group-onsemi 0:098463de4c5d 70 /** Set a static IP address
group-onsemi 0:098463de4c5d 71 *
group-onsemi 0:098463de4c5d 72 * Configures this network interface to use a static IP address.
group-onsemi 0:098463de4c5d 73 * Implicitly disables DHCP, which can be enabled in set_dhcp.
group-onsemi 0:098463de4c5d 74 * Requires that the network is disconnected.
group-onsemi 0:098463de4c5d 75 *
group-onsemi 0:098463de4c5d 76 * @param address Null-terminated representation of the local IP address
group-onsemi 0:098463de4c5d 77 * @param netmask Null-terminated representation of the local network mask
group-onsemi 0:098463de4c5d 78 * @param gateway Null-terminated representation of the local gateway
group-onsemi 0:098463de4c5d 79 * @return 0 on success, negative error code on failure
group-onsemi 0:098463de4c5d 80 */
group-onsemi 0:098463de4c5d 81 virtual nsapi_error_t set_network(
group-onsemi 0:098463de4c5d 82 const char *ip_address, const char *netmask, const char *gateway);
group-onsemi 0:098463de4c5d 83
group-onsemi 0:098463de4c5d 84 /** Enable or disable DHCP on the network
group-onsemi 0:098463de4c5d 85 *
group-onsemi 0:098463de4c5d 86 * Enables DHCP on connecting the network. Defaults to enabled unless
group-onsemi 0:098463de4c5d 87 * a static IP address has been assigned. Requires that the network is
group-onsemi 0:098463de4c5d 88 * disconnected.
group-onsemi 0:098463de4c5d 89 *
group-onsemi 0:098463de4c5d 90 * @param dhcp True to enable DHCP
group-onsemi 0:098463de4c5d 91 * @return 0 on success, negative error code on failure
group-onsemi 0:098463de4c5d 92 */
group-onsemi 0:098463de4c5d 93 virtual nsapi_error_t set_dhcp(bool dhcp);
group-onsemi 0:098463de4c5d 94
group-onsemi 0:098463de4c5d 95 /** Start the interface
group-onsemi 0:098463de4c5d 96 *
group-onsemi 0:098463de4c5d 97 * @return 0 on success, negative error code on failure
group-onsemi 0:098463de4c5d 98 */
group-onsemi 0:098463de4c5d 99 virtual nsapi_error_t connect() = 0;
group-onsemi 0:098463de4c5d 100
group-onsemi 0:098463de4c5d 101 /** Stop the interface
group-onsemi 0:098463de4c5d 102 *
group-onsemi 0:098463de4c5d 103 * @return 0 on success, negative error code on failure
group-onsemi 0:098463de4c5d 104 */
group-onsemi 0:098463de4c5d 105 virtual nsapi_error_t disconnect() = 0;
group-onsemi 0:098463de4c5d 106
group-onsemi 0:098463de4c5d 107 /** Translates a hostname to an IP address with specific version
group-onsemi 0:098463de4c5d 108 *
group-onsemi 0:098463de4c5d 109 * The hostname may be either a domain name or an IP address. If the
group-onsemi 0:098463de4c5d 110 * hostname is an IP address, no network transactions will be performed.
group-onsemi 0:098463de4c5d 111 *
group-onsemi 0:098463de4c5d 112 * If no stack-specific DNS resolution is provided, the hostname
group-onsemi 0:098463de4c5d 113 * will be resolve using a UDP socket on the stack.
group-onsemi 0:098463de4c5d 114 *
group-onsemi 0:098463de4c5d 115 * @param address Destination for the host SocketAddress
group-onsemi 0:098463de4c5d 116 * @param host Hostname to resolve
group-onsemi 0:098463de4c5d 117 * @param version IP version of address to resolve, NSAPI_UNSPEC indicates
group-onsemi 0:098463de4c5d 118 * version is chosen by the stack (defaults to NSAPI_UNSPEC)
group-onsemi 0:098463de4c5d 119 * @return 0 on success, negative error code on failure
group-onsemi 0:098463de4c5d 120 */
group-onsemi 0:098463de4c5d 121 virtual nsapi_error_t gethostbyname(const char *host,
group-onsemi 0:098463de4c5d 122 SocketAddress *address, nsapi_version_t version = NSAPI_UNSPEC);
group-onsemi 0:098463de4c5d 123
group-onsemi 0:098463de4c5d 124 /** Add a domain name server to list of servers to query
group-onsemi 0:098463de4c5d 125 *
group-onsemi 0:098463de4c5d 126 * @param addr Destination for the host address
group-onsemi 0:098463de4c5d 127 * @return 0 on success, negative error code on failure
group-onsemi 0:098463de4c5d 128 */
group-onsemi 0:098463de4c5d 129 virtual nsapi_error_t add_dns_server(const SocketAddress &address);
group-onsemi 0:098463de4c5d 130
group-onsemi 0:098463de4c5d 131 protected:
group-onsemi 0:098463de4c5d 132 friend class Socket;
group-onsemi 0:098463de4c5d 133 friend class UDPSocket;
group-onsemi 0:098463de4c5d 134 friend class TCPSocket;
group-onsemi 0:098463de4c5d 135 friend class TCPServer;
group-onsemi 0:098463de4c5d 136 friend class SocketAddress;
group-onsemi 0:098463de4c5d 137 template <typename IF>
group-onsemi 0:098463de4c5d 138 friend NetworkStack *nsapi_create_stack(IF *iface);
group-onsemi 0:098463de4c5d 139
group-onsemi 0:098463de4c5d 140 /** Provide access to the NetworkStack object
group-onsemi 0:098463de4c5d 141 *
group-onsemi 0:098463de4c5d 142 * @return The underlying NetworkStack object
group-onsemi 0:098463de4c5d 143 */
group-onsemi 0:098463de4c5d 144 virtual NetworkStack *get_stack() = 0;
group-onsemi 0:098463de4c5d 145 };
group-onsemi 0:098463de4c5d 146
group-onsemi 0:098463de4c5d 147
group-onsemi 0:098463de4c5d 148 #endif
group-onsemi 0:098463de4c5d 149
group-onsemi 0:098463de4c5d 150 /** @}*/