Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

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

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 1:9db0e321a9f4 1 /*
kenjiArai 1:9db0e321a9f4 2 * Copyright (c) 2019 ARM Limited
kenjiArai 1:9db0e321a9f4 3 * SPDX-License-Identifier: Apache-2.0
kenjiArai 1:9db0e321a9f4 4 *
kenjiArai 1:9db0e321a9f4 5 * Licensed under the Apache License, Version 2.0 (the "License");
kenjiArai 1:9db0e321a9f4 6 * you may not use this file except in compliance with the License.
kenjiArai 1:9db0e321a9f4 7 * You may obtain a copy of the License at
kenjiArai 1:9db0e321a9f4 8 *
kenjiArai 1:9db0e321a9f4 9 * http://www.apache.org/licenses/LICENSE-2.0
kenjiArai 1:9db0e321a9f4 10 *
kenjiArai 1:9db0e321a9f4 11 * Unless required by applicable law or agreed to in writing, software
kenjiArai 1:9db0e321a9f4 12 * distributed under the License is distributed on an "AS IS" BASIS,
kenjiArai 1:9db0e321a9f4 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kenjiArai 1:9db0e321a9f4 14 * See the License for the specific language governing permissions and
kenjiArai 1:9db0e321a9f4 15 * limitations under the License.
kenjiArai 1:9db0e321a9f4 16 */
kenjiArai 1:9db0e321a9f4 17
kenjiArai 1:9db0e321a9f4 18 #ifndef PPP_INTERFACE_H
kenjiArai 1:9db0e321a9f4 19 #define PPP_INTERFACE_H
kenjiArai 1:9db0e321a9f4 20
kenjiArai 1:9db0e321a9f4 21 #include "nsapi.h"
kenjiArai 1:9db0e321a9f4 22 #include "OnboardNetworkStack.h"
kenjiArai 1:9db0e321a9f4 23 #include "NetworkInterface.h"
kenjiArai 1:9db0e321a9f4 24 #include "PPP.h"
kenjiArai 1:9db0e321a9f4 25
kenjiArai 1:9db0e321a9f4 26
kenjiArai 1:9db0e321a9f4 27 /** PPPInterface class
kenjiArai 1:9db0e321a9f4 28 * Implementation of the NetworkInterface for an PPP-service
kenjiArai 1:9db0e321a9f4 29 *
kenjiArai 1:9db0e321a9f4 30 * This class provides the necessary glue logic to create a NetworkInterface
kenjiArai 1:9db0e321a9f4 31 * based on an PPP and an OnboardNetworkStack.
kenjiArai 1:9db0e321a9f4 32 *
kenjiArai 1:9db0e321a9f4 33 */
kenjiArai 1:9db0e321a9f4 34 class PPPInterface : public virtual NetworkInterface {
kenjiArai 1:9db0e321a9f4 35 public:
kenjiArai 1:9db0e321a9f4 36 /** Create an PPP-based network interface.
kenjiArai 1:9db0e321a9f4 37 *
kenjiArai 1:9db0e321a9f4 38 * The default arguments obtain the default PPP, which will be target-
kenjiArai 1:9db0e321a9f4 39 * dependent (and the target may have some JSON option to choose which
kenjiArai 1:9db0e321a9f4 40 * is the default, if there are multiple). The default stack is configured
kenjiArai 1:9db0e321a9f4 41 * by JSON option nsapi.default-stack.
kenjiArai 1:9db0e321a9f4 42 *
kenjiArai 1:9db0e321a9f4 43 * Due to inability to return errors from the constructor, no real
kenjiArai 1:9db0e321a9f4 44 * work is done until the first call to connect().
kenjiArai 1:9db0e321a9f4 45 *
kenjiArai 1:9db0e321a9f4 46 * @param ppp Reference to PPP to use
kenjiArai 1:9db0e321a9f4 47 * @param stack Reference to onboard-network stack to use
kenjiArai 1:9db0e321a9f4 48 */
kenjiArai 1:9db0e321a9f4 49 PPPInterface(PPP &ppp = PPP::get_default_instance(),
kenjiArai 1:9db0e321a9f4 50 OnboardNetworkStack &stack = OnboardNetworkStack::get_default_instance());
kenjiArai 1:9db0e321a9f4 51 virtual ~PPPInterface();
kenjiArai 1:9db0e321a9f4 52
kenjiArai 1:9db0e321a9f4 53 /** @copydoc NetworkInterface::set_network */
kenjiArai 1:9db0e321a9f4 54 virtual nsapi_error_t set_network(const char *ip_address, const char *netmask, const char *gateway);
kenjiArai 1:9db0e321a9f4 55
kenjiArai 1:9db0e321a9f4 56 /** @copydoc NetworkInterface::connect */
kenjiArai 1:9db0e321a9f4 57 virtual nsapi_error_t connect();
kenjiArai 1:9db0e321a9f4 58
kenjiArai 1:9db0e321a9f4 59 /** @copydoc NetworkInterface::disconnect */
kenjiArai 1:9db0e321a9f4 60 virtual nsapi_error_t disconnect();
kenjiArai 1:9db0e321a9f4 61
kenjiArai 1:9db0e321a9f4 62 /** @copydoc NetworkInterface::get_ip_address */
kenjiArai 1:9db0e321a9f4 63 virtual const char *get_ip_address();
kenjiArai 1:9db0e321a9f4 64
kenjiArai 1:9db0e321a9f4 65 /** @copydoc NetworkInterface::get_ip_address */
kenjiArai 1:9db0e321a9f4 66 virtual nsapi_error_t get_ip_address(SocketAddress *address);
kenjiArai 1:9db0e321a9f4 67
kenjiArai 1:9db0e321a9f4 68 /** @copydoc NetworkInterface::get_netmask */
kenjiArai 1:9db0e321a9f4 69 virtual nsapi_error_t get_netmask(SocketAddress *address);
kenjiArai 1:9db0e321a9f4 70
kenjiArai 1:9db0e321a9f4 71 /** @copydoc NetworkInterface::get_gateway */
kenjiArai 1:9db0e321a9f4 72 virtual nsapi_error_t get_gateway(SocketAddress *address);
kenjiArai 1:9db0e321a9f4 73
kenjiArai 1:9db0e321a9f4 74 /** @copydoc NetworkInterface::get_netmask */
kenjiArai 1:9db0e321a9f4 75 virtual const char *get_netmask();
kenjiArai 1:9db0e321a9f4 76
kenjiArai 1:9db0e321a9f4 77 /** @copydoc NetworkInterface::get_gateway */
kenjiArai 1:9db0e321a9f4 78 virtual const char *get_gateway();
kenjiArai 1:9db0e321a9f4 79
kenjiArai 1:9db0e321a9f4 80 /** @copydoc NetworkInterface::get_interface_name */
kenjiArai 1:9db0e321a9f4 81 virtual char *get_interface_name(char *interface_name);
kenjiArai 1:9db0e321a9f4 82
kenjiArai 1:9db0e321a9f4 83 /** @copydoc NetworkInterface::set_as_default */
kenjiArai 1:9db0e321a9f4 84 virtual void set_as_default();
kenjiArai 1:9db0e321a9f4 85
kenjiArai 1:9db0e321a9f4 86 /** @copydoc NetworkInterface::attach */
kenjiArai 1:9db0e321a9f4 87 virtual void attach(mbed::Callback<void(nsapi_event_t, intptr_t)> status_cb);
kenjiArai 1:9db0e321a9f4 88
kenjiArai 1:9db0e321a9f4 89 /** @copydoc NetworkInterface::get_connection_status */
kenjiArai 1:9db0e321a9f4 90 virtual nsapi_connection_status_t get_connection_status() const;
kenjiArai 1:9db0e321a9f4 91
kenjiArai 1:9db0e321a9f4 92 /** @copydoc NetworkInterface::set_blocking */
kenjiArai 1:9db0e321a9f4 93 virtual nsapi_error_t set_blocking(bool blocking);
kenjiArai 1:9db0e321a9f4 94
kenjiArai 1:9db0e321a9f4 95 /** Sets file stream used to communicate with modem
kenjiArai 1:9db0e321a9f4 96 *
kenjiArai 1:9db0e321a9f4 97 * @param stream Pointer to file handle
kenjiArai 1:9db0e321a9f4 98 */
kenjiArai 1:9db0e321a9f4 99 virtual void set_stream(mbed::FileHandle *stream);
kenjiArai 1:9db0e321a9f4 100
kenjiArai 1:9db0e321a9f4 101 /** Sets IP protocol versions of IP stack
kenjiArai 1:9db0e321a9f4 102 *
kenjiArai 1:9db0e321a9f4 103 * @param ip_stack IP protocol version
kenjiArai 1:9db0e321a9f4 104 */
kenjiArai 1:9db0e321a9f4 105 virtual void set_ip_stack(nsapi_ip_stack_t ip_stack);
kenjiArai 1:9db0e321a9f4 106
kenjiArai 1:9db0e321a9f4 107 /** Sets user name and password for PPP protocol
kenjiArai 1:9db0e321a9f4 108 *
kenjiArai 1:9db0e321a9f4 109 * @param uname User name
kenjiArai 1:9db0e321a9f4 110 * @param password Password
kenjiArai 1:9db0e321a9f4 111 */
kenjiArai 1:9db0e321a9f4 112 virtual void set_credentials(const char *uname, const char *password);
kenjiArai 1:9db0e321a9f4 113
kenjiArai 1:9db0e321a9f4 114 /** Provide access to the PPP
kenjiArai 1:9db0e321a9f4 115 *
kenjiArai 1:9db0e321a9f4 116 * This should be used with care - normally the network stack would
kenjiArai 1:9db0e321a9f4 117 * control the PPP, so manipulating the PPP while the stack
kenjiArai 1:9db0e321a9f4 118 * is also using it (ie after connect) will likely cause problems.
kenjiArai 1:9db0e321a9f4 119 *
kenjiArai 1:9db0e321a9f4 120 * @return Reference to the PPP in use
kenjiArai 1:9db0e321a9f4 121 */
kenjiArai 1:9db0e321a9f4 122 PPP &getppp() const
kenjiArai 1:9db0e321a9f4 123 {
kenjiArai 1:9db0e321a9f4 124 return _ppp;
kenjiArai 1:9db0e321a9f4 125 }
kenjiArai 1:9db0e321a9f4 126
kenjiArai 1:9db0e321a9f4 127 virtual PPPInterface *pppInterface()
kenjiArai 1:9db0e321a9f4 128 {
kenjiArai 1:9db0e321a9f4 129 return this;
kenjiArai 1:9db0e321a9f4 130 }
kenjiArai 1:9db0e321a9f4 131
kenjiArai 1:9db0e321a9f4 132 protected:
kenjiArai 1:9db0e321a9f4 133 /** Provide access to the underlying stack
kenjiArai 1:9db0e321a9f4 134 *
kenjiArai 1:9db0e321a9f4 135 * @return The underlying network stack
kenjiArai 1:9db0e321a9f4 136 */
kenjiArai 1:9db0e321a9f4 137 virtual NetworkStack *get_stack();
kenjiArai 1:9db0e321a9f4 138
kenjiArai 1:9db0e321a9f4 139 PPP &_ppp;
kenjiArai 1:9db0e321a9f4 140 OnboardNetworkStack &_stack;
kenjiArai 1:9db0e321a9f4 141 OnboardNetworkStack::Interface *_interface;
kenjiArai 1:9db0e321a9f4 142 bool _blocking;
kenjiArai 1:9db0e321a9f4 143 char _ip_address[NSAPI_IPv6_SIZE];
kenjiArai 1:9db0e321a9f4 144 char _netmask[NSAPI_IPv4_SIZE];
kenjiArai 1:9db0e321a9f4 145 char _gateway[NSAPI_IPv4_SIZE];
kenjiArai 1:9db0e321a9f4 146 mbed::Callback<void(nsapi_event_t, intptr_t)> _connection_status_cb;
kenjiArai 1:9db0e321a9f4 147
kenjiArai 1:9db0e321a9f4 148 mbed::FileHandle *_stream;
kenjiArai 1:9db0e321a9f4 149 nsapi_ip_stack_t _ip_stack;
kenjiArai 1:9db0e321a9f4 150 const char *_uname;
kenjiArai 1:9db0e321a9f4 151 const char *_password;
kenjiArai 1:9db0e321a9f4 152
kenjiArai 1:9db0e321a9f4 153 };
kenjiArai 1:9db0e321a9f4 154
kenjiArai 1:9db0e321a9f4 155 #endif