mbed official / CellularModem

Base library for cellular modem implementations

Dependencies:   Socket lwip-sys lwip

Dependents:   CellularUSBModem CellularUSBModem

Deprecated

This is an mbed 2 networking library. For mbed 5, the networking libraries have been revised to better support additional network stacks and thread safety here.

ip/IPInterface.h@8:944cd194963e, 2014-05-08 (annotated)

Committer:
mbed_official
Date:
Thu May 08 11:00:26 2014 +0100
Revision:
8:944cd194963e
Parent:
1:4a23efdf0da9 
Synchronized with git revision df12bf01ac7dbb50751e2b16a351c894994e1dcf



Full URL: https://github.com/mbedmicro/mbed/commit/df12bf01ac7dbb50751e2b16a351c894994e1dcf/

Who changed what in which revision?

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