com.graphhopper.storage.LockFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of graphhopper-core Show documentation

GraphHopper is a fast and memory efficient Java road routing engine working seamlessly with OpenStreetMap data.

There is a newer version: 10.0

/*
 *  Licensed to GraphHopper GmbH under one or more contributor
 *  license agreements. See the NOTICE file distributed with this work for
 *  additional information regarding copyright ownership.
 *
 *  GraphHopper GmbH 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.
 */
package com.graphhopper.storage;

import java.io.File;

/**
 * @author Peter Karich
 */
public interface LockFactory {
    void setLockDir(File lockDir);

    /**
     * This creates a file for write or read locks depending on the specified writeAccess property.
     * Important note: even for read locks we need write access to the underlying filesystem in
     * order to avoid writes from other processes.
     */
    GHLock create(String fileName, boolean writeAccess);

    /**
     * Removes the specified lock. Note: on windows we cannot forcefully remove an unreleased native
     * lock
     */
    void forceRemove(String fileName, boolean writeAccess);
}