com.hazelcast.client.impl.protocol.template

Interface SemaphoreCodecTemplate

public interface SemaphoreCodecTemplate

Method Summary

Methods

Modifier and Type	Method and Description
void	acquire(String name, int permits) Acquires the given number of permits if they are available, and returns immediately, reducing the number of available permits by the given amount.
Object	availablePermits(String name) Returns the current number of permits currently available in this semaphore.
Object	drainPermits(String name) Acquires and returns all permits that are immediately available.
Object	init(String name, int permits) Try to initialize this ISemaphore instance with the given permit count
void	reducePermits(String name, int reduction) Shrinks the number of available permits by the indicated reduction.
void	release(String name, int permits) Releases the given number of permits, increasing the number of available permits by that amount.
Object	tryAcquire(String name, int permits, long timeout) Acquires the given number of permits, if they are available, and returns immediately, with the value true, reducing the number of available permits by the given amount.

Method Detail

init

Object init(String name,
          int permits)

Try to initialize this ISemaphore instance with the given permit count

Parameters:

name - Name of the Semaphore

permits - The given permit count

Returns:

True if initialization succeeds, false otherwise.

acquire

void acquire(String name,
           int permits)

Acquires the given number of permits if they are available, and returns immediately, reducing the number of available permits by the given amount. If insufficient permits are available then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of three things happens: some other thread invokes one of the methods for this semaphore, the current thread is next to be assigned permits and the number of available permits satisfies this request, this ISemaphore instance is destroyed, or some other thread the current thread. If the current thread has its interrupted status set on entry to this method, or is while waiting for a permit, then is thrown and the current thread's interrupted status is cleared.

Parameters:

name - Name of the Semaphore

permits - The given permit count

availablePermits

Object availablePermits(String name)

Returns the current number of permits currently available in this semaphore. This method is typically used for debugging and testing purposes.

Parameters:

name - Name of the Semaphore

Returns:

The number of permits available in this semaphore.

drainPermits

Object drainPermits(String name)

Acquires and returns all permits that are immediately available.

Parameters:

name - Name of the Semaphore

Returns:

The number of permits drained

reducePermits

void reducePermits(String name,
                 int reduction)

Shrinks the number of available permits by the indicated reduction. This method differs from acquire in that it does not block waiting for permits to become available.

Parameters:

name - Name of the Semaphore

reduction - The number of permits to remove

release

void release(String name,
           int permits)

Releases the given number of permits, increasing the number of available permits by that amount. There is no requirement that a thread that releases a permit must have acquired that permit by calling one of the acquire()acquire methods. Correct usage of a semaphore is established by programming convention in the application.

Parameters:

name - Name of the Semaphore

permits - The number of permits to remove

tryAcquire

Object tryAcquire(String name,
                int permits,
                long timeout)

Acquires the given number of permits, if they are available, and returns immediately, with the value true, reducing the number of available permits by the given amount. If insufficient permits are available then this method will return immediately with the value false and the number of available permits is unchanged.

Parameters:

name - Name of the Semaphore

permits - The number of permits to remove

timeout - The maximum time to wait for a permit

Returns:

true if all permits were acquired, false if the waiting time elapsed before all permits could be acquired