net.openhft.chronicle.queue.impl.single.QueueLock Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of chronicle-queue Show documentation

Java library for persisted low latency messaging (Java 8+)

There is a newer version: 5.27ea0

/*
 * Copyright 2016-2022 Chronicle Software
 *
 *       https://chronicle.software
 *
 * Licensed 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.
 */
package net.openhft.chronicle.queue.impl.single;

import net.openhft.chronicle.core.io.Closeable;

@Deprecated(/* To be removed in x.25 */)
public interface QueueLock extends Closeable {

    void waitForLock();

    /**
     * Guaranteed to lock or throw
     */
    void acquireLock();

    /**
     * Tries to unlock, and if it can't, logs a warning
     */
    void unlock();

    /**
     * only unlocks if locked
     */
    void quietUnlock();

    /**
     * Is this lock locked?
     *
     * @return true if the lock is locked
     */
    boolean isLocked();

    default boolean forceUnlockIfProcessIsDead() {
        return true;
    }
}