pefect / NetworkSocketAPI

ap

Dependencies:   DnsQuery

Dependents:   WizFi310_TCP_Echo_Server_Example

Fork of NetworkSocketAPI by NetworkSocketAPI

CellularInterface.h@105:2fd212f8da61, 2016-04-19 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 19 18:26:36 2016 -0500
Revision:
105:2fd212f8da61
Rename Interface -> Stack



NetworkInterface  -> NetworkStack

EthernetInterface -> EthernetStack

WiFiInterface     -> WiFiStack

CellularInterface -> CellularStack

MeshInterface     -> MeshStack

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Christopher Haster 105:2fd212f8da61 1 /* CellularInterface
Christopher Haster 105:2fd212f8da61 2 * Copyright (c) 2015 ARM Limited
Christopher Haster 105:2fd212f8da61 3 *
Christopher Haster 105:2fd212f8da61 4 * Licensed under the Apache License, Version 2.0 (the "License");
Christopher Haster 105:2fd212f8da61 5 * you may not use this file except in compliance with the License.
Christopher Haster 105:2fd212f8da61 6 * You may obtain a copy of the License at
Christopher Haster 105:2fd212f8da61 7 *
Christopher Haster 105:2fd212f8da61 8 * http://www.apache.org/licenses/LICENSE-2.0
Christopher Haster 105:2fd212f8da61 9 *
Christopher Haster 105:2fd212f8da61 10 * Unless required by applicable law or agreed to in writing, software
Christopher Haster 105:2fd212f8da61 11 * distributed under the License is distributed on an "AS IS" BASIS,
Christopher Haster 105:2fd212f8da61 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Christopher Haster 105:2fd212f8da61 13 * See the License for the specific language governing permissions and
Christopher Haster 105:2fd212f8da61 14 * limitations under the License.
Christopher Haster 105:2fd212f8da61 15 */
Christopher Haster 105:2fd212f8da61 16
Christopher Haster 105:2fd212f8da61 17 #ifndef CELLULAR_INTERFACE_H
Christopher Haster 105:2fd212f8da61 18 #define CELLULAR_INTERFACE_H
Christopher Haster 105:2fd212f8da61 19
Christopher Haster 105:2fd212f8da61 20 #include "NetworkInterface.h"
Christopher Haster 105:2fd212f8da61 21
Christopher Haster 105:2fd212f8da61 22 /** CellularInterface class
Christopher Haster 105:2fd212f8da61 23 *
Christopher Haster 105:2fd212f8da61 24 * Common interface that is shared between ethernet hardware
Christopher Haster 105:2fd212f8da61 25 */
Christopher Haster 105:2fd212f8da61 26 class CellularInterface : public NetworkInterface
Christopher Haster 105:2fd212f8da61 27 {
Christopher Haster 105:2fd212f8da61 28 public:
Christopher Haster 105:2fd212f8da61 29 /** Start the interface
Christopher Haster 105:2fd212f8da61 30 *
Christopher Haster 105:2fd212f8da61 31 * @param apn Optional name of the network to connect to
Christopher Haster 105:2fd212f8da61 32 * @param username Optional username for your APN
Christopher Haster 105:2fd212f8da61 33 * @param password Optional password for your APN
Christopher Haster 105:2fd212f8da61 34 * @return 0 on success, negative error code on failure
Christopher Haster 105:2fd212f8da61 35 */
Christopher Haster 105:2fd212f8da61 36 virtual int connect(const char *apn = 0, const char *username = 0, const char *password = 0) = 0;
Christopher Haster 105:2fd212f8da61 37
Christopher Haster 105:2fd212f8da61 38 /** Stop the interface
Christopher Haster 105:2fd212f8da61 39 *
Christopher Haster 105:2fd212f8da61 40 * @return 0 on success, negative error code on failure
Christopher Haster 105:2fd212f8da61 41 */
Christopher Haster 105:2fd212f8da61 42 virtual int disconnect() = 0;
Christopher Haster 105:2fd212f8da61 43 };
Christopher Haster 105:2fd212f8da61 44
Christopher Haster 105:2fd212f8da61 45 #endif