takashi kadono / Mbed OS Nucleo446_SSD1331

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   ssd1331

mbed-os/features/netsocket/nsapi_ppp.h@0:8fdf9a60065b, 2018-10-10 (annotated)

Committer:
kadonotakashi
Date:
Wed Oct 10 00:33:53 2018 +0000
Revision:
0:8fdf9a60065b
how to make mbed librry

Who changed what in which revision?

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