author | mickeyl <mickeyl> | 2003-05-01 00:59:20 (UTC) |
---|---|---|
committer | mickeyl <mickeyl> | 2003-05-01 00:59:20 (UTC) |
commit | 1d721ddb247e9000e29fba3150e0cce5f59f543e (patch) (side-by-side diff) | |
tree | 70b659b209395c8aff25442afaa4fc57c29679e6 /libopie2/opienet/onetwork.h | |
parent | 30c685f9da06d19c993e9bdb74f349dabbde063e (diff) | |
download | opie-1d721ddb247e9000e29fba3150e0cce5f59f543e.zip opie-1d721ddb247e9000e29fba3150e0cce5f59f543e.tar.gz opie-1d721ddb247e9000e29fba3150e0cce5f59f543e.tar.bz2 |
implement and document a bunch of missing methods
-rw-r--r-- | libopie2/opienet/onetwork.h | 58 |
1 files changed, 37 insertions, 21 deletions
diff --git a/libopie2/opienet/onetwork.h b/libopie2/opienet/onetwork.h index f052317..a29b29d 100644 --- a/libopie2/opienet/onetwork.h +++ b/libopie2/opienet/onetwork.h @@ -35,4 +35,8 @@ #define ONETWORK_H +/* OPIE */ + +#include <opie2/onetutils.h> + /* QT */ @@ -43,8 +47,4 @@ #include <qhostaddress.h> -/* OPIE */ - -#include <opie2/onetutils.h> - #ifndef IFNAMSIZ #define IFNAMSIZ 16 @@ -101,10 +101,10 @@ class ONetwork : public QObject InterfaceIterator iterator() const; /** - * @returns true, if the @p interface supports the wireless extension protocol. + * @returns true, if the @a interface supports the wireless extension protocol. */ // FIXME QString? -zecke bool isWirelessInterface( const char* interface ) const; /** - * @returns a pointer to the @ref ONetworkInterface object for the specified @p interface or 0, if not found + * @returns a pointer to the @ref ONetworkInterface object for the specified @a interface or 0, if not found * @see ONetworkInterface */ @@ -199,5 +199,5 @@ class ONetworkInterface : public QObject * @returns the IPv4 address associated with the interface. */ - QString ipV4Address() const; + QString ipV4Address() const; //TODO: make this return an OHostAddress /** * Associate the MAC address @a addr with the interface. @@ -217,5 +217,5 @@ class ONetworkInterface : public QObject * @returns the IPv4 netmask associated with the interface. */ - QString ipV4Netmask() const; + QString ipV4Netmask() const; //TODO: make this return an OHostAddress /** * @returns the data link type currently associated with the interface. @@ -318,6 +318,4 @@ class OWirelessNetworkInterface : public ONetworkInterface public: - enum Mode { AdHoc, Managed, Monitor }; - /** * Constructor. @@ -347,9 +345,16 @@ class OWirelessNetworkInterface : public ONetworkInterface */ virtual int channels() const; - //virtual double frequency(int) const; - - virtual void setMode( Mode ) {}; //FIXME: Implement and document this - virtual bool mode() const {}; //FIXME: Implement and document this - + /** + * Set the IEEE 802.11 operation @a mode. + * Valid values are <ul><li>adhoc<li>managed<li>monitor<li>master + * @warning Not all drivers support the all modes. + * @note You might have to change the SSID to get the operation mode change into effect. + */ + virtual void setMode( const QString& mode ); + /** + * @returns the current IEEE 802.11 operation mode. + * Possible values are <ul><li>adhoc<li>managed<li>monitor<li>master or <li>unknown + */ + virtual QString mode() const; /** * Setting the monitor mode on a wireless network interface enables @@ -363,9 +368,9 @@ class OWirelessNetworkInterface : public ONetworkInterface * @see OMonitoringInterface */ - virtual void setMonitorMode( bool ); + virtual void setMonitorMode( bool ); //FIXME: ==> setMode( "monitor" ); /** * @returns true if the device is listening in IEEE 802.11 monitor mode */ - virtual bool monitorMode() const; + virtual bool monitorMode() const; //FIXME: ==> mode() /** * Set the channel hopping @a interval. An @a interval of 0 disables channel hopping. @@ -384,5 +389,5 @@ class OWirelessNetworkInterface : public ONetworkInterface * Set the station @a nickname. */ - virtual void setNickName( const QString& nickname ) {}; //FIXME: Implement this + virtual void setNickName( const QString& nickname ); /** * @returns the current station nickname. @@ -401,7 +406,18 @@ class OWirelessNetworkInterface : public ONetworkInterface virtual bool isAssociated() const {}; //FIXME: Implement and document this - virtual QString associatedAP() const; //FIXME: Implement and document this - - virtual void setSSID( const QString& ); + /** + * @returns the MAC address of the Access Point if the + * device is in infrastructure mode. @returns a (more or less random) CELL + * address if the device is in adhoc mode. + */ + virtual QString associatedAP() const; + /** + * Set the @a ssid (Service Set ID) string. This is used to decide + * which network to associate with (use "any" to let the driver decide). + */ + virtual void setSSID( const QString& ssid ); + /** + * @returns the current SSID (Service Set ID). + */ virtual QString SSID() const; |