timedLock.h

/* Copyright (c) 2005-2012, 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 LUNCHBOX_TIMEDLOCK_H
#define LUNCHBOX_TIMEDLOCK_H

#include <lunchbox/api.h>
#include <lunchbox/nonCopyable.h> // base class
#include <lunchbox/types.h>

namespace lunchbox
{
namespace detail { class TimedLock; }

    class TimedLock : public NonCopyable
    {
    public:
        LUNCHBOX_API TimedLock();

        LUNCHBOX_API ~TimedLock();

        LUNCHBOX_API bool set( const uint32_t timeout = LB_TIMEOUT_INDEFINITE );

        LUNCHBOX_API void unset();

        LUNCHBOX_API bool trySet();

        LUNCHBOX_API bool isSet();

    private:
        detail::TimedLock* const _impl;
    };
}
#endif //LUNCHBOX_TIMEDLOCK_H