Donatien Garnier / VodafoneUSBModem

Vodafone K3770/K3772-Z modems driver & networking library

Dependencies:   Socket

This library is deprecated. Please use the newest production branch of the library from https://mbed.org/users/mbed_official/code/VodafoneUSBModem/

ip/IPInterface.h@2:50930edb6eb3, 2012-11-01 (annotated)

Committer:
donatien
Date:
Thu Nov 01 09:57:11 2012 +0000
Revision:
2:50930edb6eb3
Parent:
0:bd5343539e38 
Deprecated library, pointing out to new one

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:bd5343539e38 1 /* IPInterface.h */
donatien 0:bd5343539e38 2 /* Copyright (C) 2012 mbed.org, MIT License
donatien 0:bd5343539e38 3 *
donatien 0:bd5343539e38 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
donatien 0:bd5343539e38 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
donatien 0:bd5343539e38 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
donatien 0:bd5343539e38 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
donatien 0:bd5343539e38 8 * furnished to do so, subject to the following conditions:
donatien 0:bd5343539e38 9 *
donatien 0:bd5343539e38 10 * The above copyright notice and this permission notice shall be included in all copies or
donatien 0:bd5343539e38 11 * substantial portions of the Software.
donatien 0:bd5343539e38 12 *
donatien 0:bd5343539e38 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
donatien 0:bd5343539e38 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
donatien 0:bd5343539e38 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
donatien 0:bd5343539e38 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 0:bd5343539e38 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
donatien 0:bd5343539e38 18 */
donatien 0:bd5343539e38 19
donatien 0:bd5343539e38 20 #ifndef IPINTERFACE_H_
donatien 0:bd5343539e38 21 #define IPINTERFACE_H_
donatien 0:bd5343539e38 22
donatien 0:bd5343539e38 23 #include "core/fwk.h"
donatien 0:bd5343539e38 24
donatien 0:bd5343539e38 25 /** Generic IP-based network interface
donatien 0:bd5343539e38 26 *
donatien 0:bd5343539e38 27 */
donatien 0:bd5343539e38 28 class IPInterface
donatien 0:bd5343539e38 29 {
donatien 0:bd5343539e38 30 public:
donatien 0:bd5343539e38 31 IPInterface();
donatien 0:bd5343539e38 32 virtual ~IPInterface();
donatien 0:bd5343539e38 33
donatien 0:bd5343539e38 34 //int init(); //Initialize interface; no connection should be performed at this stage
donatien 0:bd5343539e38 35 virtual int connect() = 0; //Do connect the interface
donatien 0:bd5343539e38 36 virtual int disconnect() = 0;
donatien 0:bd5343539e38 37 //It is encouraged that the derived class implement a "setup(...)" function to configure the interface before the connection
donatien 0:bd5343539e38 38
donatien 0:bd5343539e38 39 char* getIPAddress(); //Get IP Address as a string ('a.b.c.d')
donatien 0:bd5343539e38 40 bool isConnected(); //Is the interface connected?
donatien 0:bd5343539e38 41
donatien 0:bd5343539e38 42 static IPInterface* getDefaultInterface(); //For use by TCP, UDP sockets library
donatien 0:bd5343539e38 43
donatien 0:bd5343539e38 44 //WARN: Implementation will have to be more careful in case of multiple interfaces (or implement a routing protocol based on local IP addresses differentiation)
donatien 0:bd5343539e38 45 void registerAsDefaultInterface(); //First come, first served
donatien 0:bd5343539e38 46 void unregisterAsDefaultInterface(); //Must be called before inst is destroyed to avoid invalid ptr fault
donatien 0:bd5343539e38 47
donatien 0:bd5343539e38 48 protected:
donatien 0:bd5343539e38 49 //Must be called by subclasses
donatien 0:bd5343539e38 50 void setIPAddress(char* ipAddr);
donatien 0:bd5343539e38 51 void setConnected(bool connected);
donatien 0:bd5343539e38 52
donatien 0:bd5343539e38 53 private:
donatien 0:bd5343539e38 54 char m_ipAddr[16];
donatien 0:bd5343539e38 55 bool m_connected;
donatien 0:bd5343539e38 56
donatien 0:bd5343539e38 57 static IPInterface* s_pDefaultInterface;
donatien 0:bd5343539e38 58 };
donatien 0:bd5343539e38 59
donatien 0:bd5343539e38 60 #endif /* IPINTERFACE_H_ */