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 "NetworkStack.h"
00021  
00022 /** CellularInterface class
00023  *
00024  *  Common interface that is shared between ethernet hardware
00025  */
00026 class CellularInterface
00027 {
00028 public:
00029     /** Start the interface
00030      *
00031      *  @param apn      Optional name of the network to connect to
00032      *  @param username Optional username for your APN
00033      *  @param password Optional password for your APN 
00034      *  @return         0 on success, negative error code on failure
00035      */
00036     virtual int connect(const char *apn = 0, const char *username = 0, const char *password = 0) = 0;
00037  
00038     /** Stop the interface
00039      *
00040      *  @return         0 on success, negative error code on failure
00041      */
00042     virtual int disconnect() = 0;
00043 
00044     /** Get the local MAC address
00045      *
00046      *  @return         Null-terminated representation of the local MAC address
00047      */
00048     virtual const char *get_mac_address() = 0;
00049 };
00050  
00051 #endif