pefect / NetworkSocketAPI

ap

Dependencies:   DnsQuery

Dependents:   WizFi310_TCP_Echo_Server_Example

Fork of NetworkSocketAPI by NetworkSocketAPI

CellularInterface.h@126:636a06d0aa42, 2017-10-01 (annotated)

Committer:
maru536
Date:
Sun Oct 01 20:55:24 2017 +0000
Revision:
126:636a06d0aa42
Parent:
114:964eba6394bc 
merge1

Who changed what in which revision?

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