barrier.h

/* Copyright (c) 2006-2011, Stefan Eilemann <eile@equalizergraphics.com> 
 *                    2011, Cedric Stalder <cedric.stalder@gmail.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 CO_BARRIER_H
#define CO_BARRIER_H

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

#include <map>

namespace co
{
    struct BarrierEnterReplyPacket;
    class Barrier : public Object
    {
    public:
        CO_API Barrier( NodePtr master, const uint32_t height = 0 );

        CO_API Barrier();

        CO_API virtual ~Barrier();

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

        void increase() { ++_height; }

        uint32_t getHeight() const { return _height; }

        CO_API void enter( const uint32_t timeout = EQ_TIMEOUT_INDEFINITE );

    protected:
        virtual void attach( const base::UUID& id, 
                             const uint32_t instanceID );

        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;

        struct Request
        {
            Request() 
                : time( 0 )
                , timeout( EQ_TIMEOUT_INDEFINITE )
                , incarnation( 0 ){}
            uint64_t time;
            uint32_t timeout;
            uint32_t incarnation;
            Nodes nodes;
        };

        std::map< uint128_t, Request > _enteredNodes;

        base::Monitor< uint32_t > _leaveNotify;

        void _cleanup( const uint64_t time );
        void _sendNotify( const uint128_t& version, NodePtr node );

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

        EQ_TS_VAR( _thread );
    };
}

#endif // CO_BARRIER_H