com.hazelcast.client.impl.protocol.template

Interface LockCodecTemplate

public interface LockCodecTemplate

Method Summary

Modifier and Type	Method and Description
void	forceUnlock(String name, long referenceId) Releases the lock regardless of the lock owner.
Object	getLockCount(String name) Returns re-entrant lock hold count, regardless of lock ownership.
Object	getRemainingLeaseTime(String name) Returns remaining lease time in milliseconds.
Object	isLocked(String name) Returns whether this lock is locked or not.
Object	isLockedByCurrentThread(String name, long threadId) Returns whether this lock is locked by current thread or not.
void	lock(String name, long leaseTime, long threadId, long referenceId) 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.
Object	tryLock(String name, long threadId, long lease, long timeout, long referenceId) Tries to acquire the lock for the specified lease time.After lease time, the lock will be released.
void	unlock(String name, long threadId, long referenceId) Releases the lock.

Method Detail

isLocked

Object isLocked(String name)

Returns whether this lock is locked or not.

Parameters:

name - Name of the Lock

Returns:

True if this lock is locked, false otherwise.

isLockedByCurrentThread

Object isLockedByCurrentThread(String name,
                               long threadId)

Returns whether this lock is locked by current thread or not.

Parameters:

name - Name of the Lock

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.

Returns:

True if this lock is locked by current thread, false otherwise.

getLockCount

Object getLockCount(String name)

Returns re-entrant lock hold count, regardless of lock ownership.

Parameters:

name - Name of the Lock

Returns:

The lock hold count.

getRemainingLeaseTime

Object getRemainingLeaseTime(String name)

Returns remaining lease time in milliseconds. If the lock is not locked then -1 will be returned

Parameters:

name - Name of the Lock

Returns:

Remaining lease time in milliseconds.

lock

void lock(String name,
          long leaseTime,
          long threadId,
          @Since(value="1.2")
          long referenceId)

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.

Parameters:

name - Name of the Lock

leaseTime - Time to wait before releasing to lock

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.

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.

unlock

void unlock(String name,
            long threadId,
            @Since(value="1.2")
            long referenceId)

Releases the lock.

Parameters:

name - Name of the Lock

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.

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.

forceUnlock

void forceUnlock(String name,
                 @Since(value="1.2")
                 long referenceId)

Releases the lock regardless of the lock owner. It always successfully unlocks, never blocks, and returns immediately.

Parameters:

name - Name of the Lock

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.

tryLock

Object tryLock(String name,
               long threadId,
               long lease,
               long timeout,
               @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.

Parameters:

name - Name of the Lock

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.

lease - time in milliseconds to wait before releasing the lock.

timeout - Maximum time to wait for the lock.

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.

Returns:

true if the lock was acquired and false if the waiting time elapsed before the lock was acquired.