kmessageclient.h

Go to the documentation of this file.

/*
    This file is part of the KDE games library
    Copyright (C) 2001 Burkhard Lehner (Burkhard.Lehner@gmx.de)

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2 as published by the Free Software Foundation.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef __KMESSAGECLIENT_H__
#define __KMESSAGECLIENT_H__

#include <QtCore/QObject>
#include <QtCore/QString>

#include "../libkdegamesprivate_export.h"
class KMessageIO;
class KMessageServer;
class KMessageClientPrivate;

class KDEGAMESPRIVATE_EXPORT KMessageClient : public QObject
{
  Q_OBJECT

public:

  KMessageClient (QObject *parent = 0);

  ~KMessageClient ();

  quint32 id () const;

  bool isAdmin () const;

  quint32 adminId() const;

  QList <quint32> clientList() const;

  void setServer (const QString &host, quint16 port);

  void setServer (KMessageServer *server);

  void disconnect();

  virtual void setServer (KMessageIO *connection);

  bool isConnected () const;

  bool isNetwork () const;

  quint16 peerPort () const;

  QString peerName() const;

  void sendServerMessage (const QByteArray &msg);

  //AB: processBroadcast doesn't exist!! is processIncomingMessage meant?
  void sendBroadcast (const QByteArray &msg);

  //AB: processForward doesn't exist!! is processIncomingMessage meant?
  void sendForward (const QByteArray &msg, const QList <quint32> &clients);

  void sendForward (const QByteArray &msg, quint32 client);

  void lock();

  void unlock();

  unsigned int delayedMessageCount() const;

Q_SIGNALS:
  void broadcastReceived (const QByteArray &msg, quint32 senderID);

  void forwardReceived (const QByteArray &msg, quint32 senderID, const QList <quint32> &receivers);

  void connectionBroken ();

  void aboutToDisconnect(quint32 id);

  void adminStatusChanged (bool isAdmin);

  void eventClientConnected (quint32 clientID);

  void eventClientDisconnected (quint32 clientID, bool broken);

  //AB: maybe add a setNoEmit() so that the other signals can be deactivated?
  //Could be a performance benefit (note: KMessageClient is a time critical
  //class!!!)
  void serverMessageReceived (const QByteArray &msg, bool &unknown);

protected:
  virtual void processMessage (const QByteArray& msg);

protected Q_SLOTS:
  virtual void processIncomingMessage (const QByteArray &msg);

  void processFirstMessage();

  virtual void removeBrokenConnection ();
  void removeBrokenConnection2 ();

private:
  KMessageClientPrivate * const d;
};

#endif