summaryrefslogtreecommitdiffstats
path: root/tool/mbed/mbed-sdk/libraries/net/cellular/CellularModem/ip/IPInterface.h
diff options
context:
space:
mode:
authorJun Wako <wakojun@gmail.com>2015-04-24 09:26:14 +0200
committerJun Wako <wakojun@gmail.com>2015-04-24 09:26:14 +0200
commit1fe4406f374291ab2e86e95a97341fd9c475fcb8 (patch)
tree1be0e16b4b07b5a31ea97ec50a9eb13a288c3d27 /tool/mbed/mbed-sdk/libraries/net/cellular/CellularModem/ip/IPInterface.h
parenta20ef7052c6e937d2f7672dd59456e55a5c08296 (diff)
downloadqmk_firmware-1fe4406f374291ab2e86e95a97341fd9c475fcb8.tar.gz
qmk_firmware-1fe4406f374291ab2e86e95a97341fd9c475fcb8.tar.xz
Squashed 'tmk_core/' changes from 7967731..b9e0ea0
b9e0ea0 Merge commit '7fa9d8bdea3773d1195b04d98fcf27cf48ddd81d' as 'tool/mbed/mbed-sdk' 7fa9d8b Squashed 'tool/mbed/mbed-sdk/' content from commit 7c21ce5 git-subtree-dir: tmk_core git-subtree-split: b9e0ea08cb940de20b3610ecdda18e9d8cd7c552
Diffstat (limited to 'tool/mbed/mbed-sdk/libraries/net/cellular/CellularModem/ip/IPInterface.h')
-rw-r--r--tool/mbed/mbed-sdk/libraries/net/cellular/CellularModem/ip/IPInterface.h60
1 files changed, 60 insertions, 0 deletions
diff --git a/tool/mbed/mbed-sdk/libraries/net/cellular/CellularModem/ip/IPInterface.h b/tool/mbed/mbed-sdk/libraries/net/cellular/CellularModem/ip/IPInterface.h
new file mode 100644
index 000000000..6655aec9c
--- /dev/null
+++ b/tool/mbed/mbed-sdk/libraries/net/cellular/CellularModem/ip/IPInterface.h
@@ -0,0 +1,60 @@
+/* IPInterface.h */
+/* Copyright (C) 2012 mbed.org, MIT License
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+ * and associated documentation files (the "Software"), to deal in the Software without restriction,
+ * including without limitation the rights to use, copy, modify, merge, publish, distribute,
+ * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
+ * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef IPINTERFACE_H_
+#define IPINTERFACE_H_
+
+#include "core/fwk.h"
+
+/** Generic IP-based network interface
+ *
+ */
+class IPInterface
+{
+public:
+ IPInterface();
+ virtual ~IPInterface();
+
+ //int init(); //Initialize interface; no connection should be performed at this stage
+ virtual int connect() = 0; //Do connect the interface
+ virtual int disconnect() = 0;
+ //It is encouraged that the derived class implement a "setup(...)" function to configure the interface before the connection
+
+ char* getIPAddress(); //Get IP Address as a string ('a.b.c.d')
+ bool isConnected(); //Is the interface connected?
+
+ static IPInterface* getDefaultInterface(); //For use by TCP, UDP sockets library
+
+ //WARN: Implementation will have to be more careful in case of multiple interfaces (or implement a routing protocol based on local IP addresses differentiation)
+ void registerAsDefaultInterface(); //First come, first served
+ void unregisterAsDefaultInterface(); //Must be called before inst is destroyed to avoid invalid ptr fault
+
+protected:
+ //Must be called by subclasses
+ void setIPAddress(char* ipAddr);
+ void setConnected(bool connected);
+
+private:
+ char m_ipAddr[16];
+ bool m_connected;
+
+ static IPInterface* s_pDefaultInterface;
+};
+
+#endif /* IPINTERFACE_H_ */