KMessageIO

Search for usage in LXR

#include <KGame/KMessageIO>

Inheritance diagram for KMessageIO:

Signals

void connectionBroken ()
 
void received (const QByteArray &msg)
 

Public Slots

virtual void send (const QByteArray &msg)=0
 

Public Member Functions

 KMessageIO (QObject *parent=nullptr)
 
 ~KMessageIO () override
 
quint32 id ()
 
virtual bool isConnected () const
 
virtual bool isNetwork () const
 
virtual QString peerName () const
 
virtual quint16 peerPort () const
 
virtual int rtti () const
 
void setId (quint32 id)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Protected Attributes

quint32 m_id
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction 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)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

This abstract base class represents one end of a message connections between two clients.

Each client has one object of a subclass of KMessageIO. Calling /e send() on one object will emit the signal /e received() on the other object, and vice versa.

For each type of connection (TCP/IP socket, COM port, direct connection within the same class) a subclass of KMessageIO must be defined that implements the pure virtual methods /e send() and /e isConnected(), and sends the signals. (See /e KMessageSocket for an example implementation.)

Two subclasses are already included: /e KMessageSocket (connection using TCP/IP sockets) and /e KMessageDirect (connection using method calls, both sides must be within the same process).

Definition at line 51 of file kmessageio.h.

Constructor & Destructor Documentation

KMessageIO::KMessageIO ( QObject parent = nullptr)
explicit

The usual QObject constructor, does nothing else.

Definition at line 22 of file kmessageio.cpp.

KMessageIO::~KMessageIO ( )
override

The usual destructor, does nothing special.

Definition at line 27 of file kmessageio.cpp.

Member Function Documentation

void KMessageIO::connectionBroken ( )
signal

This signal is emitted when the connection is closed.

This can be caused by a hardware error (e.g. broken internet connection) or because the other object was killed.

Note: Sometimes a broken connection can be undetected for a long time, or may never be detected at all. So don't rely on this signal!

quint32 KMessageIO::id ( )

Queries the ID of this object.

Definition at line 35 of file kmessageio.cpp.

virtual bool KMessageIO::isConnected ( ) const
inlinevirtual

This method returns the status of the object, whether it is already (or still) connected to another KMessageIO object or not.

This is a pure virtual method, so it has to be implemented in a subclass of KMessageIO.

Reimplemented in KMessageDirect, and KMessageSocket.

Definition at line 89 of file kmessageio.h.

virtual bool KMessageIO::isNetwork ( ) const
inlinevirtual
Returns
Whether this KMessageIO is a network IO or not.

Reimplemented in KMessageDirect, and KMessageSocket.

Definition at line 75 of file kmessageio.h.

virtual QString KMessageIO::peerName ( ) const
inlinevirtual
Returns
"localhost" in the default implementation. Reimplemented in KMessageSocket

Reimplemented in KMessageSocket.

Definition at line 118 of file kmessageio.h.

virtual quint16 KMessageIO::peerPort ( ) const
inlinevirtual
Returns
0 in the default implementation. Reimplemented in KMessageSocket.

Reimplemented in KMessageSocket.

Definition at line 113 of file kmessageio.h.

void KMessageIO::received ( const QByteArray msg)
signal

This signal is emitted when /e send() on the connected KMessageIO object is called.

The parameter contains the same data array in /e msg as was used in /e send().

virtual int KMessageIO::rtti ( ) const
inlinevirtual

The runtime identification.

Reimplemented in KMessageDirect, and KMessageSocket.

Definition at line 69 of file kmessageio.h.

virtual void KMessageIO::send ( const QByteArray msg)
pure virtualslot

This slot sends the data block in /e msg to the connected object, that will emit /e received().

For a concrete class, you have to subclass /e KMessageIO and overwrite this method. In the subclass, implement this method as an ordinary method, not as a slot! (Otherwise another slot would be defined. It would work, but uses more memory and time.) See /e KMessageSocket for an example implementation.

Implemented in KMessageDirect, and KMessageSocket.

void KMessageIO::setId ( quint32  id)

Sets the ID number of this object.

This number can for example be used to distinguish several objects in a server.

NOTE: Sometimes it is useful to let two connected KMessageIO objects have the same ID number. You have to do so yourself, KMessageIO doesn't change this value on its own!

Definition at line 30 of file kmessageio.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Sat Jan 22 2022 22:34:23 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.