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

libtdegames

Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
KMessageSocket Class Reference

#include <kmessageio.h>

Inheritance diagram for KMessageSocket:
KMessageIO

Public Member Functions

 KMessageSocket (TQString host, TQ_UINT16 port, TQObject *parent=0, const char *name=0)
 
 KMessageSocket (TQHostAddress host, TQ_UINT16 port, TQObject *parent=0, const char *name=0)
 
 KMessageSocket (TQSocket *socket, TQObject *parent=0, const char *name=0)
 
 KMessageSocket (int socketFD, TQObject *parent=0, const char *name=0)
 
 ~KMessageSocket ()
 
virtual int rtti () const
 
virtual TQ_UINT16 peerPort () const
 
virtual TQString peerName () const
 
bool isNetwork () const
 
bool isConnected () const
 
void send (const TQByteArray &msg)
 
- Public Member Functions inherited from KMessageIO
 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 Slots

virtual void processNewData ()
 

Protected Member Functions

void initSocket ()
 

Protected Attributes

TQSocket * mSocket
 
bool mAwaitingHeader
 
TQ_UINT32 mNextBlockLength
 
bool isRecursive
 
- Protected Attributes inherited from KMessageIO
TQ_UINT32 m_id
 

Additional Inherited Members

- Public Slots inherited from KMessageIO
virtual void send (const TQByteArray &msg)=0
 
- Signals inherited from KMessageIO
void received (const TQByteArray &msg)
 
void connectionBroken ()
 

Detailed Description

This class implements the message communication using a TCP/IP socket.

The object can connect to a server socket, or can use an already connected socket.

Definition at line 170 of file kmessageio.h.

Constructor & Destructor Documentation

◆ KMessageSocket() [1/4]

KMessageSocket::KMessageSocket ( TQString  host,
TQ_UINT16  port,
TQObject *  parent = 0,
const char *  name = 0 
)

Connects to a server socket on /e host with /e port.

host can be an numerical (e.g. "192.168.0.212") or symbolic (e.g. "wave.peter.org") IP address. You can immediately use the /e sendSystem() and /e sendBroadcast() methods. The messages are stored and sent to the receiver after the connection is established.

If the connection could not be established (e.g. unknown host or no server socket at this port), the signal /e connectionBroken is emitted.

Definition at line 51 of file kmessageio.cpp.

◆ KMessageSocket() [2/4]

KMessageSocket::KMessageSocket ( TQHostAddress  host,
TQ_UINT16  port,
TQObject *  parent = 0,
const char *  name = 0 
)

Connects to a server socket on /e host with /e port.

You can immediately use the /e sendSystem() and /e sendBroadcast() methods. The messages are stored and sent to the receiver after the connection is established.

If the connection could not be established (e.g. unknown host or no server socket at this port), the signal /e connectionBroken is emitted.

Definition at line 60 of file kmessageio.cpp.

◆ KMessageSocket() [3/4]

KMessageSocket::KMessageSocket ( TQSocket *  socket,
TQObject *  parent = 0,
const char *  name = 0 
)

Uses /e socket to do the communication.

The socket should already be connected, or at least be in /e connecting state.

Note: The /e socket object is then owned by the /e KMessageSocket object. So don't use it otherwise any more and don't delete it. It is deleted together with this KMessageSocket object. (Use 0 as parent for the TQSocket object t ensure it is not deleted.)

Definition at line 69 of file kmessageio.cpp.

◆ KMessageSocket() [4/4]

KMessageSocket::KMessageSocket ( int  socketFD,
TQObject *  parent = 0,
const char *  name = 0 
)

Uses the socket specified by the socket descriptor socketFD to do the communication.

The socket must already be connected.

This constructor can be used with a TQServerSocket within the (pure virtual) method /e newConnection.

Note: The socket is then owned by the /e KMessageSocket object. So don't manipulate the socket afterwards, especially don't close it. The socket is automatically closed when KMessageSocket is deleted.

Definition at line 77 of file kmessageio.cpp.

◆ ~KMessageSocket()

KMessageSocket::~KMessageSocket ( )

Destructor, closes the socket.

Definition at line 86 of file kmessageio.cpp.

Member Function Documentation

◆ initSocket()

void KMessageSocket::initSocket ( )
protected

Definition at line 158 of file kmessageio.cpp.

◆ isConnected()

bool KMessageSocket::isConnected ( ) const
virtual

Returns true if the socket is in state /e connected.

Reimplemented from KMessageIO.

Definition at line 91 of file kmessageio.cpp.

◆ isNetwork()

bool KMessageSocket::isNetwork ( ) const
inlinevirtual
Returns
true as this is a network IO.

Reimplemented from KMessageIO.

Definition at line 251 of file kmessageio.h.

◆ peerName()

TQString KMessageSocket::peerName ( ) const
virtual
Since
3.2
Returns
The hostname this object is connected to. See TQSocket::peerName.

Reimplemented from KMessageIO.

Definition at line 173 of file kmessageio.cpp.

◆ peerPort()

TQ_UINT16 KMessageSocket::peerPort ( ) const
virtual
Since
3.2
Returns
The port that this object is connected to. See TQSocket::peerPort

Reimplemented from KMessageIO.

Definition at line 168 of file kmessageio.cpp.

◆ processNewData

void KMessageSocket::processNewData ( )
protectedvirtualslot

Definition at line 103 of file kmessageio.cpp.

◆ rtti()

virtual int KMessageSocket::rtti ( ) const
inlinevirtual

The runtime idendifcation.

Reimplemented from KMessageIO.

Definition at line 234 of file kmessageio.h.

◆ send()

void KMessageSocket::send ( const TQByteArray &  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 96 of file kmessageio.cpp.

Member Data Documentation

◆ isRecursive

bool KMessageSocket::isRecursive
protected

Definition at line 275 of file kmessageio.h.

◆ mAwaitingHeader

bool KMessageSocket::mAwaitingHeader
protected

Definition at line 272 of file kmessageio.h.

◆ mNextBlockLength

TQ_UINT32 KMessageSocket::mNextBlockLength
protected

Definition at line 273 of file kmessageio.h.

◆ mSocket

TQSocket* KMessageSocket::mSocket
protected

Definition at line 271 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.