#include <KGame/KMessageIO>

Inheritance diagram for KMessageSocket:

Public Member Functions
	KMessageSocket (const QString &host, quint16 port, QObject *parent=0)

	KMessageSocket (QHostAddress host, quint16 port, QObject *parent=0)

	KMessageSocket (QTcpSocket socket, QObject parent=0)

	KMessageSocket (int socketFD, QObject *parent=0)

	~KMessageSocket ()

bool	isConnected () const

bool	isNetwork () const

virtual QString	peerName () const

virtual quint16	peerPort () const

virtual int	rtti () const

void	send (const QByteArray &msg)

Public Member Functions inherited from KMessageIO
	KMessageIO (QObject *parent=0)

	~KMessageIO ()

quint32	id ()

void	setId (quint32 id)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Protected Slots
virtual void	processNewData ()

Protected Member Functions
void	initSocket ()

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Protected Attributes
bool	isRecursive

bool	mAwaitingHeader

quint32	mNextBlockLength

QTcpSocket *	mSocket

Protected Attributes inherited from KMessageIO
quint32	m_id

Additional Inherited Members
Public Slots inherited from KMessageIO
Signals inherited from KMessageIO
void	connectionBroken ()

void	received (const QByteArray &msg)

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

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)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from QObject
	objectName

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::KMessageSocket	(	const QString &	host,
		quint16	port,
		QObject *	parent = `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::KMessageSocket	(	QHostAddress	host,
		quint16	port,
		QObject *	parent = `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 59 of file kmessageio.cpp.

KMessageSocket::KMessageSocket	(	QTcpSocket *	socket,
		QObject *	parent = `0`
	)

explicit

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 QSocket object t ensure it is not deleted.)

Definition at line 67 of file kmessageio.cpp.

KMessageSocket::KMessageSocket	(	int	socketFD,
		QObject *	parent = `0`
	)

explicit

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

KMessageSocket::~KMessageSocket ( )

Destructor, closes the socket.

Definition at line 82 of file kmessageio.cpp.

Member Function Documentation

void KMessageSocket::initSocket ( )

protected

Definition at line 154 of file kmessageio.cpp.

bool KMessageSocket::isConnected ( ) const

virtual

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

Reimplemented from KMessageIO.

Definition at line 87 of file kmessageio.cpp.

bool KMessageSocket::isNetwork ( ) const

inlinevirtual

Returns: TRUE as this is a network IO.

Reimplemented from KMessageIO.

Definition at line 246 of file kmessageio.h.

QString KMessageSocket::peerName ( ) const

virtual

Returns: The hostname this object is connected to. See QSocket::peerName.

Reimplemented from KMessageIO.

Definition at line 169 of file kmessageio.cpp.

quint16 KMessageSocket::peerPort ( ) const

virtual

Returns: The port that this object is connected to. See QSocket::peerPort

Reimplemented from KMessageIO.

Definition at line 164 of file kmessageio.cpp.

void KMessageSocket::processNewData ( )

protectedvirtualslot

Definition at line 99 of file kmessageio.cpp.

virtual int KMessageSocket::rtti ( ) const

inlinevirtual

The runtime idendifcation.

Reimplemented from KMessageIO.

Definition at line 231 of file kmessageio.h.

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

Member Data Documentation

bool KMessageSocket::isRecursive

protected

Definition at line 270 of file kmessageio.h.

bool KMessageSocket::mAwaitingHeader

protected

Definition at line 267 of file kmessageio.h.

quint32 KMessageSocket::mNextBlockLength

protected

Definition at line 268 of file kmessageio.h.

QTcpSocket* KMessageSocket::mSocket

protected

Definition at line 266 of file kmessageio.h.

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

libkdegames/libkdegamesprivate/kgame

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

libkdegames/libkdegamesprivate/kgame

kdegames API Reference

Search