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  *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.
00025  *
00026  *  Common interface that is shared between ethernet hardware
00027  *  @addtogroup netsocket
00028  */
00029 class CellularInterface : public NetworkInterface
00030 {
00031 public:
00032     /** CellularInterface lifetime
00033      */
00034     MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.")
00035     virtual ~CellularInterface() {};
00036 
00037     /** Set the cellular network APN and credentials
00038      *
00039      *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.
00040      *
00041      *  @param apn      Optional name of the network to connect to
00042      *  @param username Optional username for the APN
00043      *  @param password Optional password fot the APN
00044      *  @return         0 on success, negative error code on failure
00045      */
00046     MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.")
00047     virtual nsapi_error_t set_credentials(const char *apn,
00048             const char *username = 0, const char *password = 0) = 0;
00049 
00050     /** Start the interface
00051      *
00052      *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.
00053      *
00054      *  @param apn      Optional name of the network to connect to
00055      *  @param username Optional username for your APN
00056      *  @param password Optional password for your APN
00057      *  @return         0 on success, negative error code on failure
00058      */
00059     MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.")
00060     virtual nsapi_error_t connect(const char *apn,
00061             const char *username = 0, const char *password = 0) = 0;
00062 
00063     /** Start the interface
00064      *
00065      *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.
00066      *
00067      *  Attempts to connect to a cellular network based on supplied credentials
00068      *
00069      *  @return         0 on success, negative error code on failure
00070      */
00071     MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.")
00072     virtual nsapi_error_t connect() = 0;
00073 
00074     /** Stop the interface
00075      *
00076      *  @deprecated This API will be deprecated in mbed-os-5.9. Use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.
00077      *
00078      *  @return         0 on success, negative error code on failure
00079      */
00080     MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/framework/API/CellularNetwork.h instead.")
00081     virtual nsapi_error_t disconnect() = 0;
00082 };
00083 
00084 
00085 #endif