ON Semiconductor / mbed-os

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

features/netsocket/CellularInterface.h@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
group-onsemi 0:098463de4c5d 1
group-onsemi 0:098463de4c5d 2 /** \addtogroup netsocket */
group-onsemi 0:098463de4c5d 3 /** @{*/
group-onsemi 0:098463de4c5d 4 /* CellularInterface
group-onsemi 0:098463de4c5d 5 * Copyright (c) 2015 ARM Limited
group-onsemi 0:098463de4c5d 6 *
group-onsemi 0:098463de4c5d 7 * Licensed under the Apache License, Version 2.0 (the "License");
group-onsemi 0:098463de4c5d 8 * you may not use this file except in compliance with the License.
group-onsemi 0:098463de4c5d 9 * You may obtain a copy of the License at
group-onsemi 0:098463de4c5d 10 *
group-onsemi 0:098463de4c5d 11 * http://www.apache.org/licenses/LICENSE-2.0
group-onsemi 0:098463de4c5d 12 *
group-onsemi 0:098463de4c5d 13 * Unless required by applicable law or agreed to in writing, software
group-onsemi 0:098463de4c5d 14 * distributed under the License is distributed on an "AS IS" BASIS,
group-onsemi 0:098463de4c5d 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
group-onsemi 0:098463de4c5d 16 * See the License for the specific language governing permissions and
group-onsemi 0:098463de4c5d 17 * limitations under the License.
group-onsemi 0:098463de4c5d 18 */
group-onsemi 0:098463de4c5d 19
group-onsemi 0:098463de4c5d 20 #ifndef CELLULAR_INTERFACE_H
group-onsemi 0:098463de4c5d 21 #define CELLULAR_INTERFACE_H
group-onsemi 0:098463de4c5d 22
group-onsemi 0:098463de4c5d 23 #include "netsocket/NetworkInterface.h"
group-onsemi 0:098463de4c5d 24
group-onsemi 0:098463de4c5d 25
group-onsemi 0:098463de4c5d 26 /** CellularInterface class
group-onsemi 0:098463de4c5d 27 *
group-onsemi 0:098463de4c5d 28 * Common interface that is shared between ethernet hardware
group-onsemi 0:098463de4c5d 29 */
group-onsemi 0:098463de4c5d 30 class CellularInterface : public NetworkInterface
group-onsemi 0:098463de4c5d 31 {
group-onsemi 0:098463de4c5d 32 public:
group-onsemi 0:098463de4c5d 33 /** CellularInterface lifetime
group-onsemi 0:098463de4c5d 34 */
group-onsemi 0:098463de4c5d 35 virtual ~CellularInterface() {};
group-onsemi 0:098463de4c5d 36
group-onsemi 0:098463de4c5d 37 /** Set the cellular network APN and credentials
group-onsemi 0:098463de4c5d 38 *
group-onsemi 0:098463de4c5d 39 * @param apn Optional name of the network to connect to
group-onsemi 0:098463de4c5d 40 * @param user Optional username for the APN
group-onsemi 0:098463de4c5d 41 * @param pass Optional password fot the APN
group-onsemi 0:098463de4c5d 42 * @return 0 on success, negative error code on failure
group-onsemi 0:098463de4c5d 43 */
group-onsemi 0:098463de4c5d 44 virtual nsapi_error_t set_credentials(const char *apn,
group-onsemi 0:098463de4c5d 45 const char *username = 0, const char *password = 0) = 0;
group-onsemi 0:098463de4c5d 46
group-onsemi 0:098463de4c5d 47 /** Start the interface
group-onsemi 0:098463de4c5d 48 *
group-onsemi 0:098463de4c5d 49 * @param apn Optional name of the network to connect to
group-onsemi 0:098463de4c5d 50 * @param username Optional username for your APN
group-onsemi 0:098463de4c5d 51 * @param password Optional password for your APN
group-onsemi 0:098463de4c5d 52 * @return 0 on success, negative error code on failure
group-onsemi 0:098463de4c5d 53 */
group-onsemi 0:098463de4c5d 54 virtual nsapi_error_t connect(const char *apn,
group-onsemi 0:098463de4c5d 55 const char *username = 0, const char *password = 0) = 0;
group-onsemi 0:098463de4c5d 56
group-onsemi 0:098463de4c5d 57 /** Start the interface
group-onsemi 0:098463de4c5d 58 *
group-onsemi 0:098463de4c5d 59 * Attempts to connect to a cellular network based on supplied credentials
group-onsemi 0:098463de4c5d 60 *
group-onsemi 0:098463de4c5d 61 * @return 0 on success, negative error code on failure
group-onsemi 0:098463de4c5d 62 */
group-onsemi 0:098463de4c5d 63 virtual nsapi_error_t connect() = 0;
group-onsemi 0:098463de4c5d 64
group-onsemi 0:098463de4c5d 65 /** Stop the interface
group-onsemi 0:098463de4c5d 66 *
group-onsemi 0:098463de4c5d 67 * @return 0 on success, negative error code on failure
group-onsemi 0:098463de4c5d 68 */
group-onsemi 0:098463de4c5d 69 virtual nsapi_error_t disconnect() = 0;
group-onsemi 0:098463de4c5d 70 };
group-onsemi 0:098463de4c5d 71
group-onsemi 0:098463de4c5d 72
group-onsemi 0:098463de4c5d 73 #endif
group-onsemi 0:098463de4c5d 74
group-onsemi 0:098463de4c5d 75 /** @}*/