mbed-os5 only for TYBLE16
Dependents: TYBLE16_simple_data_logger TYBLE16_MP3_Air
features/netsocket/NetworkInterface.h@0:5b88d5760320, 2019-12-17 (annotated)
- Committer:
- kenjiArai
- Date:
- Tue Dec 17 23:23:45 2019 +0000
- Revision:
- 0:5b88d5760320
- Child:
- 1:9db0e321a9f4
mbed-os5 only for TYBLE16
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
kenjiArai | 0:5b88d5760320 | 1 | /* |
kenjiArai | 0:5b88d5760320 | 2 | * Copyright (c) 2015 ARM Limited |
kenjiArai | 0:5b88d5760320 | 3 | * |
kenjiArai | 0:5b88d5760320 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
kenjiArai | 0:5b88d5760320 | 5 | * you may not use this file except in compliance with the License. |
kenjiArai | 0:5b88d5760320 | 6 | * You may obtain a copy of the License at |
kenjiArai | 0:5b88d5760320 | 7 | * |
kenjiArai | 0:5b88d5760320 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
kenjiArai | 0:5b88d5760320 | 9 | * |
kenjiArai | 0:5b88d5760320 | 10 | * Unless required by applicable law or agreed to in writing, software |
kenjiArai | 0:5b88d5760320 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
kenjiArai | 0:5b88d5760320 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
kenjiArai | 0:5b88d5760320 | 13 | * See the License for the specific language governing permissions and |
kenjiArai | 0:5b88d5760320 | 14 | * limitations under the License. |
kenjiArai | 0:5b88d5760320 | 15 | */ |
kenjiArai | 0:5b88d5760320 | 16 | |
kenjiArai | 0:5b88d5760320 | 17 | /** @file NetworkInterface.h Network Interface base class */ |
kenjiArai | 0:5b88d5760320 | 18 | /** @addtogroup netinterface |
kenjiArai | 0:5b88d5760320 | 19 | * Network Interface classes |
kenjiArai | 0:5b88d5760320 | 20 | * @{ */ |
kenjiArai | 0:5b88d5760320 | 21 | |
kenjiArai | 0:5b88d5760320 | 22 | |
kenjiArai | 0:5b88d5760320 | 23 | #ifndef NETWORK_INTERFACE_H |
kenjiArai | 0:5b88d5760320 | 24 | #define NETWORK_INTERFACE_H |
kenjiArai | 0:5b88d5760320 | 25 | |
kenjiArai | 0:5b88d5760320 | 26 | #include "netsocket/nsapi_types.h" |
kenjiArai | 0:5b88d5760320 | 27 | #include "netsocket/SocketAddress.h" |
kenjiArai | 0:5b88d5760320 | 28 | #include "Callback.h" |
kenjiArai | 0:5b88d5760320 | 29 | #include "DNS.h" |
kenjiArai | 0:5b88d5760320 | 30 | |
kenjiArai | 0:5b88d5760320 | 31 | |
kenjiArai | 0:5b88d5760320 | 32 | // Predeclared classes |
kenjiArai | 0:5b88d5760320 | 33 | class NetworkStack; |
kenjiArai | 0:5b88d5760320 | 34 | class EthInterface; |
kenjiArai | 0:5b88d5760320 | 35 | class WiFiInterface; |
kenjiArai | 0:5b88d5760320 | 36 | class MeshInterface; |
kenjiArai | 0:5b88d5760320 | 37 | class CellularInterface; |
kenjiArai | 0:5b88d5760320 | 38 | class EMACInterface; |
kenjiArai | 0:5b88d5760320 | 39 | |
kenjiArai | 0:5b88d5760320 | 40 | /** Common interface that is shared between network devices. |
kenjiArai | 0:5b88d5760320 | 41 | * |
kenjiArai | 0:5b88d5760320 | 42 | */ |
kenjiArai | 0:5b88d5760320 | 43 | class NetworkInterface: public DNS { |
kenjiArai | 0:5b88d5760320 | 44 | public: |
kenjiArai | 0:5b88d5760320 | 45 | |
kenjiArai | 0:5b88d5760320 | 46 | virtual ~NetworkInterface(); |
kenjiArai | 0:5b88d5760320 | 47 | |
kenjiArai | 0:5b88d5760320 | 48 | /** Return the default network interface. |
kenjiArai | 0:5b88d5760320 | 49 | * |
kenjiArai | 0:5b88d5760320 | 50 | * Returns the default network interface, as determined by JSON option |
kenjiArai | 0:5b88d5760320 | 51 | * target.network-default-interface-type or other overrides. |
kenjiArai | 0:5b88d5760320 | 52 | * |
kenjiArai | 0:5b88d5760320 | 53 | * The type of the interface returned can be tested by calling ethInterface(), |
kenjiArai | 0:5b88d5760320 | 54 | * wifiInterface(), meshInterface(), cellularInterface(), emacInterface() and checking |
kenjiArai | 0:5b88d5760320 | 55 | * for NULL pointers. |
kenjiArai | 0:5b88d5760320 | 56 | * |
kenjiArai | 0:5b88d5760320 | 57 | * The default behavior is to return the default interface for the |
kenjiArai | 0:5b88d5760320 | 58 | * interface type specified by target.network-default-interface-type. Targets |
kenjiArai | 0:5b88d5760320 | 59 | * should set this in their targets.json to guide default selection, |
kenjiArai | 0:5b88d5760320 | 60 | * and applications may override. |
kenjiArai | 0:5b88d5760320 | 61 | * |
kenjiArai | 0:5b88d5760320 | 62 | * The interface returned should be already configured for use such that its |
kenjiArai | 0:5b88d5760320 | 63 | * connect() method works with no parameters. For connection types needing |
kenjiArai | 0:5b88d5760320 | 64 | * configuration, settings should normally be obtained from JSON - the |
kenjiArai | 0:5b88d5760320 | 65 | * settings for the core types are under the "nsapi" JSON config tree. |
kenjiArai | 0:5b88d5760320 | 66 | * |
kenjiArai | 0:5b88d5760320 | 67 | * The list of possible settings for default interface type is open-ended, |
kenjiArai | 0:5b88d5760320 | 68 | * as is the number of possible providers. Core providers are: |
kenjiArai | 0:5b88d5760320 | 69 | * |
kenjiArai | 0:5b88d5760320 | 70 | * * ETHERNET: EthernetInterface, using default EMAC and OnboardNetworkStack |
kenjiArai | 0:5b88d5760320 | 71 | * * MESH: ThreadInterface or LoWPANNDInterface, using default NanostackRfPhy |
kenjiArai | 0:5b88d5760320 | 72 | * * CELLULAR: OnboardModemInterface |
kenjiArai | 0:5b88d5760320 | 73 | * * WIFI: None - always provided by a specific class |
kenjiArai | 0:5b88d5760320 | 74 | * |
kenjiArai | 0:5b88d5760320 | 75 | * Specific drivers may be activated by other settings of the |
kenjiArai | 0:5b88d5760320 | 76 | * default-network-interface-type configuration. This will depend on the |
kenjiArai | 0:5b88d5760320 | 77 | * target and the driver. For example a board may have its default setting |
kenjiArai | 0:5b88d5760320 | 78 | * as "AUTO" which causes it to autodetect an Ethernet cable. This should |
kenjiArai | 0:5b88d5760320 | 79 | * be described in the target's documentation. |
kenjiArai | 0:5b88d5760320 | 80 | * |
kenjiArai | 0:5b88d5760320 | 81 | * An application can override all target settings by implementing |
kenjiArai | 0:5b88d5760320 | 82 | * NetworkInterface::get_default_instance() themselves - the default |
kenjiArai | 0:5b88d5760320 | 83 | * definition is weak, and calls get_target_default_instance(). |
kenjiArai | 0:5b88d5760320 | 84 | */ |
kenjiArai | 0:5b88d5760320 | 85 | static NetworkInterface *get_default_instance(); |
kenjiArai | 0:5b88d5760320 | 86 | |
kenjiArai | 0:5b88d5760320 | 87 | /** Set network interface as default one. |
kenjiArai | 0:5b88d5760320 | 88 | */ |
kenjiArai | 0:5b88d5760320 | 89 | virtual void set_as_default(); |
kenjiArai | 0:5b88d5760320 | 90 | |
kenjiArai | 0:5b88d5760320 | 91 | /** Get the local MAC address. |
kenjiArai | 0:5b88d5760320 | 92 | * |
kenjiArai | 0:5b88d5760320 | 93 | * Provided MAC address is intended for info or debug purposes and |
kenjiArai | 0:5b88d5760320 | 94 | * may be not provided if the underlying network interface does not |
kenjiArai | 0:5b88d5760320 | 95 | * provide a MAC address. |
kenjiArai | 0:5b88d5760320 | 96 | * |
kenjiArai | 0:5b88d5760320 | 97 | * @return Null-terminated representation of the local MAC address |
kenjiArai | 0:5b88d5760320 | 98 | * or null if no MAC address is available. |
kenjiArai | 0:5b88d5760320 | 99 | */ |
kenjiArai | 0:5b88d5760320 | 100 | virtual const char *get_mac_address(); |
kenjiArai | 0:5b88d5760320 | 101 | |
kenjiArai | 0:5b88d5760320 | 102 | /** Get the local IP address |
kenjiArai | 0:5b88d5760320 | 103 | * |
kenjiArai | 0:5b88d5760320 | 104 | * @return Null-terminated representation of the local IP address |
kenjiArai | 0:5b88d5760320 | 105 | * or null if not yet connected |
kenjiArai | 0:5b88d5760320 | 106 | */ |
kenjiArai | 0:5b88d5760320 | 107 | virtual const char *get_ip_address(); |
kenjiArai | 0:5b88d5760320 | 108 | |
kenjiArai | 0:5b88d5760320 | 109 | /** Get the local network mask. |
kenjiArai | 0:5b88d5760320 | 110 | * |
kenjiArai | 0:5b88d5760320 | 111 | * @return Null-terminated representation of the local network mask |
kenjiArai | 0:5b88d5760320 | 112 | * or null if no network mask has been received. |
kenjiArai | 0:5b88d5760320 | 113 | */ |
kenjiArai | 0:5b88d5760320 | 114 | virtual const char *get_netmask(); |
kenjiArai | 0:5b88d5760320 | 115 | |
kenjiArai | 0:5b88d5760320 | 116 | /** Get the local gateway. |
kenjiArai | 0:5b88d5760320 | 117 | * |
kenjiArai | 0:5b88d5760320 | 118 | * @return Null-terminated representation of the local gateway |
kenjiArai | 0:5b88d5760320 | 119 | * or null if no network mask has been received. |
kenjiArai | 0:5b88d5760320 | 120 | */ |
kenjiArai | 0:5b88d5760320 | 121 | virtual const char *get_gateway(); |
kenjiArai | 0:5b88d5760320 | 122 | |
kenjiArai | 0:5b88d5760320 | 123 | /** Get the network interface name |
kenjiArai | 0:5b88d5760320 | 124 | * |
kenjiArai | 0:5b88d5760320 | 125 | * @return Null-terminated representation of the network interface name |
kenjiArai | 0:5b88d5760320 | 126 | * or null if interface not exists |
kenjiArai | 0:5b88d5760320 | 127 | */ |
kenjiArai | 0:5b88d5760320 | 128 | virtual char *get_interface_name(char *interface_name); |
kenjiArai | 0:5b88d5760320 | 129 | |
kenjiArai | 0:5b88d5760320 | 130 | /** Configure this network interface to use a static IP address. |
kenjiArai | 0:5b88d5760320 | 131 | * Implicitly disables DHCP, which can be enabled in set_dhcp. |
kenjiArai | 0:5b88d5760320 | 132 | * Requires that the network is disconnected. |
kenjiArai | 0:5b88d5760320 | 133 | * |
kenjiArai | 0:5b88d5760320 | 134 | * @param ip_address Null-terminated representation of the local IP address |
kenjiArai | 0:5b88d5760320 | 135 | * @param netmask Null-terminated representation of the local network mask |
kenjiArai | 0:5b88d5760320 | 136 | * @param gateway Null-terminated representation of the local gateway |
kenjiArai | 0:5b88d5760320 | 137 | * @return NSAPI_ERROR_OK on success, negative error code on failure |
kenjiArai | 0:5b88d5760320 | 138 | */ |
kenjiArai | 0:5b88d5760320 | 139 | virtual nsapi_error_t set_network(const char *ip_address, const char *netmask, const char *gateway); |
kenjiArai | 0:5b88d5760320 | 140 | |
kenjiArai | 0:5b88d5760320 | 141 | /** Enable or disable DHCP on connecting the network. |
kenjiArai | 0:5b88d5760320 | 142 | * |
kenjiArai | 0:5b88d5760320 | 143 | * Enabled by default unless a static IP address has been assigned. Requires |
kenjiArai | 0:5b88d5760320 | 144 | * that the network is disconnected. |
kenjiArai | 0:5b88d5760320 | 145 | * |
kenjiArai | 0:5b88d5760320 | 146 | * @param dhcp True to enable DHCP. |
kenjiArai | 0:5b88d5760320 | 147 | * @return NSAPI_ERROR_OK on success, negative error code on failure. |
kenjiArai | 0:5b88d5760320 | 148 | */ |
kenjiArai | 0:5b88d5760320 | 149 | virtual nsapi_error_t set_dhcp(bool dhcp); |
kenjiArai | 0:5b88d5760320 | 150 | |
kenjiArai | 0:5b88d5760320 | 151 | /** Connect to a network. |
kenjiArai | 0:5b88d5760320 | 152 | * |
kenjiArai | 0:5b88d5760320 | 153 | * This blocks until connection is established, but asynchronous operation can be enabled |
kenjiArai | 0:5b88d5760320 | 154 | * by calling NetworkInterface::set_blocking(false). |
kenjiArai | 0:5b88d5760320 | 155 | * |
kenjiArai | 0:5b88d5760320 | 156 | * In asynchronous mode this starts the connection sequence and returns immediately. |
kenjiArai | 0:5b88d5760320 | 157 | * Status of the connection can then checked from NetworkInterface::get_connection_status() |
kenjiArai | 0:5b88d5760320 | 158 | * or from status callbacks. |
kenjiArai | 0:5b88d5760320 | 159 | * |
kenjiArai | 0:5b88d5760320 | 160 | * NetworkInterface internally handles reconnections until disconnect() is called. |
kenjiArai | 0:5b88d5760320 | 161 | * |
kenjiArai | 0:5b88d5760320 | 162 | * @return NSAPI_ERROR_OK if connection established in blocking mode. |
kenjiArai | 0:5b88d5760320 | 163 | * @return NSAPI_ERROR_OK if asynchronous operation started. |
kenjiArai | 0:5b88d5760320 | 164 | * @return NSAPI_ERROR_BUSY if asynchronous operation cannot be started. |
kenjiArai | 0:5b88d5760320 | 165 | Implementation guarantees event generation, which can be used as an |
kenjiArai | 0:5b88d5760320 | 166 | trigger to reissue the rejected request. |
kenjiArai | 0:5b88d5760320 | 167 | * @return NSAPI_ERROR_IS_CONNECTED if already connected. |
kenjiArai | 0:5b88d5760320 | 168 | * @return negative error code on failure. |
kenjiArai | 0:5b88d5760320 | 169 | */ |
kenjiArai | 0:5b88d5760320 | 170 | virtual nsapi_error_t connect() = 0; |
kenjiArai | 0:5b88d5760320 | 171 | |
kenjiArai | 0:5b88d5760320 | 172 | /** Disconnect from the network |
kenjiArai | 0:5b88d5760320 | 173 | * |
kenjiArai | 0:5b88d5760320 | 174 | * This blocks until interface is disconnected, unless interface is set to |
kenjiArai | 0:5b88d5760320 | 175 | * asynchronous (non-blocking) mode by calling NetworkInterface::set_blocking(false). |
kenjiArai | 0:5b88d5760320 | 176 | * |
kenjiArai | 0:5b88d5760320 | 177 | * @return NSAPI_ERROR_OK on successfully disconnected in blocking mode. |
kenjiArai | 0:5b88d5760320 | 178 | * @return NSAPI_ERROR_OK if asynchronous operation started. |
kenjiArai | 0:5b88d5760320 | 179 | * @return NSAPI_ERROR_BUSY if asynchronous operation cannot be started. |
kenjiArai | 0:5b88d5760320 | 180 | Implementation guarantees event generation, which can be used as an |
kenjiArai | 0:5b88d5760320 | 181 | trigger to reissue the rejected request. |
kenjiArai | 0:5b88d5760320 | 182 | * @return NSAPI_ERROR_NO_CONNECTION if already disconnected. |
kenjiArai | 0:5b88d5760320 | 183 | * @return negative error code on failure. |
kenjiArai | 0:5b88d5760320 | 184 | */ |
kenjiArai | 0:5b88d5760320 | 185 | virtual nsapi_error_t disconnect() = 0; |
kenjiArai | 0:5b88d5760320 | 186 | |
kenjiArai | 0:5b88d5760320 | 187 | /** Translate a hostname to an IP address with specific version using network interface name. |
kenjiArai | 0:5b88d5760320 | 188 | * |
kenjiArai | 0:5b88d5760320 | 189 | * The hostname may be either a domain name or an IP address. If the |
kenjiArai | 0:5b88d5760320 | 190 | * hostname is an IP address, no network transactions will be performed. |
kenjiArai | 0:5b88d5760320 | 191 | * |
kenjiArai | 0:5b88d5760320 | 192 | * If no stack-specific DNS resolution is provided, the hostname |
kenjiArai | 0:5b88d5760320 | 193 | * will be resolve using a UDP socket on the stack. |
kenjiArai | 0:5b88d5760320 | 194 | * |
kenjiArai | 0:5b88d5760320 | 195 | * @param host Hostname to resolve. |
kenjiArai | 0:5b88d5760320 | 196 | * @param address Pointer to a SocketAddress to store the result. |
kenjiArai | 0:5b88d5760320 | 197 | * @param version IP version of address to resolve, NSAPI_UNSPEC indicates |
kenjiArai | 0:5b88d5760320 | 198 | * version is chosen by the stack (defaults to NSAPI_UNSPEC). |
kenjiArai | 0:5b88d5760320 | 199 | * @param interface_name Network interface name |
kenjiArai | 0:5b88d5760320 | 200 | * @return NSAPI_ERROR_OK on success, negative error code on failure. |
kenjiArai | 0:5b88d5760320 | 201 | */ |
kenjiArai | 0:5b88d5760320 | 202 | virtual nsapi_error_t gethostbyname(const char *host, |
kenjiArai | 0:5b88d5760320 | 203 | SocketAddress *address, nsapi_version_t version = NSAPI_UNSPEC, const char *interface_name = NULL); |
kenjiArai | 0:5b88d5760320 | 204 | |
kenjiArai | 0:5b88d5760320 | 205 | /** Hostname translation callback (for use with gethostbyname_async()). |
kenjiArai | 0:5b88d5760320 | 206 | * |
kenjiArai | 0:5b88d5760320 | 207 | * Callback will be called after DNS resolution completes or a failure occurs. |
kenjiArai | 0:5b88d5760320 | 208 | * |
kenjiArai | 0:5b88d5760320 | 209 | * @note Callback should not take more than 10ms to execute, otherwise it might |
kenjiArai | 0:5b88d5760320 | 210 | * prevent underlying thread processing. A portable user of the callback |
kenjiArai | 0:5b88d5760320 | 211 | * should not make calls to network operations due to stack size limitations. |
kenjiArai | 0:5b88d5760320 | 212 | * The callback should not perform expensive operations such as socket recv/send |
kenjiArai | 0:5b88d5760320 | 213 | * calls or blocking operations. |
kenjiArai | 0:5b88d5760320 | 214 | * |
kenjiArai | 0:5b88d5760320 | 215 | * @param result NSAPI_ERROR_OK on success, negative error code on failure. |
kenjiArai | 0:5b88d5760320 | 216 | * @param address On success, destination for the host SocketAddress. |
kenjiArai | 0:5b88d5760320 | 217 | */ |
kenjiArai | 0:5b88d5760320 | 218 | typedef mbed::Callback<void (nsapi_error_t result, SocketAddress *address)> hostbyname_cb_t; |
kenjiArai | 0:5b88d5760320 | 219 | |
kenjiArai | 0:5b88d5760320 | 220 | /** Translate a hostname to an IP address (asynchronous) using network interface name. |
kenjiArai | 0:5b88d5760320 | 221 | * |
kenjiArai | 0:5b88d5760320 | 222 | * The hostname may be either a domain name or a dotted IP address. If the |
kenjiArai | 0:5b88d5760320 | 223 | * hostname is an IP address, no network transactions will be performed. |
kenjiArai | 0:5b88d5760320 | 224 | * |
kenjiArai | 0:5b88d5760320 | 225 | * If no stack-specific DNS resolution is provided, the hostname |
kenjiArai | 0:5b88d5760320 | 226 | * will be resolve using a UDP socket on the stack. |
kenjiArai | 0:5b88d5760320 | 227 | * |
kenjiArai | 0:5b88d5760320 | 228 | * Call is non-blocking. Result of the DNS operation is returned by the callback. |
kenjiArai | 0:5b88d5760320 | 229 | * If this function returns failure, callback will not be called. In case result |
kenjiArai | 0:5b88d5760320 | 230 | * is success (IP address was found from DNS cache), callback will be called |
kenjiArai | 0:5b88d5760320 | 231 | * before function returns. |
kenjiArai | 0:5b88d5760320 | 232 | * |
kenjiArai | 0:5b88d5760320 | 233 | * @param host Hostname to resolve. |
kenjiArai | 0:5b88d5760320 | 234 | * @param callback Callback that is called for result. |
kenjiArai | 0:5b88d5760320 | 235 | * @param version IP version of address to resolve, NSAPI_UNSPEC indicates |
kenjiArai | 0:5b88d5760320 | 236 | * version is chosen by the stack (defaults to NSAPI_UNSPEC). |
kenjiArai | 0:5b88d5760320 | 237 | * @param interface_name Network interface name |
kenjiArai | 0:5b88d5760320 | 238 | * @return 0 on immediate success, |
kenjiArai | 0:5b88d5760320 | 239 | * negative error code on immediate failure or |
kenjiArai | 0:5b88d5760320 | 240 | * a positive unique id that represents the hostname translation operation |
kenjiArai | 0:5b88d5760320 | 241 | * and can be passed to cancel. |
kenjiArai | 0:5b88d5760320 | 242 | */ |
kenjiArai | 0:5b88d5760320 | 243 | virtual nsapi_value_or_error_t gethostbyname_async(const char *host, hostbyname_cb_t callback, nsapi_version_t version = NSAPI_UNSPEC, |
kenjiArai | 0:5b88d5760320 | 244 | const char *interface_name = NULL); |
kenjiArai | 0:5b88d5760320 | 245 | |
kenjiArai | 0:5b88d5760320 | 246 | /** Cancel asynchronous hostname translation. |
kenjiArai | 0:5b88d5760320 | 247 | * |
kenjiArai | 0:5b88d5760320 | 248 | * When translation is cancelled, callback will not be called. |
kenjiArai | 0:5b88d5760320 | 249 | * |
kenjiArai | 0:5b88d5760320 | 250 | * @param id Unique id of the hostname translation operation (returned |
kenjiArai | 0:5b88d5760320 | 251 | * by gethostbyname_async) |
kenjiArai | 0:5b88d5760320 | 252 | * @return NSAPI_ERROR_OK on success, negative error code on failure. |
kenjiArai | 0:5b88d5760320 | 253 | */ |
kenjiArai | 0:5b88d5760320 | 254 | virtual nsapi_error_t gethostbyname_async_cancel(int id); |
kenjiArai | 0:5b88d5760320 | 255 | |
kenjiArai | 0:5b88d5760320 | 256 | /** Add a domain name server to list of servers to query |
kenjiArai | 0:5b88d5760320 | 257 | * |
kenjiArai | 0:5b88d5760320 | 258 | * @param address Address for the dns host. |
kenjiArai | 0:5b88d5760320 | 259 | * @return NSAPI_ERROR_OK on success, negative error code on failure. |
kenjiArai | 0:5b88d5760320 | 260 | */ |
kenjiArai | 0:5b88d5760320 | 261 | virtual nsapi_error_t add_dns_server(const SocketAddress &address, const char *interface_name); |
kenjiArai | 0:5b88d5760320 | 262 | |
kenjiArai | 0:5b88d5760320 | 263 | /** Register callback for status reporting. |
kenjiArai | 0:5b88d5760320 | 264 | * |
kenjiArai | 0:5b88d5760320 | 265 | * The specified status callback function will be called on status changes |
kenjiArai | 0:5b88d5760320 | 266 | * on the network. The parameters on the callback are the event type and |
kenjiArai | 0:5b88d5760320 | 267 | * event-type dependent reason parameter. Only one callback can be registered at a time. |
kenjiArai | 0:5b88d5760320 | 268 | * |
kenjiArai | 0:5b88d5760320 | 269 | * To unregister a callback call with status_cb parameter as a zero. |
kenjiArai | 0:5b88d5760320 | 270 | * |
kenjiArai | 0:5b88d5760320 | 271 | * *NOTE:* Any callbacks registered with this function will be overwritten if |
kenjiArai | 0:5b88d5760320 | 272 | * add_event_listener() API is used. |
kenjiArai | 0:5b88d5760320 | 273 | * |
kenjiArai | 0:5b88d5760320 | 274 | * @param status_cb The callback for status changes. |
kenjiArai | 0:5b88d5760320 | 275 | */ |
kenjiArai | 0:5b88d5760320 | 276 | virtual void attach(mbed::Callback<void(nsapi_event_t, intptr_t)> status_cb); |
kenjiArai | 0:5b88d5760320 | 277 | |
kenjiArai | 0:5b88d5760320 | 278 | /** Add event listener for interface. |
kenjiArai | 0:5b88d5760320 | 279 | * |
kenjiArai | 0:5b88d5760320 | 280 | * This API allows multiple callback to be registered for a single interface. |
kenjiArai | 0:5b88d5760320 | 281 | * When first called, internal list of event handlers are created and registered to |
kenjiArai | 0:5b88d5760320 | 282 | * interface through attach() API. |
kenjiArai | 0:5b88d5760320 | 283 | * |
kenjiArai | 0:5b88d5760320 | 284 | * Application may only use attach() or add_event_listener() interface. Mixing usage |
kenjiArai | 0:5b88d5760320 | 285 | * of both leads to undefined behavior. |
kenjiArai | 0:5b88d5760320 | 286 | * |
kenjiArai | 0:5b88d5760320 | 287 | * @param status_cb The callback for status changes. |
kenjiArai | 0:5b88d5760320 | 288 | */ |
kenjiArai | 0:5b88d5760320 | 289 | void add_event_listener(mbed::Callback<void(nsapi_event_t, intptr_t)> status_cb); |
kenjiArai | 0:5b88d5760320 | 290 | |
kenjiArai | 0:5b88d5760320 | 291 | /** Remove event listener from interface. |
kenjiArai | 0:5b88d5760320 | 292 | * |
kenjiArai | 0:5b88d5760320 | 293 | * Remove previously added callback from the handler list. |
kenjiArai | 0:5b88d5760320 | 294 | * |
kenjiArai | 0:5b88d5760320 | 295 | * @param status_cb The callback to unregister. |
kenjiArai | 0:5b88d5760320 | 296 | */ |
kenjiArai | 0:5b88d5760320 | 297 | void remove_event_listener(mbed::Callback<void(nsapi_event_t, intptr_t)> status_cb); |
kenjiArai | 0:5b88d5760320 | 298 | |
kenjiArai | 0:5b88d5760320 | 299 | /** Get the connection status. |
kenjiArai | 0:5b88d5760320 | 300 | * |
kenjiArai | 0:5b88d5760320 | 301 | * @return The connection status (@see nsapi_types.h). |
kenjiArai | 0:5b88d5760320 | 302 | */ |
kenjiArai | 0:5b88d5760320 | 303 | virtual nsapi_connection_status_t get_connection_status() const; |
kenjiArai | 0:5b88d5760320 | 304 | |
kenjiArai | 0:5b88d5760320 | 305 | /** Set asynchronous operation of connect() and disconnect() calls. |
kenjiArai | 0:5b88d5760320 | 306 | * |
kenjiArai | 0:5b88d5760320 | 307 | * By default, interfaces are in synchronous mode which means that |
kenjiArai | 0:5b88d5760320 | 308 | * connect() or disconnect() blocks until it reach the target state or requested operation fails. |
kenjiArai | 0:5b88d5760320 | 309 | * |
kenjiArai | 0:5b88d5760320 | 310 | * @param blocking Use true to set NetworkInterface in asynchronous mode. |
kenjiArai | 0:5b88d5760320 | 311 | * @return NSAPI_ERROR_OK on success |
kenjiArai | 0:5b88d5760320 | 312 | * @return NSAPI_ERROR_UNSUPPORTED if driver does not support asynchronous mode. |
kenjiArai | 0:5b88d5760320 | 313 | * @return negative error code on failure. |
kenjiArai | 0:5b88d5760320 | 314 | */ |
kenjiArai | 0:5b88d5760320 | 315 | virtual nsapi_error_t set_blocking(bool blocking); |
kenjiArai | 0:5b88d5760320 | 316 | |
kenjiArai | 0:5b88d5760320 | 317 | /** Return pointer to an EthInterface. |
kenjiArai | 0:5b88d5760320 | 318 | * @return Pointer to requested interface type or NULL if this class doesn't implement the interface. |
kenjiArai | 0:5b88d5760320 | 319 | */ |
kenjiArai | 0:5b88d5760320 | 320 | virtual EthInterface *ethInterface() |
kenjiArai | 0:5b88d5760320 | 321 | { |
kenjiArai | 0:5b88d5760320 | 322 | return 0; |
kenjiArai | 0:5b88d5760320 | 323 | } |
kenjiArai | 0:5b88d5760320 | 324 | |
kenjiArai | 0:5b88d5760320 | 325 | /** Return pointer to a WiFiInterface. |
kenjiArai | 0:5b88d5760320 | 326 | * @return Pointer to requested interface type or NULL if this class doesn't implement the interface. |
kenjiArai | 0:5b88d5760320 | 327 | */ |
kenjiArai | 0:5b88d5760320 | 328 | virtual WiFiInterface *wifiInterface() |
kenjiArai | 0:5b88d5760320 | 329 | { |
kenjiArai | 0:5b88d5760320 | 330 | return 0; |
kenjiArai | 0:5b88d5760320 | 331 | } |
kenjiArai | 0:5b88d5760320 | 332 | |
kenjiArai | 0:5b88d5760320 | 333 | /** Return pointer to a MeshInterface. |
kenjiArai | 0:5b88d5760320 | 334 | * @return Pointer to requested interface type or NULL if this class doesn't implement the interface. |
kenjiArai | 0:5b88d5760320 | 335 | */ |
kenjiArai | 0:5b88d5760320 | 336 | virtual MeshInterface *meshInterface() |
kenjiArai | 0:5b88d5760320 | 337 | { |
kenjiArai | 0:5b88d5760320 | 338 | return 0; |
kenjiArai | 0:5b88d5760320 | 339 | } |
kenjiArai | 0:5b88d5760320 | 340 | |
kenjiArai | 0:5b88d5760320 | 341 | /** Return pointer to a CellularInterface. |
kenjiArai | 0:5b88d5760320 | 342 | * @return Pointer to requested interface type or NULL if this class doesn't implement the interface. |
kenjiArai | 0:5b88d5760320 | 343 | * @deprecated CellularBase migrated to CellularInterface - use cellularInterface() |
kenjiArai | 0:5b88d5760320 | 344 | */ |
kenjiArai | 0:5b88d5760320 | 345 | MBED_DEPRECATED_SINCE("mbed-os-5.12", "CellularBase migrated to CellularInterface - use cellularInterface()") |
kenjiArai | 0:5b88d5760320 | 346 | virtual CellularInterface *cellularBase() // virtual retained for binary compatibility |
kenjiArai | 0:5b88d5760320 | 347 | { |
kenjiArai | 0:5b88d5760320 | 348 | return 0; |
kenjiArai | 0:5b88d5760320 | 349 | } |
kenjiArai | 0:5b88d5760320 | 350 | |
kenjiArai | 0:5b88d5760320 | 351 | /** Return pointer to an EMACInterface. |
kenjiArai | 0:5b88d5760320 | 352 | * @return Pointer to requested interface type or NULL if this class doesn't implement the interface. |
kenjiArai | 0:5b88d5760320 | 353 | */ |
kenjiArai | 0:5b88d5760320 | 354 | virtual EMACInterface *emacInterface() |
kenjiArai | 0:5b88d5760320 | 355 | { |
kenjiArai | 0:5b88d5760320 | 356 | return 0; |
kenjiArai | 0:5b88d5760320 | 357 | } |
kenjiArai | 0:5b88d5760320 | 358 | |
kenjiArai | 0:5b88d5760320 | 359 | #if !defined(DOXYGEN_ONLY) |
kenjiArai | 0:5b88d5760320 | 360 | |
kenjiArai | 0:5b88d5760320 | 361 | protected: |
kenjiArai | 0:5b88d5760320 | 362 | friend class InternetSocket; |
kenjiArai | 0:5b88d5760320 | 363 | friend class UDPSocket; |
kenjiArai | 0:5b88d5760320 | 364 | friend class TCPSocket; |
kenjiArai | 0:5b88d5760320 | 365 | friend class TCPServer; |
kenjiArai | 0:5b88d5760320 | 366 | friend class SocketAddress; |
kenjiArai | 0:5b88d5760320 | 367 | template <typename IF> |
kenjiArai | 0:5b88d5760320 | 368 | friend NetworkStack *nsapi_create_stack(IF *iface); |
kenjiArai | 0:5b88d5760320 | 369 | |
kenjiArai | 0:5b88d5760320 | 370 | /** Provide access to the NetworkStack object |
kenjiArai | 0:5b88d5760320 | 371 | * |
kenjiArai | 0:5b88d5760320 | 372 | * @return The underlying NetworkStack object |
kenjiArai | 0:5b88d5760320 | 373 | */ |
kenjiArai | 0:5b88d5760320 | 374 | virtual NetworkStack *get_stack() = 0; |
kenjiArai | 0:5b88d5760320 | 375 | |
kenjiArai | 0:5b88d5760320 | 376 | /** Get the target's default network instance. |
kenjiArai | 0:5b88d5760320 | 377 | * |
kenjiArai | 0:5b88d5760320 | 378 | * This method can be overridden by the target. Default implementations |
kenjiArai | 0:5b88d5760320 | 379 | * are provided weakly by various subsystems as described in |
kenjiArai | 0:5b88d5760320 | 380 | * NetworkInterface::get_default_instance(), so targets should not |
kenjiArai | 0:5b88d5760320 | 381 | * need to override in simple cases. |
kenjiArai | 0:5b88d5760320 | 382 | * |
kenjiArai | 0:5b88d5760320 | 383 | * If a target has more elaborate interface selection, it can completely |
kenjiArai | 0:5b88d5760320 | 384 | * override this behavior by implementing |
kenjiArai | 0:5b88d5760320 | 385 | * NetworkInterface::get_target_default_instance() themselves, either |
kenjiArai | 0:5b88d5760320 | 386 | * unconditionally, or for a specific network-default-interface-type setting |
kenjiArai | 0:5b88d5760320 | 387 | * |
kenjiArai | 0:5b88d5760320 | 388 | * For example, a device with both Ethernet and Wi-fi could be set up its |
kenjiArai | 0:5b88d5760320 | 389 | * target so that: |
kenjiArai | 0:5b88d5760320 | 390 | * * DEVICE_EMAC is set, and it provides EMAC::get_default_instance(), |
kenjiArai | 0:5b88d5760320 | 391 | * which means EthernetInterface provides EthInterface::get_target_instance() |
kenjiArai | 0:5b88d5760320 | 392 | * based on that EMAC. |
kenjiArai | 0:5b88d5760320 | 393 | * * It provides WifiInterface::get_target_default_instance(). |
kenjiArai | 0:5b88d5760320 | 394 | * * The core will route NetworkInterface::get_default_instance() to |
kenjiArai | 0:5b88d5760320 | 395 | * either of those if network-default-interface-type is set to |
kenjiArai | 0:5b88d5760320 | 396 | * ETHERNET or WIFI. |
kenjiArai | 0:5b88d5760320 | 397 | * * The board overrides NetworkInterface::get_target_default_instance() |
kenjiArai | 0:5b88d5760320 | 398 | * if network-default-interface-type is set to AUTO. This returns |
kenjiArai | 0:5b88d5760320 | 399 | * either EthInterface::get_default_instance() or WiFIInterface::get_default_instance() |
kenjiArai | 0:5b88d5760320 | 400 | * depending on a cable detection. |
kenjiArai | 0:5b88d5760320 | 401 | * |
kenjiArai | 0:5b88d5760320 | 402 | * |
kenjiArai | 0:5b88d5760320 | 403 | * performs the search described by get_default_instance. |
kenjiArai | 0:5b88d5760320 | 404 | */ |
kenjiArai | 0:5b88d5760320 | 405 | static NetworkInterface *get_target_default_instance(); |
kenjiArai | 0:5b88d5760320 | 406 | #endif //!defined(DOXYGEN_ONLY) |
kenjiArai | 0:5b88d5760320 | 407 | |
kenjiArai | 0:5b88d5760320 | 408 | public: |
kenjiArai | 0:5b88d5760320 | 409 | /** Set default parameters on an interface. |
kenjiArai | 0:5b88d5760320 | 410 | * |
kenjiArai | 0:5b88d5760320 | 411 | * A network interface instantiated directly or using calls such as |
kenjiArai | 0:5b88d5760320 | 412 | * WiFiInterface::get_default_instance() is initially unconfigured. |
kenjiArai | 0:5b88d5760320 | 413 | * This call can be used to set the default parameters that would |
kenjiArai | 0:5b88d5760320 | 414 | * have been set if the interface had been requested using |
kenjiArai | 0:5b88d5760320 | 415 | * NetworkInterface::get_default_instance() (see nsapi JSON |
kenjiArai | 0:5b88d5760320 | 416 | * configuration). |
kenjiArai | 0:5b88d5760320 | 417 | */ |
kenjiArai | 0:5b88d5760320 | 418 | virtual void set_default_parameters(); |
kenjiArai | 0:5b88d5760320 | 419 | |
kenjiArai | 0:5b88d5760320 | 420 | /** Return pointer to a CellularInterface. |
kenjiArai | 0:5b88d5760320 | 421 | * @return Pointer to requested interface type or NULL if this class doesn't implement the interface. |
kenjiArai | 0:5b88d5760320 | 422 | */ |
kenjiArai | 0:5b88d5760320 | 423 | virtual CellularInterface *cellularInterface() |
kenjiArai | 0:5b88d5760320 | 424 | { |
kenjiArai | 0:5b88d5760320 | 425 | return 0; |
kenjiArai | 0:5b88d5760320 | 426 | } |
kenjiArai | 0:5b88d5760320 | 427 | }; |
kenjiArai | 0:5b88d5760320 | 428 | |
kenjiArai | 0:5b88d5760320 | 429 | #endif |
kenjiArai | 0:5b88d5760320 | 430 | |
kenjiArai | 0:5b88d5760320 | 431 | /** @}*/ |