KDE 4.2 API Reference kopete/libkopete
ClientIface Class Reference
#include <clientiface.h>
Inheritance diagram for ClientIface:
Detailed Description
Definition at line 8 of file clientiface.h.
DCOP Member Functions | |
| virtual QStringList | networks ()=0 |
| virtual void | relinquish (const QString &host)=0 |
| virtual bool | reportFailure (const QString &host)=0 |
| virtual int | request (const QString &host, bool userInitiated)=0 |
| void | shutdownRequested (QString host) |
| virtual int | status (const QString &host=QString())=0 |
Public Attributes | |
| k_dcop_signals | __pad0__: void statusChange( QString host |
| k_dcop_signals int | status |
Member Function Documentation
| virtual QStringList ClientIface::networks | ( | ) | [pure virtual] |
Get the set of networks that the daemon is aware of.
Mostly for debug
| virtual void ClientIface::relinquish | ( | const QString & | host | ) | [pure virtual] |
Indicate that a previously registered connection to the given host is no longer needed by this client.
- Parameters:
-
host The hostname being relinquished.
| virtual bool ClientIface::reportFailure | ( | const QString & | host | ) | [pure virtual] |
Indicate that a communication failure has occurred for a given host.
- Parameters:
-
host The hostname for which the failure occurred.
- Returns:
- True indicates the caller should try again to lookup the host, as the daemon has another IP address available.
| virtual int ClientIface::request | ( | const QString & | host, | |
| bool | userInitiated | |||
| ) | [pure virtual] |
Request a connection to the named host, registering the application's usage of this connection.
- Parameters:
-
host The hostname the client wants to connect to. 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.
- Returns:
- An NetworkStatus::EnumRequestResult indicating whether the request was accepted
| void ClientIface::shutdownRequested | ( | QString | host | ) |
The network would like to shut down - any clients using this host are to finish using it immediately and call relinquish() when done.
- Parameters:
-
host The host, registered as in use by applications, which is about to be disconnected.
| virtual int ClientIface::status | ( | const QString & | host = QString() |
) | [pure virtual] |
Get the status of the connection to the given host.
- Parameters:
-
host
- Returns:
- a NetworkStatus::EnumStatus representing the state of the connection to the given host
Member Data Documentation
| k_dcop_signals ClientIface::__pad0__ |
| k_dcop_signals int ClientIface::status |
Definition at line 47 of file clientiface.h.
The documentation for this class was generated from the following file:
