QCopChannel Class Reference

 #include <QCopChannel>

Member Function Documentation

QCopChannel::QCopChannel ( const QString & channel, QObject * parent = 0 )

Constructs a QCopChannel object for the specified channel, with the given parent. Once created, the channel is registered by the server.

See also isRegistered() and channel().

QCopChannel::~QCopChannel () [virtual]

Destroys this QCopChannel object.

The server is notified that this particular listener has closed its connection. The server will keep the channel open until the last registered listener detaches.

See also isRegistered() and channel().

QString QCopChannel::channel () const

Returns the name of this object's channel.

See also isRegistered().

bool QCopChannel::flush () [static]

Flushes all queued messages to the registered listeners.

Note that this function returns false if no QApplication has been constructed, otherwise it returns true.

This function was introduced in Qt 4.2.

See also send().

bool QCopChannel::isRegistered ( const QString & channel ) [static]

Queries the server for the existence of the given channel. Returns true if the channel is registered; otherwise returns false.

See also channel() and send().

void QCopChannel::receive ( const QString & message, const QByteArray & data ) [virtual]

Processes the incoming message and data.

This function is called by the server when this object's channel receives new messages. Note that the default implementation simply emits the received() signal; reimplement this function to process the incoming message and data.

Note that the format of the given data has to be well defined in order to extract the information it contains. In addition, it is recommended to use the DCOP convention. This is not a requirement, but you must ensure that the sender and receiver agree on the argument types. For example:

 void MyClass::receive(const QString &message, const QByteArray &data)
 {
     QDataStream in(data);
     if (message == "execute(QString,QString)") {
         QString cmd;
         QString arg;
         in >> cmd >> arg;
         ...
     } else if (message == "delete(QString)") {
         QString fileName;
         in >> fileName;
         ...
     } else {
         ...
     }
 }

The above code assumes that the message is a DCOP-style function signature and the data contains the function's arguments.

See also send(), channel(), and received().

void QCopChannel::received ( const QString & message, const QByteArray & data ) [signal]

This signal is emitted whenever this object's channel receives new messages (i.e., it is emitted by the receive() function), passing the incoming message and data as parameters.

See also receive() and channel().

bool QCopChannel::send ( const QString & channel, const QString & message, const QByteArray & data ) [static]

Sends the given message on the specified channel with the given data. The message will be distributed to all clients subscribed to the channel. Returns true if the message is sent successfully; otherwise returns false.

It is recommended to use the DCOP convention. This is not a requirement, but you must ensure that the sender and receiver agree on the argument types.

Note that QDataStream provides a convenient way to fill the byte array with auxiliary data. For example:

 QByteArray data;
 QDataStream out(&data, QIODevice::WriteOnly);
 out << QString("cat") << QString("file.txt");
 QCopChannel::send("System/Shell", "execute(QString,QString)", data);

In the code above the channel is "System/Shell". The message is an arbitrary string, but in the example we've used the DCOP convention of passing a function signature. Such a signature is formatted as "functionname(types)" where types is a list of zero or more comma-separated type names, with no whitespace, no consts and no pointer or reference marks, i.e. no "*" or "&".

See also receive() and isRegistered().

bool QCopChannel::send ( const QString & channel, const QString & message ) [static]

This is an overloaded function.