Added networkstatus service from pim to core for use in other network enabled applications

git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1171617 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

1 files changed, 77 insertions, 0 deletions

diff --git a/networkstatus/clientiface.h b/networkstatus/clientiface.h
new file mode 100644
index 000000000..9fcef57a3
--- /dev/null
+++ b/networkstatus/clientiface.h
@@ -0,0 +1,77 @@
+/*
+    This file is part of kdepim.
+
+    Copyright (c) 2005 Will Stephenson <lists@stevello.free-online.co.uk>
+
+    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., 51 Franklin Street, Fifth Floor,
+    Boston, MA 02110-1301, USA.
+*/
+
+#ifndef KDED_NETWORKSTATUS_CLIENTIFACE_H
+#define KDED_NETWORKSTATUS_CLIENTIFACE_H
+
+#include "networkstatuscommon.h"
+
+#include <dcopobject.h>
+
+class ClientIface : virtual public DCOPObject
+{
+K_DCOP
+k_dcop:
+	/** Get the set of networks that the daemon is aware of.  Mostly for debug */
+	virtual TQStringList networks() = 0;
+	/**
+	 * Get the status of the connection to the given host.
+	 * @param host 
+	 * @return a NetworkStatus::EnumStatus representing the state of the connection to the given host
+	 */
+	virtual int status( const TQString & host) = 0;
+	/**
+	 * Request a connection to the named host, registering the application's usage of this connection
+	 * @param host The hostname the client wants to connect to.
+	 * @param userInitiated Indicates whether the connection is a direct result of a user action or is a background task.  Used by the daemon to decide whether to create an on-demand connection.
+	 * @return An NetworkStatus::EnumRequestResult indicating whether the request was accepted
+	 */
+	virtual int request( const TQString &  host, bool userInitiated ) = 0;
+	/**
+	 * Indicate that a previously registered connection to the given host is no longer needed by this client
+	 * @param host The hostname being relinquished.
+	 */
+	virtual void relinquish( const TQString & host ) = 0;
+	/**
+	 * Indicate that a communication failure has occurred for a given host
+	 * @param host The hostname for which the failure occurred.
+	 * @return True indicates the caller should try again to lookup the host, as the daemon has another IP address available.
+	 */
+	virtual bool reportFailure( const TQString &  host ) = 0;
+	/**
+	 * Utility method to check the daemon's status
+	 */
+k_dcop_signals:
+	/**
+	 * A status change occurred for the network(s) used to connect to the given host.
+	 * @param host The host which the application has indicated it is using
+	 * @param status The new status of the network used to reach host.
+	 */
+	void statusChange( TQString host, int status );
+	/**
+	 * The network would like to shut down - any clients using this host are to finish using it immediately and call 
+	 * relinquish() when done.
+	 * @param host The host, registered as in use by applications, which is about to be disconnected.
+	 */
+	void shutdownRequested( TQString host );
+};
+
+#endif