DCOPClient Class Reference

Inter-process communication and remote procedure calls for KDE applications. More...

#include <dcopclient.h>

Inheritance diagram for DCOPClient:


Public Slots
void	processSocketData (int socknum)
Signals
void	applicationRegistered (const QCString &appId)
void	applicationRemoved (const QCString &appId)
void	attachFailed (const QString &msg)
void	blockUserInput (bool block)
void	callBack (int, const QCString &, const QByteArray &)
Public Member Functions
bool	acceptCalls () const
QCString	appId () const
bool	attach ()
DCOPClientTransaction *	beginTransaction ()
void	bindToApp ()
bool	call (const QCString &remApp, const QCString &remObj, const QCString &remFun, const QByteArray &data, QCString &replyType, QByteArray &replyData, bool useEventLoop=false)
bool	call (const QCString &remApp, const QCString &remObj, const QCString &remFun, const QByteArray &data, QCString &replyType, QByteArray &replyData, bool useEventLoop, int timeout)
int	callAsync (const QCString &remApp, const QCString &remObj, const QCString &remFun, const QByteArray &data, QObject callBackObj, const char callBackSlot)
bool	connectDCOPSignal (const QCString &sender, const QCString &signal, const QCString &receiverObj, const QCString &slot, bool Volatile) KDE_DEPRECATED
bool	connectDCOPSignal (const QCString &sender, const QCString &senderObj, const QCString &signal, const QCString &receiverObj, const QCString &slot, bool Volatile)
	DCOPClient ()
QCString	defaultObject () const
bool	detach ()
bool	disconnectDCOPSignal (const QCString &sender, const QCString &signal, const QCString &receiverObj, const QCString &slot) KDE_DEPRECATED
bool	disconnectDCOPSignal (const QCString &sender, const QCString &senderObj, const QCString &signal, const QCString &receiverObj, const QCString &slot)
void	emitDCOPSignal (const QCString &signal, const QByteArray &data)
void	emitDCOPSignal (const QCString &object, const QCString &signal, const QByteArray &data)
void	endTransaction (DCOPClientTransaction *t, QCString &replyType, QByteArray &replyData)
bool	find (const QCString &app, const QCString &obj, const QCString &fun, const QByteArray &data, QCString &replyType, QByteArray &replyData)
bool	findObject (const QCString &remApp, const QCString &remObj, const QCString &remFun, const QByteArray &data, QCString &foundApp, QCString &foundObj, bool useEventLoop=false)
bool	findObject (const QCString &remApp, const QCString &remObj, const QCString &remFun, const QByteArray &data, QCString &foundApp, QCString &foundObj, bool useEventLoop, int timeout)
void	handleAsyncReply (ReplyStruct *replyStruct)
bool	isApplicationRegistered (const QCString &remApp)
bool	isAttached () const
bool	isAttachedToForeignServer () const
bool	isRegistered () const
bool	isSuspended () const
virtual bool	process (const QCString &fun, const QByteArray &data, QCString &replyType, QByteArray &replyData)
bool	qtBridgeEnabled ()
bool	receive (const QCString &app, const QCString &obj, const QCString &fun, const QByteArray &data, QCString &replyType, QByteArray &replyData)
QCString	registerAs (const QCString &appId, bool addPID=true)
QCStringList	registeredApplications ()
QCStringList	remoteFunctions (const QCString &remApp, const QCString &remObj, bool *ok=0)
QCStringList	remoteInterfaces (const QCString &remApp, const QCString &remObj, bool *ok=0)
QCStringList	remoteObjects (const QCString &remApp, bool *ok=0)
void	resume ()
bool	send (const QCString &remApp, const QCString &remObj, const QCString &remFun, const QString &data)
bool	send (const QCString &remApp, const QCString &remObj, const QCString &remFun, const QByteArray &data)
QCString	senderId () const
void	setAcceptCalls (bool b)
void	setDaemonMode (bool daemonMode)
void	setDefaultObject (const QCString &objId)
void	setNotifications (bool enabled)
void	setPriorityCall (bool)
void	setQtBridgeEnabled (bool b)
int	socket () const
void	suspend ()
Q_INT32	transactionId () const
virtual	~DCOPClient ()
Static Public Member Functions
static QCString	dcopServerFile (const QCString &hostname=0)
static QCString	dcopServerFileOld (const QCString &hostname=0) KDE_DEPRECATED
static void	emergencyClose ()
static DCOPClient *	findLocalClient (const QCString &_appId)
static QCString	iceauthPath ()
static DCOPClient *	mainClient ()
static QCString	normalizeFunctionSignature (const QCString &fun)
static const char *	postMortemFunction ()
static const char *	postMortemObject ()
static const char *	postMortemSender ()
static void	setMainClient (DCOPClient *mainClient)
static void	setServerAddress (const QCString &addr)
Protected Member Functions
virtual void	virtual_hook (int id, void *data)
Related Functions
(Note that these are not member functions.)
Bool	dcop_attach (void)
Bool	dcop_call (const char app_name, const char remote_app_name, const char remote_object_id, const char remote_function, const char data, int data_length, char reply_type, char reply_data, int reply_data_length)
Bool	dcop_detach (void)
char *	dcop_register (const char *app_name, Bool add_pid)
Bool	dcop_register_callback (const char *object_id, dcop_callback_t callback)
Bool	dcop_send_signal (const char receiving_app, const char object, const char function, char data, int data_length)

Detailed Description

Inter-process communication and remote procedure calls for KDE applications.

This class provides IPC and RPC for KDE applications. Usually you will not have to instantiate one yourself because KApplication contains a method to return a pointer to a DCOPClient object which can be used for your whole application.

Before being able to send or receive any DCOP messages, you will have to attach your client object to the DCOP server, and then register your application with a specific name. See attach() and registerAs() for more information.

Data to be sent should be serialized into a QDataStream which was initialized with the QByteArray that you actually intend to send the data in. An example of how you might do this:

   QByteArray data;
   QDataStream arg(data, IO_WriteOnly);
   arg << QString("This is text I am serializing");
   client->send("someApp", "someObject", "someFunction(QString)", data);

See also:: KApplication::dcopClient()

Author:: Preston Brown <pbrown@kde.org>, Matthias Ettrich <ettrich@kde.org>

Definition at line 68 of file dcopclient.h.

Constructor & Destructor Documentation

DCOPClient::DCOPClient ( )

Constructs a new DCOP client, but does not attach to any server.

Definition at line 594 of file dcopclient.cpp.

DCOPClient::~DCOPClient ( ) [virtual]

Cleans up any open connections and dynamic data.

Definition at line 619 of file dcopclient.cpp.

Member Function Documentation

bool DCOPClient::acceptCalls ( ) const

Returns whether the client handles incoming calls.

Returns:: true if the client accepts calls

Definition at line 921 of file dcopclient.cpp.

QCString DCOPClient::appId ( ) const

Returns the current app id or a null string if the application hasn't yet been registered.

Returns:: the application id, or QString::null if not registered

Definition at line 995 of file dcopclient.cpp.

void DCOPClient::applicationRegistered ( const QCString & appId ) [signal]

Indicates that the application appId has been registered with the server we are attached to.

You need to call setNotifications() first, to tell the DCOP server that you want to get these events.

Parameters:

appId

the id of the new application

void DCOPClient::applicationRemoved ( const QCString & appId ) [signal]

Indicates that the formerly registered application appId has been removed.

You need to call setNotifications() first, to tell the DCOP server that you want to get these events.

Parameters:

appId

the id of the removed application

bool DCOPClient::attach ( )

Attaches to the DCOP server.

If the connection was already attached, the connection will be re-established with the current server address.

Naturally, only attached application can use DCOP services.

If a QApplication object exists then client registers itself as QApplication::name() + "-" + <pid>. If no QApplication object exists the client registers itself as "anonymous".

If you want to register differently, you should use registerAs() instead.

Returns:: true if attaching was successful.

Definition at line 663 of file dcopclient.cpp.

void DCOPClient::attachFailed ( const QString & msg ) [signal]

Indicates that the process of establishing DCOP communications failed in some manner.

Usually attached to a dialog box or some other visual aid.

Parameters:

msg

the message tha contains further information

DCOPClientTransaction * DCOPClient::beginTransaction ( )

Delays the reply of the current function call until endTransaction() is called.

This allows a server to queue requests.

Note: Should be called from inside process() only!

See also:: endTransaction()

Definition at line 2049 of file dcopclient.cpp.

void DCOPClient::bindToApp ( )

For internal use only.

Internal function for KUniqueApplication to register the DCOPClient with the application in case the application didn't exist at the time the DCOPClient was created.

Definition at line 671 of file dcopclient.cpp.

void DCOPClient::blockUserInput ( bool block ) [signal]

Indicates that user input shall be blocked or released, depending on the argument.

The signal is emitted whenever the client has to wait too long (i.e. more than 1/10 of a second) for an answer to a synchronous call. In that case, it will enter a local event loop to keep the GUI updated until finally an answer arrives.

In KDE, the KApplication object connects to this signal to be able to block any user input (i.e. mouse and key events) while we are waiting for an answer. If we did not do this, the application might end up in an illegal state, as a keyboard shortcut or a mouse action might cause another dcop call to be issued.

Parameters:

block

true to block user input, false otherwise

bool DCOPClient::call	(	const QCString &	remApp,
		const QCString &	remObj,
		const QCString &	remFun,
		const QByteArray &	data,
		QCString &	replyType,
		QByteArray &	replyData,
		bool	useEventLoop = `false`
	)

Deprecated:

Definition at line 1728 of file dcopclient.cpp.

bool DCOPClient::call	(	const QCString &	remApp,
		const QCString &	remObj,
		const QCString &	remFun,
		const QByteArray &	data,
		QCString &	replyType,
		QByteArray &	replyData,
		bool	useEventLoop,
		int	timeout
	)

Performs a synchronous send and receive.

The parameters are the same as for send, with the exception of another QByteArray being provided for results to be (optionally) returned in.

A call blocks the application until the process receives the answer.

If useEventLoop is true, a local event loop will be started after 1/10th of a second in order to keep the user interface updated (by processing paint events and such) until an answer is received.

Parameters:

	remApp	the remote application's id
	remObj	the remote object id
	remFun	the remote function id
	data	the data to send
	replyType	the type of the reply will be written here
	replyData	the data of the reply will be written here
	useEventLoop	if true the event loop will be started when the call blocks too long
	timeout	timeout for the call in miliseconds, or -1 for no timeout

Returns:: true if successful, false otherwise

Since:: 3.2

See also:: send()

Definition at line 1736 of file dcopclient.cpp.

int DCOPClient::callAsync	(	const QCString &	remApp,
		const QCString &	remObj,
		const QCString &	remFun,
		const QByteArray &	data,
		QObject *	callBackObj,
		const char *	callBackSlot
	)

Performs a asynchronous send with receive callback.

The first four parameters are the same as for send.

callBackObj and callBackSlot specify a call back slot that is called when an answer is received.

The slot should have the following signature: callBackSlot(int callId, const QCString& replyType, const QByteArray &replyData);

Parameters:

	remApp	the remote application's id
	remObj	the remote object id
	remFun	the remote function id
	data	the data to send
	callBackObj	object to call back
	callBackSlot	slot to call back

Returns:: 0 on failure, on success a callId > 0 is returned that will be passed as first argument of the result call back

See also:: send()
callback()

Since:: 3.2

Definition at line 1780 of file dcopclient.cpp.

void DCOPClient::callBack	(	int	,
		const QCString &	,
		const QByteArray &
	)			`[signal]`

For internal use only.

Signal used for callbacks of async calls. This signal is automatically connected to the call back slot specified in the async call.

See also:: callAsync()

Since:: 3.2

bool DCOPClient::connectDCOPSignal	(	const QCString &	sender,
		const QCString &	signal,
		const QCString &	receiverObj,
		const QCString &	slot,
		bool	Volatile
	)

Deprecated:: For backwards compatibility

Definition at line 2170 of file dcopclient.cpp.

bool DCOPClient::connectDCOPSignal	(	const QCString &	sender,
		const QCString &	senderObj,
		const QCString &	signal,
		const QCString &	receiverObj,
		const QCString &	slot,
		bool	Volatile
	)

Connects to a DCOP signal.

Parameters:

	sender	the name of the client that emits the signal. When empty the signal will be passed from any client.
	senderObj	the name of the sending object that emits the signal.
	signal	the name of the signal. The arguments should match with slot.
	receiverObj	The name of the object to call
	slot	The name of the slot to call. Its arguments should match with signal.
	Volatile	If true, the connection will not be reestablished when `sender` unregisters and reregisters with DCOP. In this case the `sender` must be registered when the connection is made. If false, the connection will be reestablished when `sender` reregisters. In this case the connection can be made even if `sender` is not registered at that time.

Returns:

false if a connection could not be established. This will be the case when

Volatile is true and sender does not exist.
signal and slot do not have matching arguments.

Definition at line 2142 of file dcopclient.cpp.

QCString DCOPClient::dcopServerFile ( const QCString & hostname = 0 ) [static]

File with information how to reach the dcopserver.

Parameters:

hostname

Hostname to use, if empty current hostname of the system is used.

Returns:: Filename that contains information how to contact the DCOPserver.

Definition at line 300 of file dcopclient.cpp.

QCString DCOPClient::dcopServerFileOld ( const QCString & hostname = 0 ) [static]

Deprecated:: For backwards compatibility with KDE 2.x // KDE4 remove

Definition at line 307 of file dcopclient.cpp.

QCString DCOPClient::defaultObject ( ) const

Returns the current default object or an empty string if no object is installed as default object.

A default object receives application-wide messages that have not been processed by the DCOPClient itself.

Returns:: the id of the new default object

Definition at line 2029 of file dcopclient.cpp.

bool DCOPClient::detach ( )

Detaches from the DCOP server.

Returns:: true if successful, false otherwise

Definition at line 885 of file dcopclient.cpp.

bool DCOPClient::disconnectDCOPSignal	(	const QCString &	sender,
		const QCString &	signal,
		const QCString &	receiverObj,
		const QCString &	slot
	)

Deprecated:: For backwards compatibility

Definition at line 2204 of file dcopclient.cpp.

bool DCOPClient::disconnectDCOPSignal	(	const QCString &	sender,
		const QCString &	senderObj,
		const QCString &	signal,
		const QCString &	receiverObj,
		const QCString &	slot
	)

Disconnects a DCOP signal.

A special case is when both sender & signal are empty. In this case all connections related to receiverObj in the current client are disconnected. (Both connections from as well as to this object!)

Parameters:

	sender	the name of the client that emits the signal.
	senderObj	the name of the object that emits the signal. If empty all objects will be disconnected.
	signal	the name of the signal. The arguments should match with slot.
	receiverObj	The name of the object the signal is connected to. If empty all objects will be disconnected.
	slot	The name of the slot the signal is connected to. If empty all slots will be disconnected.

Returns:: false if no connection(s) where removed.

Definition at line 2177 of file dcopclient.cpp.

void DCOPClient::emergencyClose ( ) [static]

For internal use only.

Do not use.

Definition at line 2233 of file dcopclient.cpp.

void DCOPClient::emitDCOPSignal	(	const QCString &	signal,
		const QByteArray &	data
	)

Definition at line 2136 of file dcopclient.cpp.

void DCOPClient::emitDCOPSignal	(	const QCString &	object,
		const QCString &	signal,
		const QByteArray &	data
	)

Emits signal as DCOP signal from object object with data as arguments.

Definition at line 2129 of file dcopclient.cpp.

void DCOPClient::endTransaction	(	DCOPClientTransaction *	t,
		QCString &	replyType,
		QByteArray &	replyData
	)

Sends the delayed reply of a function call.

Parameters:

	t	the transaction as received from beginTransaction()
	replyType	write the reply type in this string
	replyData	write the reply data in this array

See also:: beginTransaction()

Definition at line 2079 of file dcopclient.cpp.

bool DCOPClient::find	(	const QCString &	app,
		const QCString &	obj,
		const QCString &	fun,
		const QByteArray &	data,
		QCString &	replyType,
		QByteArray &	replyData
	)

For internal use only.

Receives a DCOPFind message from the server.

Parameters:

	app	The application the message was intended for. Should be equal to our appId that we passed when the DCOPClient was created.
	obj	The name of the object to pass the data on to.
	fun	The name of the function in the object to call.
	data	The arguments for the function.
	replyType	write the reply type in this string
	replyData	write the reply data in this array

Definition at line 1681 of file dcopclient.cpp.

DCOPClient * DCOPClient::findLocalClient ( const QCString & _appId ) [static]

Look for the given client only in this process.

This can be used to check whether a given client (by name) is running in the same process or in another one.

Definition at line 98 of file dcopclient.cpp.

bool DCOPClient::findObject	(	const QCString &	remApp,
		const QCString &	remObj,
		const QCString &	remFun,
		const QByteArray &	data,
		QCString &	foundApp,
		QCString &	foundObj,
		bool	useEventLoop = `false`
	)

Deprecated:

Definition at line 1111 of file dcopclient.cpp.

bool DCOPClient::findObject	(	const QCString &	remApp,
		const QCString &	remObj,
		const QCString &	remFun,
		const QByteArray &	data,
		QCString &	foundApp,
		QCString &	foundObj,
		bool	useEventLoop,
		int	timeout
	)

Searches for an object which matches a criteria.

findObject calls remFun in the applications and objects identified by remApp and remObj until remFun returns true. The name of the application and object that returned true are returned in foundApp and foundObj respectively.

If remFun is empty a default function is called in the object which always returns true.

A findObject blocks the application until the process receives the answer.

If useEventLoop is true, a local event loop will be started after 1/10th of a second in order to keep the user interface updated (by processing paint events and such) until an answer is received.

Parameters:

	remApp	The remote application id.
	remObj	The name of the remote object.
	remFun	The remote function in the specified object to call. This function should return a bool and is used as criteria.
	data	The data to provide to the remote function.
	foundApp	The remote application id that matched the criteria.
	foundObj	The remote object that matched the criteria.
	useEventLoop	if true the event loop will be started when the call blocks too long
	timeout	timeout for the call in miliseconds, or -1 for no timeout

Returns:: true is returned when an object was found for which remFun returned true. If no such object is the function returns false.

Since:: 3.2

See also:: send()

Definition at line 1119 of file dcopclient.cpp.

void DCOPClient::handleAsyncReply ( ReplyStruct * replyStruct )

For internal use only.

Definition at line 317 of file dcopclient.cpp.

QCString DCOPClient::iceauthPath ( ) [static]

Return the path of iceauth or an empty string if not found.

Definition at line 213 of file dcopclient.cpp.

bool DCOPClient::isApplicationRegistered ( const QCString & remApp )

Checks whether remApp is registered with the DCOP server.

Parameters:

remApp

the id of the remote application

Returns:: true if the remote application is registered, otherwise false.

Definition at line 1221 of file dcopclient.cpp.

bool DCOPClient::isAttached ( ) const

Returns whether or not the client is attached to the server.

Returns:: true if attached, false if not

Definition at line 908 of file dcopclient.cpp.

bool DCOPClient::isAttachedToForeignServer ( ) const

Returns whether the client is attached to a server owned by another user.

Returns:: true if attached to a foreign server, false if not

Definition at line 916 of file dcopclient.cpp.

bool DCOPClient::isRegistered ( ) const

Returns whether or not the client is registered at the server.

Returns:: true if registered at the server

Definition at line 989 of file dcopclient.cpp.

bool DCOPClient::isSuspended ( ) const

Returns whether DCOP events are being processed.

See also:: suspend()
resume().

Since:: 3.1

Definition at line 705 of file dcopclient.cpp.

DCOPClient * DCOPClient::mainClient ( ) [static]

Returns the application's main dcop client.

The main client can be used by objects that do not have any specific access to a dcop client. In KDE applications, the main client usually is the same as KApplication::dcopClient().

Returns:: the application's main dcop client

Definition at line 583 of file dcopclient.cpp.

QCString DCOPClient::normalizeFunctionSignature ( const QCString & fun ) [static]

Normalizes the function signature fun.

A normalized signature doesn't contain any unnecessary whitespace anymore. The remaining whitespace consists of single blanks only (0x20).

Example for a normalized signature:

   "someFunction(QString,int)"

When using send() or call(), normalization is done automatically for you.

Parameters:

fun

the function signature to normalize

Returns:: the normalized function

Definition at line 1014 of file dcopclient.cpp.

const char * DCOPClient::postMortemFunction ( ) [static]

For internal use only.

Definition at line 2272 of file dcopclient.cpp.

const char * DCOPClient::postMortemObject ( ) [static]

For internal use only.

Definition at line 2265 of file dcopclient.cpp.

const char * DCOPClient::postMortemSender ( ) [static]

For internal use only.

Do not use.

Provides information about the last DCOP call for debugging purposes.

Definition at line 2255 of file dcopclient.cpp.

bool DCOPClient::process	(	const QCString &	fun,
		const QByteArray &	data,
		QCString &	replyType,
		QByteArray &	replyData
	)			`[virtual]`

Reimplement this function to handle app-wide function calls unassociated w/an object.

Note that fun is normalized. See normalizeFunctionSignature().

If you do not want to reimplement this function for whatever reason, you can also use a default object or a DCOPObjectProxy.

Parameters:

	fun	the normalized function signature
	data	the received data
	replyType	write the reply type in this string
	replyData	write the reply data in this array

Returns:: true if successful, false otherwise

See also:: setDefaultObject()

Definition at line 1215 of file dcopclient.cpp.

void DCOPClient::processSocketData ( int socknum ) [slot]

Process data from the socket.

Parameters:

socknum

the fd of the socket

Definition at line 1987 of file dcopclient.cpp.

bool DCOPClient::qtBridgeEnabled ( )

Returns whether the DCOP - Qt bridge is enabled.

By default the DCOP - Qt bridge is enabled.

Returns:: true if Qt objects are accessible over DCOP

Since:: 3.0.2

Definition at line 932 of file dcopclient.cpp.

bool DCOPClient::receive	(	const QCString &	app,
		const QCString &	obj,
		const QCString &	fun,
		const QByteArray &	data,
		QCString &	replyType,
		QByteArray &	replyData
	)

For internal use only.

Receives a DCOPSend or DCOPCall message from the server.

Parameters:

	app	The application the message was intended for. Should be equal to our appId that we passed when the DCOPClient was created.
	obj	The name of the object to pass the data on to.
	fun	The name of the function in the object to call.
	data	The arguments for the function.
	replyType	write the reply type in this string
	replyData	write the reply data in this array

Returns:: true if successful, false otherwise

Definition at line 1554 of file dcopclient.cpp.

QCString DCOPClient::registerAs	(	const QCString &	appId,
		bool	addPID = `true`
	)

Registers at the DCOP server.

If the application was already registered, the registration will be re-done with the new appId.

appId is a unique application/program id that the server will use to associate requests with. If there is already an application registered with the same name, the server will add a number to the id to unify it. If addPID is true, the PID of the current process will be added to id.

Registration is necessary if you want to allow other clients to talk to you. They can do so using your appId as first parameter for send() or call(). If you just want to talk to other clients, you do not need to register at the server. In that case attach() is enough. It will implicitly register you as "anonymous".

Parameters:

	appId	the id of the application
	addPID	true to add the process id

Returns:: The actual appId used for the registration or a null string if the registration wasn't successful.

Definition at line 942 of file dcopclient.cpp.

QCStringList DCOPClient::registeredApplications ( )

Retrieves the list of all currently registered applications from dcopserver.

Returns:: a list of all regietered applications

Definition at line 1235 of file dcopclient.cpp.

QCStringList DCOPClient::remoteFunctions	(	const QCString &	remApp,
		const QCString &	remObj,
		bool *	ok = `0`
	)

Retrieves the list of functions of the remote object remObj of application remApp.

Parameters:

	remApp	the id of the application
	remObj	the id of the object
	ok	if not null, the function sets `ok` to true if successful and false if an error occurred

Returns:: the list of function ids

Definition at line 1279 of file dcopclient.cpp.

QCStringList DCOPClient::remoteInterfaces	(	const QCString &	remApp,
		const QCString &	remObj,
		bool *	ok = `0`
	)

Retrieves the list of interfaces of the remote object remObj of application remApp.

Parameters:

	remApp	the id of the application
	remObj	the id of the object
	ok	if not null, the function sets `ok` to true if successful and false if an error occurred

Returns:: the list of interfaces

Definition at line 1263 of file dcopclient.cpp.

QCStringList DCOPClient::remoteObjects	(	const QCString &	remApp,
		bool *	ok = `0`
	)

Retrieves the list of objects of the remote application remApp.

Parameters:

	remApp	he id of the application
	ok	if not null, the function sets `ok` to true if successful and false if an error occurred

Returns:: the list of object ids

Definition at line 1247 of file dcopclient.cpp.

void DCOPClient::resume ( )

Resumes the processing of DCOP events.

See also:: suspend().
isSuspended()

Definition at line 695 of file dcopclient.cpp.

bool DCOPClient::send	(	const QCString &	remApp,
		const QCString &	remObj,
		const QCString &	remFun,
		const QString &	data
	)

This function acts exactly the same as the above, but the data parameter can be specified as a QString for convenience.

Parameters:

	remApp	The remote application id.
	remObj	The name of the remote object.
	remFun	The remote function in the specified object to call.
	data	The data to provide to the remote function.

Returns:: Whether or not the server was able to accept the send.

Definition at line 1102 of file dcopclient.cpp.

bool DCOPClient::send	(	const QCString &	remApp,
		const QCString &	remObj,
		const QCString &	remFun,
		const QByteArray &	data
	)

Sends a data block to the server.

Parameters:

	remApp	The remote application id.
	remObj	The name of the remote object.
	remFun	The remote function in the specified object to call.
	data	The data to provide to the remote function.

Returns:: Whether or not the server was able to accept the send.

Definition at line 1048 of file dcopclient.cpp.

QCString DCOPClient::senderId ( ) const

Returns the appId of the last application that talked to us.

Returns:: the application id of the last application that send a message to this client

Definition at line 1042 of file dcopclient.cpp.

void DCOPClient::setAcceptCalls ( bool b )

Specify whether the client should accept incoming calls.

By default clients accept incoming calls, but not when connected to a foreign server.

Parameters:

b

true to accept calls, false to reject them

Definition at line 926 of file dcopclient.cpp.

void DCOPClient::setDaemonMode ( bool daemonMode )

Tells the dcopserver to treat the client as daemon client, not as regular client.

If the number of regular clients drops down to zero, the dcopserver will emit a KDE termination signal after 10 seconds.

Parameters:

daemonMode

true to enable daemon mode, false to disable

Definition at line 1307 of file dcopclient.cpp.

void DCOPClient::setDefaultObject ( const QCString & objId )

Installs object objId as application-wide default object.

All app-wide messages that have not been processed by the dcopclient will be send further to objId.

Parameters:

objId

the id of the new default object

Definition at line 2023 of file dcopclient.cpp.

void DCOPClient::setMainClient ( DCOPClient * mainClient ) [static]

Sets the application's main dcop client.

The main client can be used by objects that do not have any specific access to a dcop client. In KDE applications, the main client usually is the same as KApplication::dcopClient().

Parameters:

mainClient

the new main dcop client

Definition at line 588 of file dcopclient.cpp.

void DCOPClient::setNotifications ( bool enabled )

Enables / disables the applicationRegistered() / applicationRemoved() signals.

Note that a counter is maintained about how often this method was called. If this method is called twice with enabled set to true, notifications will be enabled until it was called with enabled set to false as often.

They are disabled by default.

Parameters:

enabled

true to enable notifications, false to disable

Definition at line 1295 of file dcopclient.cpp.

void DCOPClient::setPriorityCall ( bool b )

For internal use only.

Switch to priority call mode.

Definition at line 2211 of file dcopclient.cpp.

void DCOPClient::setQtBridgeEnabled ( bool b )

Specify whether Qt objects of the application should be accessible via DCOP.

By default the DCOP - Qt bridge is enabled.

Parameters:

b

true to make Qt objects accessible over DCOP

Since:: 3.0.2

Definition at line 937 of file dcopclient.cpp.

void DCOPClient::setServerAddress ( const QCString & addr ) [static]

Sets the address of a server to use upon attaching.

If no server address is ever specified, attach will try its best to find the server anyway.

Parameters:

addr

the new address of the server

Definition at line 655 of file dcopclient.cpp.

int DCOPClient::socket ( ) const

Returns the socket fd that is used for communication with the server.

Returns:: The socket over which DCOP is communicating with the server.

Definition at line 1001 of file dcopclient.cpp.

void DCOPClient::suspend ( )

Temporarily suspends processing of DCOP events.

This can be useful if you need to show e.g. a dialog before your application is ready to accept DCOP requests. Normally the dialog would start an event loop and in this event loop DCOP requests will be handled.

Be aware that not responding to DCOP requests may cause other programs that want to communicate with your application, to hang.

See also:: resume()
isSuspended()

Definition at line 685 of file dcopclient.cpp.

Q_INT32 DCOPClient::transactionId ( ) const

Test whether the current function call is delayed.

Note: Should be called from inside process() only!

Returns:: The ID of the current transaction or 0 if no transaction is going on.

See also:: process()
beginTransaction()

Definition at line 2070 of file dcopclient.cpp.

void DCOPClient::virtual_hook	(	int	id,
		void *	data
	)			`[protected, virtual]`

Definition at line 2279 of file dcopclient.cpp.

The documentation for this class was generated from the following files:

dcop

DCOPClient Class Reference

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

dcop

API Reference