barrier.h

/* Copyright (c) 2006-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 EQNET_BARRIER_H
#define EQNET_BARRIER_H

#include <eq/net/object.h>   // base class
#include <eq/net/types.h>
#include <eq/base/monitor.h> // member

#include <map>

namespace eq
{
namespace net
{
    class Node;

    class Barrier : public Object
    {
    public:
        EQ_EXPORT Barrier( NodePtr master, const uint32_t height = 0 );

        EQ_EXPORT Barrier();

        EQ_EXPORT virtual ~Barrier();

        void setHeight( const uint32_t height ) { _height = height; }

        void increase() { ++_height; }

        uint32_t getHeight() const { return _height; }

        EQ_EXPORT void enter();

    protected:
        virtual void attachToSession( const uint32_t id, 
                                      const uint32_t instanceID, 
                                      Session* session );
        virtual ChangeType getChangeType() const { return DELTA; }

        virtual void getInstanceData( DataOStream& os );
        virtual void applyInstanceData( DataIStream& is );
        virtual void pack( DataOStream& os );
        virtual void unpack( DataIStream& is );

    private:
        NodeID   _masterID;

        uint32_t _height;

        NodePtr _master;

        std::map< uint32_t, NodeVector > _enteredNodes;
        
        base::Monitor<uint32_t> _leaveNotify;

        /* The command handlers. */
        CommandResult _cmdEnter( Command& command );
        CommandResult _cmdEnterReply( Command& command );

        CHECK_THREAD_DECLARE( _thread );
    };
}
}

#endif // EQNET_BARRIER_H