com.hazelcast.client.impl.protocol.template

Interface CPSemaphoreCodecTemplate

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

Method Summary

Modifier and Type	Method and Description
Object	acquire(RaftGroupId groupId, String name, long sessionId, long threadId, UUID invocationUid, int permits, long timeoutMs) Acquires the requested amount of permits if available, reducing the number of available permits.
Object	availablePermits(RaftGroupId groupId, String name) Returns the number of available permits.
Object	change(RaftGroupId groupId, String name, long sessionId, long threadId, UUID invocationUid, int permits) Increases or decreases the number of permits by the given value.
Object	drain(RaftGroupId groupId, String name, long sessionId, long threadId, UUID invocationUid) Acquires all available permits at once and returns immediately.
Object	getSemaphoreType(String proxyName) Returns true if the semaphore is JDK compatible
Object	init(RaftGroupId groupId, String name, int permits) Initializes the ISemaphore instance with the given permit number, if not initialized before.
Object	release(RaftGroupId groupId, String name, long sessionId, long threadId, UUID invocationUid, int permits) Releases the given number of permits and increases the number of available permits by that amount.

Method Detail

init

Object init(RaftGroupId groupId,
            String name,
            int permits)

Initializes the ISemaphore instance with the given permit number, if not initialized before.

Parameters:

groupId - CP group id of this ISemaphore instance

name - Name of this ISemaphore instance

permits - Number of permits to initialize this ISemaphore

Returns:

true if the ISemaphore is initialized with this call

acquire

Object acquire(RaftGroupId groupId,
               String name,
               long sessionId,
               long threadId,
               UUID invocationUid,
               int permits,
               long timeoutMs)

Acquires the requested amount of permits if available, reducing the number of available permits. If no enough permits are available, then the current thread becomes disabled for thread scheduling purposes and lies dormant until other threads release enough permits.

Parameters:

groupId - CP group id of this ISemaphore instance

name - Name of this ISemaphore instance

sessionId - Session ID of the caller

threadId - ID of the caller thread

invocationUid - UID of this invocation

permits - number of permits to acquire

timeoutMs - Duration to wait for permit acquire

Returns:

true if requested permits are acquired, false otherwise

release

Object release(RaftGroupId groupId,
               String name,
               long sessionId,
               long threadId,
               UUID invocationUid,
               int permits)

Releases the given number of permits and increases the number of available permits by that amount.

Parameters:

groupId - CP group id of this ISemaphore instance

name - Name of this ISemaphore instance

sessionId - Session ID of the caller

threadId - ID of the caller thread

invocationUid - UID of this invocation

permits - number of permits to release

Returns:

true

drain

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

Acquires all available permits at once and returns immediately.

Parameters:

groupId - CP group id of this ISemaphore instance

name - Name of this ISemaphore instance

sessionId - Session ID of the caller

threadId - ID of the caller thread

invocationUid - UID of this invocation

Returns:

number of acquired permits

change

Object change(RaftGroupId groupId,
              String name,
              long sessionId,
              long threadId,
              UUID invocationUid,
              int permits)

Increases or decreases the number of permits by the given value.

Parameters:

groupId - CP group id of this ISemaphore instance

name - Name of this ISemaphore instance

sessionId - Session ID of the caller

threadId - ID of the caller thread

invocationUid - UID of this invocation

permits - number of permits to increase / decrease

Returns:

true

availablePermits

Object availablePermits(RaftGroupId groupId,
                        String name)

Returns the number of available permits.

Parameters:

groupId - CP group id of this ISemaphore instance

name - Name of this ISemaphore instance

Returns:

number of available permits

getSemaphoreType

Object getSemaphoreType(String proxyName)

Returns true if the semaphore is JDK compatible

Parameters:

proxyName - Name of the ISemaphore proxy

Returns:

true if the semaphore is JDK compatible