Ashley Mills / VodafoneUSBModem_bleedingedge2

local fork

Dependencies:   Socket USBHostWANDongle_bleedingedge lwip-sys lwip

Dependents:   Encrypted

Fork of VodafoneUSBModem_bleedingedge by Donatien Garnier

ip/IPInterface.h@87:23f78174a9e2, 2013-04-26 (annotated)

Committer:
ashleymills
Date:
Fri Apr 26 16:58:07 2013 +0000
Revision:
87:23f78174a9e2
Parent:
16:02db4f537955 
nothing

Who changed what in which revision?

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