CellularInterface.h

00001 /* CellularInterface
00002  * Copyright (c) 2015 ARM Limited
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #ifndef CELLULAR_INTERFACE_H
00018 #define CELLULAR_INTERFACE_H
00019 
00020 #include "netsocket/NetworkInterface.h"
00021 
00022 /** CellularInterface class
00023  *
00024  *  Common interface that is shared between ethernet hardware
00025  *  @addtogroup netsocket
00026  */
00027 class CellularInterface : public NetworkInterface
00028 {
00029 public:
00030     /** CellularInterface lifetime
00031      */
00032     MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.")
00033     virtual ~CellularInterface() {};
00034 
00035     /** Set the cellular network APN and credentials
00036      *
00037      *  @param apn      Optional name of the network to connect to
00038      *  @param username Optional username for the APN
00039      *  @param password Optional password fot the APN
00040      *  @return         0 on success, negative error code on failure
00041      */
00042     MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.")
00043     virtual nsapi_error_t set_credentials(const char *apn,
00044             const char *username = 0, const char *password = 0) = 0;
00045 
00046     /** Start the interface
00047      *
00048      *  @param apn      Optional name of the network to connect to
00049      *  @param username Optional username for your APN
00050      *  @param password Optional password for your APN
00051      *  @return         0 on success, negative error code on failure
00052      */
00053     MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.")
00054     virtual nsapi_error_t connect(const char *apn,
00055             const char *username = 0, const char *password = 0) = 0;
00056 
00057     /** Start the interface
00058      *
00059      *  Attempts to connect to a cellular network based on supplied credentials
00060      *
00061      *  @return         0 on success, negative error code on failure
00062      */
00063     MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.")
00064     virtual nsapi_error_t connect() = 0;
00065 
00066     /** Stop the interface
00067      *
00068      *  @return         0 on success, negative error code on failure
00069      */
00070     MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.")
00071     virtual nsapi_error_t disconnect() = 0;
00072 };
00073 
00074 
00075 #endif