summaryrefslogtreecommitdiff
path: root/libopie2/opienet/onetwork.h
Side-by-side diff
Diffstat (limited to 'libopie2/opienet/onetwork.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/opienet/onetwork.h49
1 files changed, 35 insertions, 14 deletions
diff --git a/libopie2/opienet/onetwork.h b/libopie2/opienet/onetwork.h
index db8e702..2348bbc 100644
--- a/libopie2/opienet/onetwork.h
+++ b/libopie2/opienet/onetwork.h
@@ -55,10 +55,10 @@
// ML: Yeah, I hate to include kernel headers, but it's necessary here
// ML: Here comes an ugly hack to prevent <linux/wireless.h> including <linux/if.h>
// ML: which conflicts with the user header <net/if.h>
-// ML: We really a user header for the Wireless Extensions, something like <net/wireless.h>
-// ML: I will drop Jean an mail on that subject
+// ML: We really need a user header for the Wireless Extensions, something like <net/wireless.h>
+// ML: I will drop Jean a mail on that subject
#include <net/if.h>
#define _LINUX_IF_H
#include <linux/wireless.h>
@@ -72,11 +72,11 @@ class OMonitoringInterface;
* ONetwork
*======================================================================================*/
/**
- * @brief A container class for all network devices.
+ * @brief A container class for all network interfaces
*
- * This class provides access to all available network devices of your computer.
+ * This class provides access to all available network interfaces of your computer.
* @author Michael 'Mickey' Lauer <mickey@tm.informatik.uni-frankfurt.de>
*/
class ONetwork : public QObject
{
@@ -87,8 +87,12 @@ class ONetwork : public QObject
typedef QDictIterator<ONetworkInterface> InterfaceIterator;
public:
/**
+ * @returns the number of available interfaces
+ */
+ int count() const;
+ /**
* @returns a pointer to the (one and only) @ref ONetwork instance.
*/
static ONetwork* instance();
/**
@@ -105,12 +109,17 @@ class ONetwork : public QObject
* @see ONetworkInterface
*/
// FIXME: const QString& is prefered over QString!!! -zecke
ONetworkInterface* interface( const QString& interface ) const;
+ /**
+ * @internal Rebuild the internal interface database
+ * @note Sometimes it might be useful to call this from client code,
+ * e.g. after cardctl insert
+ */
+ void synchronize();
protected:
ONetwork();
- void synchronize();
private:
static ONetwork* _instance;
InterfaceMap _interfaces;
@@ -173,32 +182,44 @@ class ONetworkInterface : public QObject
/**
* @returns true if the interface is up.
*/
bool isUp() const;
- /*
+ /**
* @returns true if the interface is a loopback interface.
*/
bool isLoopback() const;
- /*
+ /**
* @returns true if the interface is featuring supports the wireless extension protocol.
*/
bool isWireless() const;
- /*
- * @returns the IPv4 address associated with this interface.
+ /**
+ * Associate the IP address @ addr with the interface.
+ */
+ void setIPV4Address( const QHostAddress& addr );
+ /**
+ * @returns the IPv4 address associated with the interface.
*/
QString ipV4Address() const;
- /*
+ /**
* Associate the MAC address @a addr with the interface.
* @note It can be necessary to shut down the interface prior to calling this method.
* @warning This is not supported by all drivers.
*/
void setMacAddress( const OMacAddress& addr );
- /*
- * @returns the MAC address associated with this interface.
+ /**
+ * @returns the MAC address associated with the interface.
*/
OMacAddress macAddress() const;
- /*
- * @returns the data link type currently associated with this interface.
+ /**
+ * Associate the IPv4 @a netmask with the interface.
+ */
+ void setIPV4Netmask( const QHostAddress& netmask );
+ /**
+ * @returns the IPv4 netmask associated with the interface.
+ */
+ QString ipV4Netmask() const;
+ /**
+ * @returns the data link type currently associated with the interface.
* @see #include <net/if_arp.h> for possible values.
*/
int dataLinkType() const;