libkdegames Library API Documentation

KMessageIO Class Reference

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

#include <kmessageio.h>

Inheritance diagram for KMessageIO:

QObject KMessageDirect KMessageSocket List of all members.

Public Slots

virtual void send (const QByteArray &msg)=0

Signals

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

Public Member Functions

 KMessageIO (QObject *parent=0, const char *name=0)
 ~KMessageIO ()
virtual int rtti () const
virtual bool isNetwork () const
virtual bool isConnected () const
void setId (Q_UINT32 id)
Q_UINT32 id ()
virtual Q_UINT16 peerPort () const
virtual QString peerName () const

Protected Attributes

Q_UINT32 m_id

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


Constructor & Destructor Documentation

KMessageIO::KMessageIO QObject parent = 0,
const char *  name = 0
 

The usual QObject constructor, does nothing else.

Definition at line 32 of file kmessageio.cpp.

KMessageIO::~KMessageIO  ) 
 

The usual destructor, does nothing special.

Definition at line 36 of file kmessageio.cpp.


Member Function Documentation

virtual int KMessageIO::rtti  )  const [inline, virtual]
 

The runtime idendifcation.

Reimplemented in KMessageSocket, and KMessageDirect.

Definition at line 74 of file kmessageio.h.

Referenced by KGameNetwork::disconnect().

virtual bool KMessageIO::isNetwork  )  const [inline, virtual]
 

Returns:
Whether this KMessageIO is a network IO or not.

Reimplemented in KMessageSocket, and KMessageDirect.

Definition at line 80 of file kmessageio.h.

virtual bool KMessageIO::isConnected  )  const [inline, virtual]
 

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 KMessageSocket, and KMessageDirect.

Definition at line 94 of file kmessageio.h.

void KMessageIO::setId Q_UINT32  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 39 of file kmessageio.cpp.

Referenced by KMessageServer::addClient().

Q_UINT32 KMessageIO::id  ) 
 

Queries the ID of this object.

Definition at line 44 of file kmessageio.cpp.

Referenced by KMessageServer::addClient(), KMessageServer::getReceivedMessage(), and KMessageServer::removeClient().

virtual Q_UINT16 KMessageIO::peerPort  )  const [inline, virtual]
 

Since:
3.2

Returns:
0 in the default implementation. Reimplemented in KMessageSocket.

Reimplemented in KMessageSocket.

Definition at line 119 of file kmessageio.h.

virtual QString KMessageIO::peerName  )  const [inline, virtual]
 

Since:
3.2

Returns:
"localhost" in the default implementation. Reimplemented in KMessageSocket

Reimplemented in KMessageSocket.

Definition at line 125 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().

Referenced by KMessageDirect::send().

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!

Referenced by KMessageDirect::~KMessageDirect().

virtual void KMessageIO::send const QByteArray msg  )  [pure virtual, slot]
 

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 KMessageSocket, and KMessageDirect.

Referenced by KMessageServer::addClient(), and KMessageServer::sendMessage().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkdegames Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Aug 26 00:21:45 2004 by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2003