Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

features/netsocket/CellularInterface.h@1:3deb71413561, 2017-07-20 (annotated)

Committer:
xuaner
Date:
Thu Jul 20 14:26:57 2017 +0000
Revision:
1:3deb71413561
Parent:
0:f269e3021894 
mbed_os

Who changed what in which revision?

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