Qtopia library API Documentation

QCopEnvelope Class Reference

The QCopEnvelope class encapsulates and sends QCop messages over QCopChannels. More...

#include <qcopenvelope_qws.h>

Inheritance diagram for QCopEnvelope:

Inheritance graph
[legend]
Collaboration diagram for QCopEnvelope:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 QCopEnvelope (const QCString &channel, const QCString &message)
 ~QCopEnvelope ()

Detailed Description

The QCopEnvelope class encapsulates and sends QCop messages over QCopChannels.

QCop messages allow applications to communicate with each other. These messages are sent using QCopEnvelope, and received by connecting to a QCopChannel.

To send a message, use the following protocol:

     QCopEnvelope e(channelname, messagename);
     e << parameter1 << parameter2 << ...;

For messages without parameters, simply use:

     QCopEnvelope e(channelname, messagename);

(Do not try to simplify this further as it may confuse some compilers.)

The {channelname} of channels within Qtopia all start with "QPE/". The {messagename} is a function identifier followed by a list of types in parentheses. There is no whitespace in the message name.

To receive a message, you will generally just use your application's predefined QPE/Application/{appname} channel (see QPEApplication::appMessage()), but you can make another channel and connect it to a slot like this:

      myChannel = new QCopChannel( "QPE/FooBar", this );
      connect( myChannel, SIGNAL(received(const QCString &, const QByteArray &)),
               this, SLOT(fooBarMessage( const QCString &, const QByteArray &)) );

See also, the list of Qtopia messages.

Definition at line 28 of file qcopenvelope_qws.h.


Constructor & Destructor Documentation

QCopEnvelope::QCopEnvelope const QCString channel,
const QCString message
 

Constructs a QCopEnvelope that will write message to channel. If message has parameters, you must then use operator<<() to add these parameters to the envelope.

Definition at line 85 of file qcopenvelope_qws.cpp.

References QDataStream::device().

QCopEnvelope::~QCopEnvelope  ) 
 

Writes the message and then destroys the QCopEnvelope.

Definition at line 95 of file qcopenvelope_qws.cpp.

References QFile::close(), QByteArray::data(), QDataStream::device(), QFile::flush(), QFile::handle(), QCString::mid(), QFile::open(), and QCopChannel::send().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for OPIE Version 1.5.5.
Documentation copyright © 1997-2003 the KDE developers. 2003 OPIE developers
Generated on Tue Feb 10 20:24:16 2004 by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2001