server/pipe.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_PIPE_H
#define EQSERVER_PIPE_H

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

#include <eq/client/global.h>           // eq::OFF enum
#include <eq/client/pixelViewport.h>    // member
#include <eq/net/object.h>              // base class
#include <eq/base/monitor.h>            // member

#include <ostream>
#include <vector>

namespace eq
{
namespace server
{
    class PipeVisitor;
    class ConstPipeVisitor;
    struct ChannelPath;
    struct PipePath;

    class Pipe : public net::Object
    {
    public:
        enum State
        {
            STATE_STOPPED = 0,  // next: INITIALIZING
            STATE_INITIALIZING, // next: INIT_FAILED or INIT_SUCCESS
            STATE_INIT_SUCCESS, // next: RUNNING
            STATE_INIT_FAILED,  // next: EXITING
            STATE_RUNNING,      // next: EXITING
            STATE_EXITING,      // next: EXIT_FAILED or EXIT_SUCCESS
            STATE_EXIT_SUCCESS, // next: STOPPED
            STATE_EXIT_FAILED,  // next: STOPPED
        };

        EQSERVER_EXPORT Pipe();

        Pipe( const Pipe& from, Node* node );

        Server* getServer();
        const Server* getServer() const;

        Node*       getNode()       { return _node; }
        const Node* getNode() const { return _node; }

        Config* getConfig();
        const Config* getConfig() const;

        net::CommandQueue* getServerThreadQueue();
        net::CommandQueue* getCommandThreadQueue();

        PipePath getPath() const;

        Channel* getChannel( const ChannelPath& path );

        State getState()    const { return _state.get(); }

        EQSERVER_EXPORT void addWindow( Window* window );

        bool removeWindow( Window* window );

        const WindowVector& getWindows() const { return _windows; }

        VisitorResult accept( PipeVisitor& visitor );
        VisitorResult accept( ConstPipeVisitor& visitor ) const;

        void activate();

        void deactivate();

        bool isActive() const { return (_active != 0); }

        void addTasks( const uint32_t tasks );

        void setName( const std::string& name ) { _name = name; }
        const std::string& getName() const      { return _name; }

        void setPort( const uint32_t port )      { _port = port; }
        uint32_t getPort() const                 { return _port; }
        void setDevice( const uint32_t device )  { _device = device; }
        uint32_t getDevice() const               { return _device; }

        void setPixelViewport( const eq::PixelViewport& pvp );

        const eq::PixelViewport& getPixelViewport() const { return _pvp; }

        void setLastDrawWindow( const Window* window )
            { _lastDrawWindow = window; }
        const Window* getLastDrawWindow() const { return _lastDrawWindow; }

        void updateRunning( const uint32_t initID, const uint32_t frameNumber );

        bool syncRunning();

        void update( const uint32_t frameID, const uint32_t frameNumber );

        // Note: also update string array initialization in pipe.cpp
        enum IAttribute
        {
            IATTR_HINT_THREAD,
            IATTR_FILL1,
            IATTR_FILL2,
            IATTR_ALL
        };

        void setIAttribute( const IAttribute attr, const int32_t value )
            { _iAttributes[attr] = value; }
        int32_t  getIAttribute( const IAttribute attr ) const
            { return _iAttributes[attr]; }
        static const std::string&  getIAttributeString( const IAttribute attr )
            { return _iAttributeStrings[attr]; }

        bool isThreaded() const
            { return (getIAttribute( IATTR_HINT_THREAD ) != eq::OFF ); }

        const std::string& getErrorMessage() const { return _error; }

        void send( net::ObjectPacket& packet );

    protected:
        virtual ~Pipe();

        base::RequestHandler _requestHandler;

        virtual void attachToSession( const uint32_t id, 
                                      const uint32_t instanceID, 
                                      net::Session* session );
    private:
        std::string _name;

        int32_t _iAttributes[IATTR_ALL];
        static std::string _iAttributeStrings[IATTR_ALL];

        WindowVector _windows;

        uint32_t _active;

        std::string _error;

        Node* _node;
        friend class Node;

        uint32_t _tasks;

        base::Monitor< State > _state;
            
        uint32_t _port;

        uint32_t _device;

        /* The display (AGL) or output channel (X11?, Win32). */
        //uint32_t _monitor;

        eq::PixelViewport _pvp;

        const Window* _lastDrawWindow;

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

        void _construct();

        void _send( net::ObjectPacket& packet, const std::string& string ) ;

        void _configInit( const uint32_t initID, const uint32_t frameNumber );
        bool _syncConfigInit();
        void _configExit();
        bool _syncConfigExit();

        virtual void getInstanceData( net::DataOStream& os ) { EQDONTCALL }
        virtual void applyInstanceData( net::DataIStream& is ) { EQDONTCALL }

        /* command handler functions. */
        net::CommandResult _cmdConfigInitReply( net::Command& command );
        net::CommandResult _cmdConfigExitReply( net::Command& command );
    };

    std::ostream& operator << ( std::ostream& os, const Pipe* pipe );
}
}
#endif // EQSERVER_PIPE_H