barrier.h

/* Copyright (c) 2006-2014, Stefan Eilemann <eile@equalizergraphics.com>
 *                    2011, Cedric Stalder <cedric.stalder@gmail.com>
 *
 * This file is part of Collage <https://github.com/Eyescale/Collage>
 *
 * 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>

namespace co
{
namespace detail { class Barrier; }

class Barrier : public Object
{
public:
#ifdef COLLAGE_V1_API

    CO_API Barrier( NodePtr master = 0, const uint32_t height = 0 );
#endif

    CO_API Barrier( LocalNodePtr localNode,
                    const uint128_t& masterNodeID,
                    const uint32_t height = 0 );

    CO_API Barrier( LocalNodePtr localNode, const ObjectVersion& barrier );

    CO_API virtual ~Barrier();

    bool isGood() const { return isAttached(); }

    CO_API void setHeight( const uint32_t height );

    CO_API void increase();

    CO_API uint32_t getHeight() const;

    CO_API void enter( const uint32_t timeout = LB_TIMEOUT_INDEFINITE );

protected:
    void attach( const uint128_t& id, const uint32_t instanceID ) override;
    ChangeType getChangeType() const override { return DELTA; }

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

private:
    detail::Barrier* const _impl;

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

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

    LB_TS_VAR( _thread );
};
}

#endif // CO_BARRIER_H