EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

features/netsocket/nsapi_ppp.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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