lib/client/server.h

/* Copyright (c) 2005-2008, 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 EQ_SERVER_H
#define EQ_SERVER_H

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

#include <eq/net/node.h>         // base class

namespace eq
{
    class Client;
    class Config;
    class ConfigParams;
    class Node;
    struct ServerPacket;

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

        void setClient( ClientPtr client );
        ClientPtr getClient(){ return _client; }

        EQ_EXPORT net::CommandQueue* getNodeThreadQueue();
        EQ_EXPORT net::CommandQueue* getCommandThreadQueue();

        EQ_EXPORT Config* chooseConfig( const ConfigParams& parameters );

        EQ_EXPORT Config* useConfig( const ConfigParams& parameters, 
                                     const std::string& config );

        EQ_EXPORT void releaseConfig( Config* config );

        EQ_EXPORT bool shutdown();

    protected:
        EQ_EXPORT virtual ~Server();

    private:
        ClientPtr _client;
        friend class Client; // to call invokeCommand()

        bool _localServer;

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

        virtual uint32_t getType() const { return TYPE_EQ_SERVER; }

        /* The command handler functions. */
        net::CommandResult _cmdCreateConfig( net::Command& command );
        net::CommandResult _cmdDestroyConfig( net::Command& command );
        net::CommandResult _cmdChooseConfigReply( net::Command& command );
        net::CommandResult _cmdReleaseConfigReply( net::Command& command );
        net::CommandResult _cmdShutdownReply( net::Command& command );
    };

    inline std::ostream& operator << ( std::ostream& os, const Server* server )
    {
        if( !server )
        {
            os << "NULL server";
            return os;
        }

        os << "server " << (void*)server;
        return os;
    }
}

#endif // EQ_SERVER_H