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