ReentrantLock.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _DECAF_UTIL_CONCURRENT_LOCKS_REENTRANTLOCK_H_
#define _DECAF_UTIL_CONCURRENT_LOCKS_REENTRANTLOCK_H_

#include <decaf/util/Config.h>

#include <decaf/util/concurrent/locks/Lock.h>
#include <decaf/util/Collection.h>

namespace decaf {
namespace util {
namespace concurrent {
namespace locks {

    class Sync;

    class DECAF_API ReentrantLock : public Lock {
    private:

        // Instance of an AbstractQueuedSynchronizer specific to this type of Lock.
        // Will vary depending on whether fair or unfair lock semantics are requested.
        Sync* sync;

    private:

        ReentrantLock( const ReentrantLock& );
        ReentrantLock& operator= ( const ReentrantLock& );

    public:

        ReentrantLock();

        ReentrantLock(bool fair);

        virtual ~ReentrantLock();

        virtual void lock();

        virtual void lockInterruptibly();

        virtual bool tryLock();

        virtual bool tryLock( long long time, const TimeUnit& unit );

        virtual void unlock();

        virtual Condition* newCondition();

    public:  // Diagnostics methods.

        int getHoldCount() const;

        bool isHeldByCurrentThread() const;

        bool isLocked() const;

        bool isFair() const;

        std::string toString() const;

        int getQueueLength() const;

        int getWaitQueueLength(Condition* condition) const;

        bool hasWaiters(Condition* condition) const;

        bool hasQueuedThreads() const;

        bool hasQueuedThread(decaf::lang::Thread* thread) const;

    protected:

        decaf::util::Collection<decaf::lang::Thread*>* getWaitingThreads(Condition* condition) const;

        decaf::lang::Thread* getOwner() const;

        decaf::util::Collection<decaf::lang::Thread*>* getQueuedThreads() const;

    };

}}}}

#endif /* _DECAF_UTIL_CONCURRENT_LOCKS_REENTRANTLOCK_H_ */