diff options
Diffstat (limited to 'krfb/srvloc/kinetinterfacewatcher.h')
| -rw-r--r-- | krfb/srvloc/kinetinterfacewatcher.h | 122 |
1 files changed, 122 insertions, 0 deletions
diff --git a/krfb/srvloc/kinetinterfacewatcher.h b/krfb/srvloc/kinetinterfacewatcher.h new file mode 100644 index 00000000..3651b87d --- /dev/null +++ b/krfb/srvloc/kinetinterfacewatcher.h @@ -0,0 +1,122 @@ +/* + * Watches Inet interfaces + * Copyright (C) 2002 Tim Jansen <tim@tjansen.de> + * + * $Id$ + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Library General Public + * License as published by the Free Software Foundation; either + * version 2 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Library General Public License for more details. + * + * You should have received a copy of the GNU Library General Public License + * along with this library; see the file COPYING.LIB. If not, write to + * the Free Software Foundation, Inc., 59 Temple Place - Suite 330, + * Boston, MA 02111-1307, USA. + */ +#ifndef KINETINTERFACEWATCHER_H +#define KINETINTERFACEWATCHER_H + +#include <kinetinterface.h> +#include <qobject.h> +#include <qvaluevector.h> +#include <qcstring.h> +#include <qstring.h> + + +class KInetInterfaceWatcherPrivate; + + +/** + * KInetInterfaceWatcher can watch the state of one or all + * of the system's network interfaces. + * The watcher will emit the signal @ref changed() when an + * interface changed or a interface has been added or removed. + * + * @author Tim Jansen <tim@tjansen.de> + * @short Watches the state of the network interfaces + * @see KInetInterface + * @since 3.2 + */ +class KInetInterfaceWatcher : public QObject { + Q_OBJECT +public: + /** + * Creates a new KInetInterfaceWatcher. Before you can use it, + * you must @ref start() it. + * + * @param interface the name of the interface to watch (e.g.'eth0') + * or QString::null to watch all interfaces + * @param minInterval the minimum interval between two checks in + * seconds. Be careful not to check too often, to + * avoid unneccessary wasting of CPU time + */ + KInetInterfaceWatcher(const QString &interface = QString::null, + int minInterval = 60); + + /** + * Returns the name of the interface that is being watched. + * @return the name of the interface, or QString::null if all + * interfaces are watched + */ + QString interface() const; + + /** + * Starts the KInetInterfaceWatcher. It watches either one + * or all network interfaces. When one of them changed. + * it emits a @ref changed() signal. + * @param interface the name of the interface to watch (e.g.'eth0') + * or QString::null to watch all interfaces + * @param minInterval the minimum interval between two checks in + * seconds. Be careful not to check too often, to + * avoid unneccessary wasting of CPU time + * @see changed() + * @see stop() + */ + void start(const QString &interface = QString::null, + int minInterval = 60); + + /** + * Stops watching the interfaces. + * @see start() + */ + void stop(); + + /** + * Destructor + */ + virtual ~KInetInterfaceWatcher(); + +signals: + /** + * Emitted when one or more watched interfaces have changed. The + * @p interfaceName is the name of the interface being watched, not + * the interface that has changed (because more than one interface + * may have changed). + * A change occurred, when + * @li a new interface has been added (when watching a single interface, + * only when an interface of that name has been added) + * @li an interface has been removed (when watching a single interface, + * only when this interface has been removed) + * @li the address or netmask of the interface changed + * + * No change will be emitted when the broadcast address or destination + * address has changed. + * + * @param interfaceName the name of the interface that is watched, + * by the emitter, or QString::null if all + * interfaces are being watched + * @see start() + */ + void changed(QString interfaceName); + +private: + KInetInterfaceWatcherPrivate* d; +}; + +#endif |