Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright (c) 2008-2018, Hazelcast, Inc. All Rights Reserved.
*
* 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 com.hazelcast.client.impl.protocol.template;
import com.hazelcast.annotation.GenerateCodec;
import com.hazelcast.annotation.Request;
import com.hazelcast.annotation.Since;
import com.hazelcast.client.impl.protocol.constants.ResponseMessageConst;
@GenerateCodec(id = TemplateConstants.LOCK_TEMPLATE_ID, name = "Lock", ns = "Hazelcast.Client.Protocol.Codec")
public interface LockCodecTemplate {
/**
* Returns whether this lock is locked or not.
*
* @param name Name of the Lock
* @return True if this lock is locked, false otherwise.
*/
@Request(id = 1, retryable = true, response = ResponseMessageConst.BOOLEAN, partitionIdentifier = "name")
Object isLocked(String name);
/**
* Returns whether this lock is locked by current thread or not.
*
* @param name Name of the Lock
* @param threadId The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation.
* @return True if this lock is locked by current thread, false otherwise.
*/
@Request(id = 2, retryable = true, response = ResponseMessageConst.BOOLEAN, partitionIdentifier = "name")
Object isLockedByCurrentThread(String name, long threadId);
/**
* Returns re-entrant lock hold count, regardless of lock ownership.
*
* @param name Name of the Lock
* @return The lock hold count.
*/
@Request(id = 3, retryable = true, response = ResponseMessageConst.INTEGER, partitionIdentifier = "name")
Object getLockCount(String name);
/**
* Returns remaining lease time in milliseconds. If the lock is not locked then -1 will be returned
*
* @param name Name of the Lock
* @return Remaining lease time in milliseconds.
*/
@Request(id = 4, retryable = true, response = ResponseMessageConst.LONG, partitionIdentifier = "name")
Object getRemainingLeaseTime(String name);
/**
* Acquires the lock for the specified lease time.After lease time, lock will be released.If the lock is not
* available then the current thread becomes disabled for thread scheduling purposes and lies dormant until the lock
* has been acquired.
*
* @param name Name of the Lock
* @param leaseTime Time to wait before releasing to lock
* @param threadId The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation.
* @param referenceId The client-wide unique id for this request. It is used to make the request idempotent by sending the same reference id during retries.
*/
@Request(id = 5, retryable = true, response = ResponseMessageConst.VOID, partitionIdentifier = "name", acquiresResource = true)
void lock(String name, long leaseTime, long threadId, @Since(value = "1.2") long referenceId);
/**
* Releases the lock.
*
* @param name Name of the Lock
* @param threadId The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation.
* @param referenceId The client-wide unique id for this request. It is used to make the request idempotent by sending the same reference id during retries.
*/
@Request(id = 6, retryable = true, response = ResponseMessageConst.VOID, partitionIdentifier = "name")
void unlock(String name, long threadId, @Since(value = "1.2") long referenceId);
/**
* Releases the lock regardless of the lock owner. It always successfully unlocks, never blocks,
* and returns immediately.
*
* @param name Name of the Lock
* @param referenceId The client-wide unique id for this request. It is used to make the request idempotent by sending the same reference id during retries.
*/
@Request(id = 7, retryable = true, response = ResponseMessageConst.VOID, partitionIdentifier = "name")
void forceUnlock(String name, @Since(value = "1.2") long referenceId);
/**
* Tries to acquire the lock for the specified lease time.After lease time, the lock will be released.
* If the lock is not available, then the current thread becomes disabled for thread scheduling purposes and lies
* dormant until one of two things happens: the lock is acquired by the current thread, or the specified waiting
* time elapses.
*
* @param name Name of the Lock
* @param threadId The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation.
* @param lease time in milliseconds to wait before releasing the lock.
* @param timeout Maximum time to wait for the lock.
* @param referenceId The client-wide unique id for this request. It is used to make the request idempotent by sending the same reference id during retries.
* @return true if the lock was acquired and false if the waiting time elapsed before the lock was acquired.
*/
@Request(id = 8, retryable = true, response = ResponseMessageConst.BOOLEAN, partitionIdentifier = "name", acquiresResource = true)
Object tryLock(String name, long threadId, long lease, long timeout, @Since(value = "1.2") long referenceId);
}
