kgamenetwork.h

Go to the documentation of this file.

/*
    This file is part of the KDE games library
    Copyright (C) 2001 Martin Heni (kde at heni-online.de)
    Copyright (C) 2001 Andreas Beckermann (b_mann@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 __KGAMENETWORK_H_
#define __KGAMENETWORK_H_

#include <QtCore/QString>
#include <QtCore/QObject>
#include "../libkdegamesprivate_export.h"

class KGameIO;
class KMessageIO;
class KMessageClient;
class KMessageServer;

class KGameNetworkPrivate;

class KDEGAMESPRIVATE_EXPORT KGameNetwork : public QObject
{
  Q_OBJECT

public:
    explicit KGameNetwork(int cookie=42,QObject* parent=0);
    virtual ~KGameNetwork();

    virtual void Debug();

    bool isNetwork() const;

    bool isMaster() const;

    bool isAdmin() const;

    quint32 gameId() const;

    bool offerConnections (quint16 port);

    void setDiscoveryInfo(const QString& type, const QString& name=QString());
    
    bool connectToServer(const QString& host, quint16 port);
    bool connectToServer(KMessageIO *connection);
    
    quint16 port() const;

    QString hostName() const;

    bool stopServerConnection();

    void setMaxClients(int max);

    //AB: is this now internal only? Can we make it protected (maybe with
    //friends)? sendSystemMessage AND sendMessage is very confusing to the
    //user.
    // AB: TODO: doc on how "receiver" and "sender" should be created!
    bool sendSystemMessage(const QByteArray& buffer, int msgid, quint32 receiver=0, quint32 sender=0);

    bool sendSystemMessage(int data, int msgid, quint32 receiver=0, quint32 sender=0);

    bool sendSystemMessage(const QDataStream &msg, int msgid, quint32 receiver=0, quint32 sender=0);

    bool sendSystemMessage(const QString& msg, int msgid, quint32 receiver=0, quint32 sender=0);

    void sendError(int error, const QByteArray& message, quint32 receiver=0, quint32 sender=0);

    bool isOfferingConnections() const;

    int cookie() const;

    // AB: TODO: doc on how "receiver" and "sender" should be created!
    bool sendMessage(const QByteArray& buffer, int msgid, quint32 receiver=0, quint32 sender=0);

    bool sendMessage(const QDataStream &msg, int msgid, quint32 receiver=0, quint32 sender=0);

    bool sendMessage(const QString& msg, int msgid, quint32 receiver=0, quint32 sender=0);

    bool sendMessage(int data, int msgid, quint32 receiver=0, quint32 sender=0);


    virtual void networkTransmission(QDataStream&, int, quint32, quint32, quint32 clientID) = 0;


    void disconnect();


    void electAdmin(quint32 clientID);

    KMessageClient* messageClient() const;

    KMessageServer* messageServer() const;

    virtual void lock();

    virtual void unlock();

Q_SIGNALS:
    void signalNetworkErrorMessage(int error, QString text);

    void signalConnectionBroken();

    void signalClientConnected(quint32 clientID);

    void signalClientDisconnected(quint32 clientID, bool broken);

    void signalAdminStatusChanged(bool isAdmin);

protected:
    void setMaster();

protected Q_SLOTS:
    void receiveNetworkTransmission(const QByteArray& a, quint32 clientID);

    void slotAdminStatusChanged(bool isAdmin);

     void aboutToLoseConnection(quint32 id);

     void slotResetConnection();


private:
     void tryPublish();
     void tryStopPublishing();
     KGameNetworkPrivate* const d;
};

#endif