Magnificent7 / Hackathon

Includes library modifications to allow access to AIN_4 (AIN_0 / 5)

mbd_os/features/net/network-socket/CellularInterface.h@0:eafc3fd41f75, 2016-09-20 (annotated)

Committer:
bryantaylor
Date:
Tue Sep 20 21:26:12 2016 +0000
Revision:
0:eafc3fd41f75
hackathon

Who changed what in which revision?

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