server/server.h

/* Copyright (c) 2005-2009, Stefan Eilemann <eile@equalizergraphics.com> 
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 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 Lesser General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef EQSERVER_SERVER_H
#define EQSERVER_SERVER_H

#include "base.h"
#include "types.h"
#include "visitorResult.h" // enum

#include <eq/client/nodeType.h>  // for TYPE_EQ_SERVER enum

#include <eq/net/command.h>      // used in inline method
#include <eq/net/commandQueue.h> // member
#include <eq/net/node.h>         // base class & eqsStartLocalServer declaration

namespace eq
{
namespace server
{
    class ConstServerVisitor;
    class ServerVisitor;

    class Server : public net::Node
    {
    public:
        EQSERVER_EXPORT Server();

        EQSERVER_EXPORT bool run();

        void registerConfig( Config* config );
        
        EQSERVER_EXPORT void addConfig( Config* config );

        bool removeConfig( Config* config );

        const ConfigVector& getConfigs() const { return _configs; }

        net::CommandQueue* getServerThreadQueue() 
            { return &_serverThreadQueue; }

        EQSERVER_EXPORT VisitorResult accept( ServerVisitor& visitor );
        EQSERVER_EXPORT VisitorResult accept( ConstServerVisitor& ) const;

    protected:
        virtual ~Server();

        virtual bool dispatchCommand( net::Command& command );

        virtual net::CommandResult invokeCommand( net::Command& command );
        
    private:
        uint32_t _configID;

        ConfigVector _configs;

        typedef stde::hash_map< uint32_t, Config* > ConfigHash;
        ConfigHash _appConfigs;

        net::CommandQueue    _serverThreadQueue;

        bool _running;

        union // placeholder for binary-compatible changes
        {
            char dummy[64];
        };

        virtual uint32_t getType() const { return eq::TYPE_EQ_SERVER; }

        void        _handleCommands(); 

        net::CommandResult _cmdChooseConfig( net::Command& command );
        net::CommandResult _cmdUseConfig( net::Command& command );
        net::CommandResult _cmdReleaseConfig( net::Command& command );
        net::CommandResult _cmdShutdown( net::Command& command );
    };

    EQSERVER_EXPORT std::ostream& operator << ( std::ostream&, const Server* );
}
}
#endif // EQSERVER_SERVER_H