Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/netsocket/L3IPInterface.h@1:9db0e321a9f4, 2019-12-31 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 31 06:02:27 2019 +0000
Revision:
1:9db0e321a9f4
Parent:
0:5b88d5760320 
updated based on mbed-os5.15.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5b88d5760320 1 /*
kenjiArai 0:5b88d5760320 2 * Copyright (c) 2018 ARM Limited
kenjiArai 0:5b88d5760320 3 * SPDX-License-Identifier: Apache-2.0
kenjiArai 0:5b88d5760320 4 *
kenjiArai 0:5b88d5760320 5 * Licensed under the Apache License, Version 2.0 (the "License");
kenjiArai 0:5b88d5760320 6 * you may not use this file except in compliance with the License.
kenjiArai 0:5b88d5760320 7 * You may obtain a copy of the License at
kenjiArai 0:5b88d5760320 8 *
kenjiArai 0:5b88d5760320 9 * http://www.apache.org/licenses/LICENSE-2.0
kenjiArai 0:5b88d5760320 10 *
kenjiArai 0:5b88d5760320 11 * Unless required by applicable law or agreed to in writing, software
kenjiArai 0:5b88d5760320 12 * distributed under the License is distributed on an "AS IS" BASIS,
kenjiArai 0:5b88d5760320 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kenjiArai 0:5b88d5760320 14 * See the License for the specific language governing permissions and
kenjiArai 0:5b88d5760320 15 * limitations under the License.
kenjiArai 0:5b88d5760320 16 */
kenjiArai 0:5b88d5760320 17
kenjiArai 0:5b88d5760320 18 #ifndef L3IP_INTERFACE_H
kenjiArai 0:5b88d5760320 19 #define L3IP_INTERFACE_H
kenjiArai 0:5b88d5760320 20
kenjiArai 0:5b88d5760320 21 #include "nsapi.h"
kenjiArai 0:5b88d5760320 22 #include "L3IP.h"
kenjiArai 0:5b88d5760320 23 #include "OnboardNetworkStack.h"
kenjiArai 0:5b88d5760320 24
kenjiArai 0:5b88d5760320 25
kenjiArai 0:5b88d5760320 26 /** L3IPInterface class
kenjiArai 0:5b88d5760320 27 * Implementation of the NetworkInterface for an IP-based driver
kenjiArai 0:5b88d5760320 28 *
kenjiArai 0:5b88d5760320 29 * This class provides the necessary glue logic to create a NetworkInterface
kenjiArai 0:5b88d5760320 30 * based on an L3IP and an OnboardNetworkStack. Cellular Interface drivers derive from it.
kenjiArai 0:5b88d5760320 31 *
kenjiArai 0:5b88d5760320 32 * Drivers derived from L3IPInterface should be constructed so that their
kenjiArai 0:5b88d5760320 33 * L3IP is functional without the need to call `connect()`.
kenjiArai 0:5b88d5760320 34 */
kenjiArai 0:5b88d5760320 35 class L3IPInterface : public virtual NetworkInterface {
kenjiArai 0:5b88d5760320 36 public:
kenjiArai 0:5b88d5760320 37 /** Create an L3IP-based network interface.
kenjiArai 0:5b88d5760320 38 *
kenjiArai 0:5b88d5760320 39 * The default arguments obtain the default L3IP, which will be target-
kenjiArai 0:5b88d5760320 40 * dependent (and the target may have some JSON option to choose which
kenjiArai 0:5b88d5760320 41 * is the default, if there are multiple). The default stack is configured
kenjiArai 0:5b88d5760320 42 * by JSON option nsapi.default-stack.
kenjiArai 0:5b88d5760320 43 *
kenjiArai 0:5b88d5760320 44 * Due to inability to return errors from the constructor, no real
kenjiArai 0:5b88d5760320 45 * work is done until the first call to connect().
kenjiArai 0:5b88d5760320 46 *
kenjiArai 0:5b88d5760320 47 * @param l3ip Reference to L3IP to use
kenjiArai 0:5b88d5760320 48 * @param stack Reference to onboard-network stack to use
kenjiArai 0:5b88d5760320 49 */
kenjiArai 0:5b88d5760320 50 L3IPInterface(L3IP &l3ip = L3IP::get_default_instance(),
kenjiArai 0:5b88d5760320 51 OnboardNetworkStack &stack = OnboardNetworkStack::get_default_instance());
kenjiArai 0:5b88d5760320 52 virtual ~L3IPInterface();
kenjiArai 0:5b88d5760320 53 /** Set a static IP address
kenjiArai 0:5b88d5760320 54 *
kenjiArai 0:5b88d5760320 55 * Configures this network interface to use a static IP address.
kenjiArai 0:5b88d5760320 56 * Implicitly disables DHCP, which can be enabled in set_dhcp.
kenjiArai 0:5b88d5760320 57 * Requires that the network is disconnected.
kenjiArai 0:5b88d5760320 58 *
kenjiArai 0:5b88d5760320 59 * @param ip_address Null-terminated representation of the local IP address
kenjiArai 0:5b88d5760320 60 * @param netmask Null-terminated representation of the local network mask
kenjiArai 0:5b88d5760320 61 * @param gateway Null-terminated representation of the local gateway
kenjiArai 0:5b88d5760320 62 * @return 0 on success, negative error code on failure
kenjiArai 0:5b88d5760320 63 */
kenjiArai 0:5b88d5760320 64 virtual nsapi_error_t set_network(const char *ip_address, const char *netmask, const char *gateway);
kenjiArai 0:5b88d5760320 65
kenjiArai 0:5b88d5760320 66 /** Enable or disable DHCP on the network
kenjiArai 0:5b88d5760320 67 *
kenjiArai 0:5b88d5760320 68 * Requires that the network is disconnected
kenjiArai 0:5b88d5760320 69 *
kenjiArai 0:5b88d5760320 70 * @param dhcp False to disable dhcp (defaults to enabled)
kenjiArai 0:5b88d5760320 71 * @return 0 on success, negative error code on failure
kenjiArai 0:5b88d5760320 72 */
kenjiArai 0:5b88d5760320 73 virtual nsapi_error_t set_dhcp(bool dhcp);
kenjiArai 0:5b88d5760320 74
kenjiArai 0:5b88d5760320 75 /** Start the interface
kenjiArai 0:5b88d5760320 76 * @return 0 on success, negative on failure
kenjiArai 0:5b88d5760320 77 */
kenjiArai 0:5b88d5760320 78 virtual nsapi_error_t connect();
kenjiArai 0:5b88d5760320 79
kenjiArai 0:5b88d5760320 80 /** Stop the interface
kenjiArai 0:5b88d5760320 81 * @return 0 on success, negative on failure
kenjiArai 0:5b88d5760320 82 */
kenjiArai 0:5b88d5760320 83 virtual nsapi_error_t disconnect();
kenjiArai 0:5b88d5760320 84
kenjiArai 0:5b88d5760320 85 /** Get the local IP address
kenjiArai 0:5b88d5760320 86 *
kenjiArai 0:5b88d5760320 87 * @return Null-terminated representation of the local IP address
kenjiArai 0:5b88d5760320 88 * or null if no IP address has been received
kenjiArai 0:5b88d5760320 89 */
kenjiArai 0:5b88d5760320 90 virtual const char *get_ip_address();
kenjiArai 0:5b88d5760320 91
kenjiArai 0:5b88d5760320 92 /** Get the local network mask
kenjiArai 0:5b88d5760320 93 *
kenjiArai 0:5b88d5760320 94 * @return Null-terminated representation of the local network mask
kenjiArai 0:5b88d5760320 95 * or null if no network mask has been received
kenjiArai 0:5b88d5760320 96 */
kenjiArai 0:5b88d5760320 97 virtual const char *get_netmask();
kenjiArai 0:5b88d5760320 98
kenjiArai 0:5b88d5760320 99 /** Get the local gateways
kenjiArai 0:5b88d5760320 100 *
kenjiArai 0:5b88d5760320 101 * @return Null-terminated representation of the local gateway
kenjiArai 0:5b88d5760320 102 * or null if no network mask has been received
kenjiArai 0:5b88d5760320 103 */
kenjiArai 0:5b88d5760320 104 virtual const char *get_gateway();
kenjiArai 0:5b88d5760320 105
kenjiArai 0:5b88d5760320 106 /** Get the network interface name
kenjiArai 0:5b88d5760320 107 *
kenjiArai 0:5b88d5760320 108 * @return Null-terminated representation of the network interface name
kenjiArai 0:5b88d5760320 109 * or null if interface not exists
kenjiArai 0:5b88d5760320 110 */
kenjiArai 0:5b88d5760320 111 virtual char *get_interface_name(char *interface_name);
kenjiArai 0:5b88d5760320 112
kenjiArai 0:5b88d5760320 113 /** Set the network interface as default one
kenjiArai 0:5b88d5760320 114 */
kenjiArai 0:5b88d5760320 115 virtual void set_as_default();
kenjiArai 0:5b88d5760320 116
kenjiArai 0:5b88d5760320 117 /** Register callback for status reporting
kenjiArai 0:5b88d5760320 118 *
kenjiArai 0:5b88d5760320 119 * @param status_cb The callback for status changes
kenjiArai 0:5b88d5760320 120 */
kenjiArai 0:5b88d5760320 121 virtual void attach(mbed::Callback<void(nsapi_event_t, intptr_t)> status_cb);
kenjiArai 0:5b88d5760320 122
kenjiArai 0:5b88d5760320 123 /** Get the connection status
kenjiArai 0:5b88d5760320 124 *
kenjiArai 0:5b88d5760320 125 * @return The connection status according to nsapi_connection_status_t
kenjiArai 0:5b88d5760320 126 */
kenjiArai 0:5b88d5760320 127 virtual nsapi_connection_status_t get_connection_status() const;
kenjiArai 0:5b88d5760320 128
kenjiArai 0:5b88d5760320 129 /** Set blocking status of connect() which by default should be blocking
kenjiArai 0:5b88d5760320 130 *
kenjiArai 0:5b88d5760320 131 * @param blocking true if connect is blocking
kenjiArai 0:5b88d5760320 132 * @return 0 on success, negative error code on failure
kenjiArai 0:5b88d5760320 133 */
kenjiArai 0:5b88d5760320 134 virtual nsapi_error_t set_blocking(bool blocking);
kenjiArai 0:5b88d5760320 135
kenjiArai 0:5b88d5760320 136 /** Provide access to the L3IP
kenjiArai 0:5b88d5760320 137 *
kenjiArai 0:5b88d5760320 138 * This should be used with care - normally the network stack would
kenjiArai 0:5b88d5760320 139 * control the L3IP, so manipulating the L3IP while the stack
kenjiArai 0:5b88d5760320 140 * is also using it (ie after connect) will likely cause problems.
kenjiArai 0:5b88d5760320 141 *
kenjiArai 0:5b88d5760320 142 * @return Reference to the L3IP in use
kenjiArai 0:5b88d5760320 143 */
kenjiArai 0:5b88d5760320 144 L3IP &getl3ip() const
kenjiArai 0:5b88d5760320 145 {
kenjiArai 0:5b88d5760320 146 return _l3ip;
kenjiArai 0:5b88d5760320 147 }
kenjiArai 0:5b88d5760320 148
kenjiArai 0:5b88d5760320 149 virtual L3IPInterface *l3ipInterface()
kenjiArai 0:5b88d5760320 150 {
kenjiArai 0:5b88d5760320 151 return this;
kenjiArai 0:5b88d5760320 152 }
kenjiArai 0:5b88d5760320 153
kenjiArai 0:5b88d5760320 154 protected:
kenjiArai 0:5b88d5760320 155 /** Provide access to the underlying stack
kenjiArai 0:5b88d5760320 156 *
kenjiArai 0:5b88d5760320 157 * @return The underlying network stack
kenjiArai 0:5b88d5760320 158 */
kenjiArai 0:5b88d5760320 159 virtual NetworkStack *get_stack();
kenjiArai 0:5b88d5760320 160
kenjiArai 0:5b88d5760320 161 L3IP &_l3ip;
kenjiArai 0:5b88d5760320 162 OnboardNetworkStack &_stack;
kenjiArai 0:5b88d5760320 163 OnboardNetworkStack::Interface *_interface;
kenjiArai 0:5b88d5760320 164 bool _dhcp;
kenjiArai 0:5b88d5760320 165 bool _blocking;
kenjiArai 0:5b88d5760320 166 char _ip_address[NSAPI_IPv6_SIZE];
kenjiArai 0:5b88d5760320 167 char _netmask[NSAPI_IPv4_SIZE];
kenjiArai 0:5b88d5760320 168 char _gateway[NSAPI_IPv4_SIZE];
kenjiArai 0:5b88d5760320 169 mbed::Callback<void(nsapi_event_t, intptr_t)> _connection_status_cb;
kenjiArai 0:5b88d5760320 170 };
kenjiArai 0:5b88d5760320 171
kenjiArai 0:5b88d5760320 172 #endif