• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • libtdegames
 

libtdegames

Public Slots | Signals | Public Member Functions | Protected Attributes | List of all members
KMessageIO Class Referenceabstract

#include <kmessageio.h>

Inheritance diagram for KMessageIO:
KMessageDirect KMessageSocket

Public Slots

virtual void send (const TQByteArray &msg)=0
 

Signals

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

Public Member Functions

 KMessageIO (TQObject *parent=0, const char *name=0)
 
 ~KMessageIO ()
 
virtual int rtti () const
 
virtual bool isNetwork () const
 
virtual bool isConnected () const
 
void setId (TQ_UINT32 id)
 
TQ_UINT32 id ()
 
virtual TQ_UINT16 peerPort () const
 
virtual TQString peerName () const
 

Protected Attributes

TQ_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::KMessageIO ( TQObject *  parent = 0,
const char *  name = 0 
)

The usual TQObject constructor, does nothing else.

Definition at line 32 of file kmessageio.cpp.

◆ ~KMessageIO()

KMessageIO::~KMessageIO ( )

The usual destructor, does nothing special.

Definition at line 36 of file kmessageio.cpp.

Member Function Documentation

◆ connectionBroken

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!

◆ id()

TQ_UINT32 KMessageIO::id ( )

Queries the ID of this object.

Definition at line 44 of file kmessageio.cpp.

◆ isConnected()

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

Definition at line 95 of file kmessageio.h.

◆ isNetwork()

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

Reimplemented in KMessageSocket, and KMessageDirect.

Definition at line 81 of file kmessageio.h.

◆ peerName()

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

Reimplemented in KMessageSocket.

Definition at line 126 of file kmessageio.h.

◆ peerPort()

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

Reimplemented in KMessageSocket.

Definition at line 120 of file kmessageio.h.

◆ received

void KMessageIO::received ( const TQByteArray &  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().

◆ rtti()

virtual int KMessageIO::rtti ( ) const
inlinevirtual

The runtime idendifcation.

Reimplemented in KMessageSocket, and KMessageDirect.

Definition at line 75 of file kmessageio.h.

◆ send

virtual void KMessageIO::send ( const TQByteArray &  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 KMessageSocket, and KMessageDirect.

◆ setId()

void KMessageIO::setId ( TQ_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.

Member Data Documentation

◆ m_id

TQ_UINT32 KMessageIO::m_id
protected

Definition at line 161 of file kmessageio.h.


The documentation for this class was generated from the following files:
  • kmessageio.h
  • kmessageio.cpp

libtdegames

Skip menu "libtdegames"
  • Main Page
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

libtdegames

Skip menu "libtdegames"
  • libtdegames
Generated for libtdegames by doxygen 1.9.4
This website is maintained by Timothy Pearson.