kmessageserver.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 __KMESSAGESERVER_H__
#define __KMESSAGESERVER_H__

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

class KMessageIO;
class KMessageServerPrivate;

class KDEGAMESPRIVATE_EXPORT KMessageServer : public QObject
{
  Q_OBJECT

public:
    enum { 
            REQ_BROADCAST = 1, 
            REQ_FORWARD,
            REQ_CLIENT_ID,
            REQ_ADMIN_ID,
            REQ_ADMIN_CHANGE,
            REQ_REMOVE_CLIENT,
            REQ_MAX_NUM_CLIENTS,
            REQ_CLIENT_LIST,
            REQ_MAX_REQ = 0xffff };

    enum {
            MSG_BROADCAST = 101, 
            MSG_FORWARD, 
            ANS_CLIENT_ID, 
            ANS_ADMIN_ID, 
            ANS_CLIENT_LIST,
            EVNT_CLIENT_CONNECTED, 
            EVNT_CLIENT_DISCONNECTED,
            EVNT_MAX_EVNT = 0xffff
    };

    explicit KMessageServer(quint16 cookie = 42, QObject* parent = 0);

    ~KMessageServer();

    virtual void Debug();

//---------------------------------- TCP/IP server stuff

    bool initNetwork (quint16 port = 0);

    quint16 serverPort () const;

    void stopNetwork();

    bool isOfferingConnections() const;

//---------------------------------- adding / removing clients

public Q_SLOTS:
    void addClient (KMessageIO *);

    void removeClient (KMessageIO *io, bool broken);

    void deleteClients();

private Q_SLOTS:
    void removeBrokenClient ();

public:
    void setMaxClients(int maxnumber);

    int maxClients() const;

    int clientCount() const;

    QList <quint32> clientIDs() const;

    KMessageIO *findClient (quint32 no) const;

    quint32 adminID() const;

    void setAdmin (quint32 adminID);


//------------------------------ ID stuff

    /*
     * The unique ID of this game
     *
     * @return int id
     **/
//    int gameId() const;

    /*
     * Application cookie. this idendifies the game application. It
     * help to distinguish between e.g. KPoker and KWin4
     *
     * @return the application cookie
     **/
//    int cookie() const;

//------------------------------ Message stuff

public:
    virtual void broadcastMessage (const QByteArray &msg);

    virtual void sendMessage (quint32 id, const QByteArray &msg);

    virtual void sendMessage (const QList <quint32> &ids, const QByteArray &msg);

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

    virtual void processOneMessage ();

//---------------------------- Signals

Q_SIGNALS:
    void clientConnected (KMessageIO *client);

    void connectionLost (KMessageIO *client);

    void messageReceived (const QByteArray &data, quint32 clientID, bool &unknown);

protected:
    quint32 uniqueClientNumber() const;

private:
    KMessageServerPrivate* d;
};


#endif