com.alachisoft.ncache.client.datastructures.Lockable Maven / Gradle / Ivy

Go to download
package com.alachisoft.ncache.client.datastructures;


//  Copyright (c) 2020 Alachisoft
//
//  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

import com.alachisoft.ncache.runtime.util.TimeSpan;

/**
 * This interface contains methods and parameters required for locking data structures.
 */
public interface Lockable {
    /**
     * Acquire a lock on an collection in cache.
     * @param timeout The timeout after which lock will be automatically released.
     * @return True if lock was acquired successfully;otherwise false.
     */
    boolean lock(TimeSpan timeout);

    /**
     * Unlock a locked collection
     */
    void unlock() ;
}