KMessageDirect Class Reference

#include <KGame/KMessageIO>

Inheritance diagram for KMessageDirect:

Public Member Functions
	KMessageDirect (KMessageDirect *partner=0, QObject *parent=0)
	~KMessageDirect ()
bool	isConnected () const
bool	isNetwork () const
virtual int	rtti () const
void	send (const QByteArray &msg)
Public Member Functions inherited from KMessageIO
	KMessageIO (QObject *parent=0)
	~KMessageIO ()
quint32	id ()
virtual QString	peerName () const
virtual quint16	peerPort () const
void	setId (quint32 id)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Protected Attributes
KMessageDirect *	mPartner
Protected Attributes inherited from KMessageIO
quint32	m_id

Additional Inherited Members
Public Slots inherited from KMessageIO
Signals inherited from KMessageIO
void	connectionBroken ()
void	received (const QByteArray &msg)
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

This class implements the message communication using function calls directly.

It can only be used when both sides of the message pipe are within the same process. The communication is very fast.

To establish a communication, you have to create two instances of KMessageDirect, the first one with no parameters in the constructor, the second one with the first as parameter:

/code KMessageDirect *peer1, *peer2; peer1 = new KMessageDirect (); // unconnected peer2 = new KMessageDirect (peer1); // connect with peer1 /endcode

The connection is only closed when one of the instances is deleted.

Definition at line 294 of file kmessageio.h.

Constructor & Destructor Documentation

KMessageDirect::KMessageDirect ( KMessageDirect *  partner = 0, QObject *  parent = 0  )

explicit

Creates an object and connects it to the object given in the first parameter.

Use 0 as first parameter to create an unconnected object, that is later connected.

If that object is already connected, the object remains unconnected.

Definition at line 176 of file kmessageio.cpp.

KMessageDirect::~KMessageDirect

(

)

Destructor, closes the connection.

Definition at line 197 of file kmessageio.cpp.

Member Function Documentation

bool KMessageDirect::isConnected ( ) const

virtual

Returns true, if the object is connected to another instance.

If you use the first constructor, the object is unconnected unless another object is created with this one as parameter.

The connection can only be closed by deleting one of the objects.

Reimplemented from KMessageIO.

Definition at line 206 of file kmessageio.cpp.

bool KMessageDirect::isNetwork ( ) const

inlinevirtual

Returns

FALSE as this is no network IO.

Reimplemented from KMessageIO.

Definition at line 322 of file kmessageio.h.

virtual int KMessageDirect::rtti ( ) const

inlinevirtual

The runtime idendifcation.

Reimplemented from KMessageIO.

Definition at line 316 of file kmessageio.h.

void KMessageDirect::send ( const QByteArray &  msg )

virtual

Overwritten slot method from KMessageIO.

Note: It is not declared as a slot method, since the slot is already defined in KMessageIO as a virtual method.

Implements KMessageIO.

Definition at line 211 of file kmessageio.cpp.

Member Data Documentation

KMessageDirect* KMessageDirect::mPartner

protected

Definition at line 343 of file kmessageio.h.

---

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

• kmessageio.h
• kmessageio.cpp