lib/client/client.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 EQ_CLIENT_H
#define EQ_CLIENT_H

#include <eq/client/types.h>        // basic types
#include <eq/client/windowSystem.h> // WindowSystem enum

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

namespace eq
{
    class CommandQueue;
    class Server;

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

        EQ_EXPORT virtual ~Client();

        EQ_EXPORT bool connectServer( ServerPtr server );

        EQ_EXPORT bool disconnectServer( ServerPtr server );

        EQ_EXPORT bool hasCommands();

        EQ_EXPORT void processCommand();

        EQ_EXPORT virtual bool listen();
        EQ_EXPORT virtual bool stopListening();

        EQ_EXPORT void setWindowSystem( const WindowSystem windowSystem );

        CommandQueue* getNodeThreadQueue() { return _nodeThreadQueue; }

    protected:
        EQ_EXPORT virtual bool clientLoop();
        EQ_EXPORT virtual bool exitClient();

    private:
        CommandQueue* _nodeThreadQueue;
        
        bool _running;

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

        EQ_EXPORT virtual net::NodePtr createNode( const uint32_t type );
        
        EQ_EXPORT virtual bool dispatchCommand( net::Command& command );

        EQ_EXPORT virtual net::CommandResult invokeCommand( net::Command& );

        net::CommandResult _cmdExit( net::Command& command );
    };
}

#endif // EQ_CLIENT_H