com.hazelcast.client.impl.protocol.template

Interface CPFencedLockCodecTemplate

@Since(value="1.8")
public interface CPFencedLockCodecTemplate

Method Summary

Modifier and Type	Method and Description
Object	getLockOwnership(RaftGroupId groupId, String name) Returns current lock ownership status of the given FencedLock instance.
Object	lock(RaftGroupId groupId, String name, long sessionId, long threadId, UUID invocationUid) Acquires the given FencedLock on the given CP group.
Object	tryLock(RaftGroupId groupId, String name, long sessionId, long threadId, UUID invocationUid, long timeoutMs) Attempts to acquire the given FencedLock on the given CP group.
Object	unlock(RaftGroupId groupId, String name, long sessionId, long threadId, UUID invocationUid) Unlocks the given FencedLock on the given CP group.

Method Detail

lock

Object lock(RaftGroupId groupId,
            String name,
            long sessionId,
            long threadId,
            UUID invocationUid)

Acquires the given FencedLock on the given CP group. If the lock is acquired, a valid fencing token (positive number) is returned. If not acquired because of max reentrant entry limit, the call returns -1. If the lock is held by some other endpoint when this method is called, the caller thread is blocked until the lock is released. If the session is closed between reentrant acquires, the call fails with LockOwnershipLostException.

Parameters:

groupId - CP group id of this FencedLock instance

name - Name of this FencedLock instance

sessionId - Session ID of the caller

threadId - ID of the caller thread

invocationUid - UID of this invocation

Returns:

a valid fencing token (positive number) if the lock is acquired, otherwise -1.

tryLock

Object tryLock(RaftGroupId groupId,
               String name,
               long sessionId,
               long threadId,
               UUID invocationUid,
               long timeoutMs)

Attempts to acquire the given FencedLock on the given CP group. If the lock is acquired, a valid fencing token (positive number) is returned. If not acquired either because of max reentrant entry limit or the lock is not free during the timeout duration, the call returns -1. If the lock is held by some other endpoint when this method is called, the caller thread is blocked until the lock is released or the timeout duration passes. If the session is closed between reentrant acquires, the call fails with LockOwnershipLostException.

Parameters:

groupId - CP group id of this FencedLock instance

name - Name of this FencedLock instance

sessionId - Session ID of the caller

threadId - ID of the caller thread

invocationUid - UID of this invocation

timeoutMs - Duration to wait for lock acquire

Returns:

a valid fencing token (positive number) if the lock is acquired, otherwise -1.

unlock

Object unlock(RaftGroupId groupId,
              String name,
              long sessionId,
              long threadId,
              UUID invocationUid)

Unlocks the given FencedLock on the given CP group. If the lock is not acquired, the call fails with IllegalMonitorStateException. If the session is closed while holding the lock, the call fails with LockOwnershipLostException. Returns true if the lock is still held by the caller after a successful unlock() call, false otherwise.

Parameters:

groupId - CP group id of this FencedLock instance

name - Name of this FencedLock instance

sessionId - Session ID of the caller

threadId - ID of the caller thread

invocationUid - UID of this invocation

Returns:

true if the lock is still held by the caller after a successful unlock() call, false otherwise.

getLockOwnership

Object getLockOwnership(RaftGroupId groupId,
                        String name)

Returns current lock ownership status of the given FencedLock instance.

Parameters:

groupId - CP group id of this FencedLock instance

name - Name of this FencedLock instance

Returns:

current ownership status of this FencedLock