KMessageDirect Class Reference

#include <KGame/KMessageIO>

Inheritance diagram for KMessageDirect:

Public Member Functions
	KMessageDirect (KMessageDirect *partner=nullptr, QObject *parent=nullptr)
	~KMessageDirect () override
bool	isConnected () const override
bool	isNetwork () const override
int	rtti () const override
void	send (const QByteArray &msg) override
Public Member Functions inherited from KMessageIO
	KMessageIO (QObject *parent=nullptr)
	~KMessageIO () override
quint32	id ()
virtual QString	peerName () const
virtual quint16	peerPort () const
void	setId (quint32 id)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

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

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
Signals inherited from KMessageIO
void	connectionBroken ()
void	received (const QByteArray &msg)
Public Slots inherited from KMessageIO
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
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)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

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 278 of file kmessageio.h.

Constructor & Destructor Documentation

KMessageDirect()

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

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 185 of file kmessageio.cpp.

~KMessageDirect()

KMessageDirect::~KMessageDirect ( )

override

Destructor, closes the connection.

Definition at line 206 of file kmessageio.cpp.

Member Function Documentation

isConnected()

bool KMessageDirect::isConnected ( ) const

overridevirtual

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 214 of file kmessageio.cpp.

isNetwork()

bool KMessageDirect::isNetwork ( ) const

inlineoverridevirtual

Returns

FALSE as this is no network IO.

Reimplemented from KMessageIO.

Definition at line 308 of file kmessageio.h.

rtti()

int KMessageDirect::rtti ( ) const

inlineoverridevirtual

The runtime identification.

Reimplemented from KMessageIO.

Definition at line 300 of file kmessageio.h.

send()

void KMessageDirect::send ( const QByteArray & msg )

overridevirtual

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 219 of file kmessageio.cpp.

Member Data Documentation

mPartner

KMessageDirect* KMessageDirect::mPartner

protected

Definition at line 332 of file kmessageio.h.

---

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

• kmessageio.h
• kmessageio.cpp