Kenji Arai / mbed-os_TYBLE16

mbed-os5 only for TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

features/netsocket/nsapi_ppp.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 /** \addtogroup netsocket */
kenjiArai 0:5b88d5760320 2 /** @{*/
kenjiArai 0:5b88d5760320 3 /* nsapi_ppp.h
kenjiArai 0:5b88d5760320 4 * Modified work Copyright (c) 2017 ARM Limited
kenjiArai 0:5b88d5760320 5 *
kenjiArai 0:5b88d5760320 6 * Licensed under the Apache License, Version 2.0 (the "License");
kenjiArai 0:5b88d5760320 7 * you may not use this file except in compliance with the License.
kenjiArai 0:5b88d5760320 8 * You may obtain a copy of the License at
kenjiArai 0:5b88d5760320 9 *
kenjiArai 0:5b88d5760320 10 * http://www.apache.org/licenses/LICENSE-2.0
kenjiArai 0:5b88d5760320 11 *
kenjiArai 0:5b88d5760320 12 * Unless required by applicable law or agreed to in writing, software
kenjiArai 0:5b88d5760320 13 * distributed under the License is distributed on an "AS IS" BASIS,
kenjiArai 0:5b88d5760320 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kenjiArai 0:5b88d5760320 15 * See the License for the specific language governing permissions and
kenjiArai 0:5b88d5760320 16 * limitations under the License.
kenjiArai 0:5b88d5760320 17 */
kenjiArai 0:5b88d5760320 18 #ifndef NSAPI_PPP_H_
kenjiArai 0:5b88d5760320 19 #define NSAPI_PPP_H_
kenjiArai 0:5b88d5760320 20
kenjiArai 0:5b88d5760320 21 #include "FileHandle.h"
kenjiArai 0:5b88d5760320 22 #include "NetworkStack.h"
kenjiArai 0:5b88d5760320 23
kenjiArai 0:5b88d5760320 24 namespace mbed {
kenjiArai 0:5b88d5760320 25
kenjiArai 0:5b88d5760320 26 /** Provide access to the NetworkStack object
kenjiArai 0:5b88d5760320 27 *
kenjiArai 0:5b88d5760320 28 * @return The underlying NetworkStack object
kenjiArai 0:5b88d5760320 29 */
kenjiArai 0:5b88d5760320 30 NetworkStack *nsapi_ppp_get_stack();
kenjiArai 0:5b88d5760320 31
kenjiArai 0:5b88d5760320 32 /** Set connection blocking parameter
kenjiArai 0:5b88d5760320 33 *
kenjiArai 0:5b88d5760320 34 * @param blocking True if connection is blocking
kenjiArai 0:5b88d5760320 35 *
kenjiArai 0:5b88d5760320 36 * @return 0 on success, negative error code on failure
kenjiArai 0:5b88d5760320 37 */
kenjiArai 0:5b88d5760320 38 nsapi_error_t nsapi_ppp_set_blocking(bool blocking);
kenjiArai 0:5b88d5760320 39
kenjiArai 0:5b88d5760320 40 /** Connect to a PPP pipe
kenjiArai 0:5b88d5760320 41 *
kenjiArai 0:5b88d5760320 42 * @param stream Pointer to a device type file handle (descriptor)
kenjiArai 0:5b88d5760320 43 * @param status_cb Optional, user provided callback for connection status
kenjiArai 0:5b88d5760320 44 * @param uname Optional, username for the connection
kenjiArai 0:5b88d5760320 45 * @param pwd Optional, password for the connection
kenjiArai 0:5b88d5760320 46 * @param stack Optional, stack for the connection
kenjiArai 0:5b88d5760320 47 *
kenjiArai 0:5b88d5760320 48 * @return 0 on success, negative error code on failure
kenjiArai 0:5b88d5760320 49 */
kenjiArai 0:5b88d5760320 50 nsapi_error_t nsapi_ppp_connect(FileHandle *stream, Callback<void(nsapi_event_t, intptr_t)> status_cb = 0, const char *uname = 0, const char *pwd = 0, const nsapi_ip_stack_t stack = DEFAULT_STACK);
kenjiArai 0:5b88d5760320 51
kenjiArai 0:5b88d5760320 52 /** Close a PPP connection
kenjiArai 0:5b88d5760320 53 *
kenjiArai 0:5b88d5760320 54 * @param stream Pointer to a device type file handle (descriptor)
kenjiArai 0:5b88d5760320 55 *
kenjiArai 0:5b88d5760320 56 * @return 0 on success, negative error code on failure
kenjiArai 0:5b88d5760320 57 */
kenjiArai 0:5b88d5760320 58 nsapi_error_t nsapi_ppp_disconnect(FileHandle *stream);
kenjiArai 0:5b88d5760320 59
kenjiArai 0:5b88d5760320 60 /** Get IP address
kenjiArai 0:5b88d5760320 61 *
kenjiArai 0:5b88d5760320 62 * After a successful connection, this API can be used to retrieve assigned IP address.
kenjiArai 0:5b88d5760320 63 *
kenjiArai 0:5b88d5760320 64 * @param stream Pointer to a device type file handle (descriptor)
kenjiArai 0:5b88d5760320 65 *
kenjiArai 0:5b88d5760320 66 * @return A string containing IP address or NULL
kenjiArai 0:5b88d5760320 67 */
kenjiArai 0:5b88d5760320 68 const char *nsapi_ppp_get_ip_addr(FileHandle *stream);
kenjiArai 0:5b88d5760320 69
kenjiArai 0:5b88d5760320 70 /** Get network mask
kenjiArai 0:5b88d5760320 71 *
kenjiArai 0:5b88d5760320 72 * After a successful connection, this API can be used to retrieve network mask
kenjiArai 0:5b88d5760320 73 * in case of an IPv4 network.
kenjiArai 0:5b88d5760320 74 *
kenjiArai 0:5b88d5760320 75 * @param stream Pointer to a device type file handle (descriptor)
kenjiArai 0:5b88d5760320 76 *
kenjiArai 0:5b88d5760320 77 * @return A string containing network mask or NULL
kenjiArai 0:5b88d5760320 78 */
kenjiArai 0:5b88d5760320 79 const char *nsapi_ppp_get_netmask(FileHandle *stream);
kenjiArai 0:5b88d5760320 80
kenjiArai 0:5b88d5760320 81 /** Get gateway address
kenjiArai 0:5b88d5760320 82 *
kenjiArai 0:5b88d5760320 83 * After a successful connection, this API can be used to retrieve IP address
kenjiArai 0:5b88d5760320 84 * of the default gateway in case of an IPv4 network.
kenjiArai 0:5b88d5760320 85 *
kenjiArai 0:5b88d5760320 86 * @param stream Pointer to a device type file handle (descriptor)
kenjiArai 0:5b88d5760320 87 *
kenjiArai 0:5b88d5760320 88 * @return A string containing gateway IP address or NULL
kenjiArai 0:5b88d5760320 89 */
kenjiArai 0:5b88d5760320 90 const char *nsapi_ppp_get_gw_addr(FileHandle *stream);
kenjiArai 0:5b88d5760320 91
kenjiArai 0:5b88d5760320 92 } //namespace mbed
kenjiArai 0:5b88d5760320 93
kenjiArai 0:5b88d5760320 94 /** @} */
kenjiArai 0:5b88d5760320 95
kenjiArai 0:5b88d5760320 96 #endif /* NSAPI_PPP_H_ */