<HTML>
<HEAD>
<TITLE>dcop Globals</TITLE>
<META NAME="Generator" CONTENT="KDOC ">
</HEAD>
<BODY bgcolor="#ffffff" text="#000000" link="#0000ff" vlink="#000099" alink= "#ffffff">
<TABLE WIDTH="100%" BORDER="0">
<TR>
<TD>
<TABLE BORDER="0">
<TR><TD valign="top" align="left" cellspacing="10">
<h1>dcop Globals</h1>
</TD>
<TD valign="top" align="right" colspan="1"></TD></TR>
</TABLE>
<HR>
<TABLE BORDER="0">
</TABLE>
</TD>
<TD align="right"><TABLE BORDER="0"><TR><TD><small><A HREF="index-long.html">Annotated List</A></small></TD></TR>
<TR><TD><small><A HREF="header-list.html">Files</A></small></TD></TR>
<TR><TD><small><A HREF="all-globals.html">Globals</A></small></TD></TR>
<TR><TD><small><A HREF="hier.html">Hierarchy</A></small></TD></TR>
<TR><TD><small><A HREF="index.html">Index</A></small></TD></TR>
</TABLE></TD></TR></TABLE>
<h3>dcopc.h</h3><ul>
<LI>typedef void (*<b>dcop_callback_t</b>) (
const char * object_id,
const char * function,
const char * data,
unsigned int data_length
)
</LI>
<LI>Bool <b><A HREF="#ref336">dcop_attach</A></b> (void)
</LI>
<LI>char * <b><A HREF="#ref337">dcop_register</A></b> (const char * app_name, Bool add_pid)
</LI>
<LI>Bool <b><A HREF="#ref338">dcop_detach</A></b> (void)
</LI>
<LI>Bool <b><A HREF="#ref339">dcop_register_callback</A></b> (const char * object_id, <A HREF="#dcop_callback_t">dcop_callback_t</A> callback)
</LI>
<LI>Bool <b><A HREF="#ref340">dcop_send_signal</A></b> (
const char * receiving_app,
const char * object,
const char * function,
char * data,
int data_length
)
</LI>
<LI>Bool <b><A HREF="#ref341">dcop_call</A></b> (
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
)
</LI>
</ul>
<h3>dcopclient.h</h3><ul>
<LI>typedef QValueList<QCString> QCStringList
</LI>
</ul>
<h3>dcopglobal.h</h3><ul>
<LI>extern IcePoAuthStatus <b><A HREF="#ref349">_KDE_IcePoMagicCookie1Proc</A></b> (IceConn, void **, int, int, int, void *, int *, void **, char **)
</LI>
<LI>extern IcePaAuthStatus <b>_KDE_IcePaMagicCookie1Proc</b> (IceConn, void **, int, int, void *, int *, void **, char **)
</LI>
</ul>
<h3>dcopobject.h</h3><ul>
<LI>typedef QValueList<QCString> QCStringList
</LI>
</ul>
<h3>dcopref.h</h3><ul>
<LI><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qdatastream.html">QDataStream</A>& <b><A HREF="#ref357">operator<<</A></b> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qdatastream.html">QDataStream</A>&, const <A HREF="DCOPRef.html">DCOPRef</A>& ref )
</LI>
<LI><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qdatastream.html">QDataStream</A>& <b><A HREF="#ref358">operator>></A></b> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qdatastream.html">QDataStream</A>&, <A HREF="DCOPRef.html">DCOPRef</A>& ref )
</LI>
</ul>
<h3>dcopserver.h</h3><ul>
<LI>typedef QValueList<QCString> QCStringList
</LI>
</ul>
<h2>Global member Documentation</h2>
<A NAME="dcop_callback_t"></A><A NAME="ref335"></A><table width="100%"><tr bgcolor="#eeeeee"><td>typedef void (*<strong>dcop_callback_t</strong>) (
const char * object_id,
const char * function,
const char * data,
unsigned int data_length
)
</td><td align="right"><h3>(*<strong>dcop_callback_t</strong>)</h3></td></tr></table><p></p><p><small><code>#include <<A HREF="dcopc_h.html">dcopc.h</A>></code></small></p><A NAME="dcop_attach"></A><A NAME="ref336"></A><table width="100%"><tr bgcolor="#eeeeee"><td>Bool <strong>dcop_attach</strong> (void)
<br></td><td align="right"><h3><strong>dcop_attach</strong></h3></td></tr></table><p></p><p><small><code>#include <<A HREF="dcopc_h.html">dcopc.h</A>></code></small></p><p>
Attach to the DCOP server.
This registers you as anonymous-pid - you may then register with a 'real'
name with dcop_register().
</p>
<A NAME="dcop_register"></A><A NAME="ref337"></A><table width="100%"><tr bgcolor="#eeeeee"><td>char * <strong>dcop_register</strong> (const char * app_name, Bool add_pid)
<br></td><td align="right"><h3><strong>dcop_register</strong></h3></td></tr></table><p></p><p><small><code>#include <<A HREF="dcopc_h.html">dcopc.h</A>></code></small></p><p>
Register as app 'app_name'.
If add_pid is true, you will be registered as app_name-pid.
</p>
<p> It might not be possible to give you the exact name you requested.
In this case, the retval will be different to what you expect, so you
should not rely on getting 'app_name'.
</p>
<p> If it was not possible to register, retval is 0.
</p>
<A NAME="dcop_detach"></A><A NAME="ref338"></A><table width="100%"><tr bgcolor="#eeeeee"><td>Bool <strong>dcop_detach</strong> (void)
<br></td><td align="right"><h3><strong>dcop_detach</strong></h3></td></tr></table><p></p><p><small><code>#include <<A HREF="dcopc_h.html">dcopc.h</A>></code></small></p><p>
Detach from the DCOP server.
</p>
<A NAME="dcop_register_callback"></A><A NAME="ref339"></A><table width="100%"><tr bgcolor="#eeeeee"><td>Bool <strong>dcop_register_callback</strong> (const char * object_id, <A HREF="#dcop_callback_t">dcop_callback_t</A> callback)
<br></td><td align="right"><h3><strong>dcop_register_callback</strong></h3></td></tr></table><p></p><p><small><code>#include <<A HREF="dcopc_h.html">dcopc.h</A>></code></small></p><p>
Register the callback function for an object id.
This function should have signature dcop_callback_t. The name of the
actual function that should be called is passed in the struct.
</p>
<A NAME="dcop_send_signal"></A><A NAME="ref340"></A><table width="100%"><tr bgcolor="#eeeeee"><td>Bool <strong>dcop_send_signal</strong> (
const char * receiving_app,
const char * object,
const char * function,
char * data,
int data_length
)
<br></td><td align="right"><h3><strong>dcop_send_signal</strong></h3></td></tr></table><p></p><p><small><code>#include <<A HREF="dcopc_h.html">dcopc.h</A>></code></small></p><p>
Send a signal to a DCOP object.
</p>
<p> <code>receiving_app</code> Name the target application is registered under.
Note that you may use wildcards here. For example,
you could send to all 'konsole' objects that are
registered using the '-pid' extension with
"konsole-*".
</p>
<p> <code>object</code> Name of the remote object.
<code>function</code> Name of the function to call.
<code>data</code> Marshalled arguments to pass to function.
<code>data_length</code> Number of octets in data.
</p>
<A NAME="dcop_call"></A><A NAME="ref341"></A><table width="100%"><tr bgcolor="#eeeeee"><td>Bool <strong>dcop_call</strong> (
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
)
<br></td><td align="right"><h3><strong>dcop_call</strong></h3></td></tr></table><p></p><p><small><code>#include <<A HREF="dcopc_h.html">dcopc.h</A>></code></small></p><p>
Call a function of a DCOP object.
</p>
<p> <code>app_name</code> Name this application is registered under.
<code>remote_app_name</code> Name the target application is registered under.
<code>remote_object_id</code> Name of the remote object.
<code>remote_function</code> Name of the function to call.
<code>data</code> Marshalled arguments to pass to function.
<code>data_length</code> Number of octets in data.
<code>reply_type</code> Will be set to type of retval, represented as a string.
<code>reply_data</code> Will be set to retval (marshalled).
<code>reply_data_length</code> Will be set to number of octets in retval.
</p>
<A NAME="QCStringList"></A><A NAME="ref345"></A><table width="100%"><tr bgcolor="#eeeeee"><td>typedef <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qvaluelist.html">QValueList</A><<A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A>> <strong>QCStringList</strong></td><td align="right"><h3><strong>QCStringList</strong></h3></td></tr></table><p></p><p><small><code>#include <<A HREF="dcopclient_h.html">dcopclient.h</A>></code></small></p><A NAME="_KDE_IcePoMagicCookie1Proc"></A><A NAME="ref349"></A><table width="100%"><tr bgcolor="#eeeeee"><td>extern IcePoAuthStatus <strong>_KDE_IcePoMagicCookie1Proc</strong> (IceConn, void **, int, int, int, void *, int *, void **, char **)
<br></td><td align="right"><h3><strong>_KDE_IcePoMagicCookie1Proc</strong></h3></td></tr></table><p></p><p><small><code>#include <<A HREF="dcopglobal_h.html">dcopglobal.h</A>></code></small></p><p>
</p>
<p> DCOP Protocol description
================
</p>
<p></p>
<p> A DCOPSend message does not expect any reply.
data: << fromId << toId << objId << fun << dataSize + data[dataSize]
</p>
<p> A DCOPCall message can get a DCOPReply, a DCOPReplyFailed
or a DCOPReplyWait message in response.
data: << fromId << toId << objId << fun << dataSize + data[dataSize]
</p>
<p> DCOPReply is the successfull reply to a DCOPCall message
data: << fromId << toId << replyType << replyDataSize + replyData[replyDataSize]
</p>
<p> DCOPReplyFailed indicates failure of a DCOPCall message
data: << fromId << toId
</p>
<p> DCOPReplyWait indicates that a DCOPCall message is succesfully
being processed but that response will come later.
data: << fromId << toId << transactionId
</p>
<p> DCOPReplyDelayed is the successfull reply to a DCOPCall message
after a DCOPReplyWait message.
data: << fromId << toId << transactionId << replyType << replyData
</p>
<p> DCOPFind is a message much like a "call" message. It can however
be send to multiple objects within a client. If a function in a
object that is being called returns a boolean with the value "true",
a DCOPReply will be send back containing the DCOPRef of the object
who returned "true".
</p>
<p> All c-strings (fromId, toId, objId, fun and replyType), are marshalled with
their respective length as 32 bit unsigned integer first:
data: length + string[length]
Note: This happens automatically when using QCString on a
QDataStream.
</p>
<p> </p>
<A NAME="_KDE_IcePaMagicCookie1Proc"></A><A NAME="ref350"></A><table width="100%"><tr bgcolor="#eeeeee"><td>extern IcePaAuthStatus <strong>_KDE_IcePaMagicCookie1Proc</strong> (IceConn, void **, int, int, void *, int *, void **, char **)
<br></td><td align="right"><h3><strong>_KDE_IcePaMagicCookie1Proc</strong></h3></td></tr></table><p></p><p><small><code>#include <<A HREF="dcopglobal_h.html">dcopglobal.h</A>></code></small></p><A NAME="QCStringList"></A><A NAME="ref354"></A><table width="100%"><tr bgcolor="#eeeeee"><td>typedef <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qvaluelist.html">QValueList</A><<A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A>> <strong>QCStringList</strong></td><td align="right"><h3><strong>QCStringList</strong></h3></td></tr></table><p></p><p><small><code>#include <<A HREF="dcopobject_h.html">dcopobject.h</A>></code></small></p><A NAME="operator%3C%3C"></A><A NAME="ref357"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qdatastream.html">QDataStream</A>& <strong>operator<<</strong> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qdatastream.html">QDataStream</A>&, const <A HREF="DCOPRef.html">DCOPRef</A>& ref )
<br></td><td align="right"><h3><strong>operator<<</strong></h3></td></tr></table><p></p><p><small><code>#include <<A HREF="dcopref_h.html">dcopref.h</A>></code></small></p><p>
Writes the reference (NOT the object itself) to the stream.
</p>
<A NAME="operator%3E%3E"></A><A NAME="ref358"></A><table width="100%"><tr bgcolor="#eeeeee"><td><A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qdatastream.html">QDataStream</A>& <strong>operator>></strong> ( <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qdatastream.html">QDataStream</A>&, <A HREF="DCOPRef.html">DCOPRef</A>& ref )
<br></td><td align="right"><h3><strong>operator>></strong></h3></td></tr></table><p></p><p><small><code>#include <<A HREF="dcopref_h.html">dcopref.h</A>></code></small></p><p>
Reads a reference from the stream.
</p>
<A NAME="QCStringList"></A><A NAME="ref363"></A><table width="100%"><tr bgcolor="#eeeeee"><td>typedef <A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qvaluelist.html">QValueList</A><<A HREF="../../../../../../../../../usr/share/doc/qt-2.3.1/html/qcstring.html">QCString</A>> <strong>QCStringList</strong></td><td align="right"><h3><strong>QCStringList</strong></h3></td></tr></table><p></p><p><small><code>#include <<A HREF="dcopserver_h.html">dcopserver.h</A>></code></small></p><HR>
<table>
<tr><td><small>Generated by: qateam on updates.mandrakesoft.com on Mon Dec 30 16:08:51 2002, using kdoc 2.0a53.</small></td></tr>
</table>
</BODY>
</HTML>
