mbed official / SprintUSBModem

USB Host Library for Sprint Dongles

Dependencies:   Socket USBHostWANDongleSprint lwip-sys lwip

Dependents:   SprintUSBModemWebsocketTest SprintUSBModemHTTPClientTest SprintUSBModemNTPClientTest SprintUSBModemSMSTest ... more

Fork of SprintUSBModem_bleedingedge by Donatien Garnier

ip/IPInterface.h@14:f6f17843e5ef, 2012-12-10 (annotated)

Committer:
donatien
Date:
Mon Dec 10 18:23:49 2012 +0000
Revision:
14:f6f17843e5ef
Parent:
0:8f57713b2147 
Separate USB/Sprint dev flows, fix regression in mbed rev. 41+ lib

Who changed what in which revision?

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