kgamenetwork.h

/*
    This file is part of the TDE games library
    Copyright (C) 2001 Martin Heni (martin@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.
*/
/*
    $Id$
*/
#ifndef __KGAMENETWORK_H_
#define __KGAMENETWORK_H_
 
#include <tqstring.h>
#include <tqobject.h>
#include <tdemacros.h>
class KGameIO;
class KMessageClient;
class KMessageServer;
 
class KGameNetworkPrivate;

class TDE_EXPORT KGameNetwork : public TQObject
{
  TQ_OBJECT
  
 
public:
    KGameNetwork(int cookie=42,TQObject* parent=0);
    virtual ~KGameNetwork();

    virtual void Debug();

    bool isNetwork() const;

    bool isMaster() const;

    bool isAdmin() const;

    TQ_UINT32 gameId() const;

    bool offerConnections (TQ_UINT16 port);
    
    void setDiscoveryInfo(const TQString& type, const TQString& name=TQString());
    
    bool connectToServer(const TQString& host, TQ_UINT16 port);

    TQ_UINT16 port() const;

    TQString 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 TQByteArray& buffer, int msgid, TQ_UINT32 receiver=0, TQ_UINT32 sender=0);

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

    bool sendSystemMessage(const TQDataStream &msg, int msgid, TQ_UINT32 receiver=0, TQ_UINT32 sender=0);

    bool sendSystemMessage(const TQString& msg, int msgid, TQ_UINT32 receiver=0, TQ_UINT32 sender=0);

    void sendError(int error, const TQByteArray& message, TQ_UINT32 receiver=0, TQ_UINT32 sender=0);

    bool isOfferingConnections() const;

    int cookie() const;

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

    bool sendMessage(const TQDataStream &msg, int msgid, TQ_UINT32 receiver=0, TQ_UINT32 sender=0);

    bool sendMessage(const TQString& msg, int msgid, TQ_UINT32 receiver=0, TQ_UINT32 sender=0);

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

    virtual void networkTransmission(TQDataStream&, int, TQ_UINT32, TQ_UINT32, TQ_UINT32 clientID) = 0;
 

    void disconnect();
 

    void electAdmin(TQ_UINT32 clientID);

    KMessageClient* messageClient() const;

    KMessageServer* messageServer() const;

    virtual void lock();

    virtual void unlock();
 
signals:
    void signalNetworkErrorMessage(int error, TQString text);

    void signalConnectionBroken();

    void signalClientConnected(TQ_UINT32 clientID);

    void signalClientDisconnected(TQ_UINT32 clientID, bool broken);

    void signalAdminStatusChanged(bool isAdmin);
 
protected:
    void setMaster();
 
protected slots:
    void receiveNetworkTransmission(const TQByteArray& a, TQ_UINT32 clientID);

    void slotAdminStatusChanged(bool isAdmin);

     void aboutToLoseConnection(TQ_UINT32 id);

     void slotResetConnection();
 
 
private:
     void tryPublish();
     void tryStopPublishing();
     KGameNetworkPrivate* d;
};
 
#endif