public interface IgniteSemaphore extends Closeable
java.util.concurrent.Semaphore
.
Ignite.semaphore(String, int, boolean, boolean)
.Modifier and Type | Method and Description |
---|---|
void |
acquire()
Acquires a permit from this semaphore, blocking until one is available, or the thread is interrupted.
|
void |
acquire(int permits)
Acquires the given number of permits from this semaphore, blocking until all are available, or the thread is
interrupted.
|
void |
acquireUninterruptibly()
Acquires a permit from this semaphore, blocking until one is available.
|
void |
acquireUninterruptibly(int permits)
Acquires the given number of permits from this semaphore, blocking until all are available.
|
int |
availablePermits()
Returns the current number of permits available in this semaphore.
|
void |
close()
Removes this semaphore.
|
int |
drainPermits()
Acquires and returns all permits that are immediately available.
|
int |
getQueueLength()
Returns an estimate of the number of nodes waiting to acquire.
|
boolean |
hasQueuedThreads()
Queries whether any threads are waiting to acquire.
|
boolean |
isBroken()
Gets
broken status of the semaphore. |
boolean |
isFailoverSafe()
Returns
true if this semaphore is safe to use after node failure. |
String |
name()
Gets name of the semaphore.
|
void |
release()
Releases a permit, returning it to the semaphore.
|
void |
release(int permits)
Releases the given number of permits, returning them to the semaphore.
|
boolean |
removed()
Gets
removed status of the semaphore. |
boolean |
tryAcquire()
Acquires a permit from this semaphore, only if one is available at the time of invocation.
|
boolean |
tryAcquire(int permits)
Acquires the given number of permits from this semaphore, only if all are available at the time of invocation.
|
boolean |
tryAcquire(int permits,
long timeout,
TimeUnit unit)
Acquires the given number of permits from this semaphore, if all become available within the given waiting time
and the current thread has not been interrupted.
|
boolean |
tryAcquire(long timeout,
TimeUnit unit)
Acquires a permit from this semaphore, if one becomes available within the given waiting time and the current
thread has not been interrupted.
|
String name()
void acquire() throws IgniteInterruptedException
Acquires a permit, if one is available and returns immediately, reducing the number of available permits by one.
If no permit is available then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of two things happens:
release()
method for this
semaphore and the current thread is next to be assigned a permit; or If the current thread:
IgniteInterruptedException
is thrown
and the current thread's interrupted status is cleared.IgniteInterruptedException
- if the current thread is interruptedvoid acquireUninterruptibly()
Acquires a permit, if one is available and returns immediately, reducing the number of available permits by one.
If no permit is available then the current thread becomes disabled for thread scheduling purposes and lies
dormant until some other thread invokes the release()
method for this semaphore and the current thread is
next to be assigned a permit.
If the current thread is interrupted while waiting for a permit then it will continue to wait, but the time at which the thread is assigned a permit may change compared to the time it would have received the permit had no interruption occurred. When the thread does return from this method its interrupt status will be set.
boolean tryAcquire()
Acquires a permit, if one is available and returns immediately, with the value true
, reducing the
number of available permits by one.
If no permit is available then this method will return immediately with the value false
.
true
if a permit was acquired and false
otherwiseboolean tryAcquire(long timeout, TimeUnit unit) throws IgniteInterruptedException
Acquires a permit, if one is available and returns immediately, with the value true
, reducing the
number of available permits by one.
If no permit is available then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of three things happens:
release()
method for
this semaphore and the current thread is next to be assigned a permit; or If a permit is acquired then the value true
is returned.
If the current thread:
IgniteInterruptedException
is
thrown and the current thread's interrupted status is cleared.
If the specified waiting time elapses then the value false
is returned. If the time is less than or
equal to zero, the method will not wait at all.
timeout
- the maximum time to wait for a permitunit
- the time unit of the timeout
argumenttrue
if a permit was acquired and false
if the waiting time elapsed before a permit was
acquiredIgniteInterruptedException
- if the current thread is interruptedvoid acquireUninterruptibly(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 some other thread invokes one of the release
methods for this
semaphore, the current thread is next to be assigned permits and the number of available permits satisfies this
request.
If the current thread is interrupted while waiting for permits then it will continue to wait and its position in the queue is not affected. When the thread does return from this method its interrupt status will be set.
permits
- the number of permits to acquireIllegalArgumentException
- if permits
is negativeint availablePermits()
This method is typically used for debugging and testing purposes.
int drainPermits()
void release()
Releases a permit, increasing the number of available permits by one. If any threads are trying to acquire a permit, then one is selected and given the permit that was just released. That thread is (re)enabled for thread scheduling purposes.
There is no requirement that a thread that releases a permit must have acquired that permit by calling acquire()
. Correct usage of a semaphore is established by programming convention in the application.
boolean tryAcquire(int permits, long timeout, TimeUnit unit) throws IgniteInterruptedException
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 the current thread becomes disabled for thread scheduling purposes and lies dormant until one of three things happens:
release
methods for this semaphore, the current thread is next to be assigned permits and the number
of available permits satisfies this request; or If the permits are acquired then the value true
is returned.
If the current thread:
IgniteInterruptedException
is thrown and the current thread's interrupted status is cleared. Any permits that were to be assigned to this
thread, are instead assigned to other threads trying to acquire permits, as if the permits had been made
available by a call to release()
.
If the specified waiting time elapses then the value false
is returned. If the time is less than or
equal to zero, the method will not wait at all. Any permits that were to be assigned to this thread, are instead
assigned to other threads trying to acquire permits, as if the permits had been made available by a call to
release()
.
permits
- the number of permits to acquiretimeout
- the maximum time to wait for the permitsunit
- the time unit of the timeout
argumenttrue
if all permits were acquired and false
if the waiting time elapsed before all
permits were acquiredIgniteInterruptedException
- if the current thread is interruptedIllegalArgumentException
- if permits
is negativeboolean tryAcquire(int permits)
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.
If you want to honor the failoverSafe setting, then use tryAcquire(permits, 0, TimeUnit.SECONDS)
which is almost equivalent (it also detects interruption).
permits
- the number of permits to acquiretrue
if the permits were acquired and false
otherwiseIllegalArgumentException
- if permits
is negativevoid acquire(int permits) throws IgniteInterruptedException
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 two things happens:
release
methods for this semaphore, the current thread is next to be assigned permits and the number of
available permits satisfies this request; or If the current thread:
IgniteInterruptedException
is thrown
and the current thread's interrupted status is cleared. Any permits that were to be assigned to this thread are
instead assigned to other threads trying to acquire permits, as if permits had been made available by a call to
release()
.permits
- the number of permits to acquireIgniteInterruptedException
- if the current thread is interruptedIllegalArgumentException
- if permits
is negativevoid release(int permits)
Releases the given number of permits, increasing the number of available permits by that amount. If any threads are trying to acquire permits, then one is selected and given the permits that were just released. If the number of available permits satisfies that thread's request then that thread is (re)enabled for thread scheduling purposes; otherwise the thread will wait until sufficient permits are available. If there are still permits available after this thread's request has been satisfied, then those permits are assigned in turn to other threads trying to acquire permits.
There is no requirement that a thread that releases a permit must have acquired that permit by calling acquire
. Correct usage of a semaphore is established by programming convention in the
application.
permits
- the number of permits to releaseIllegalArgumentException
- if permits
is negativeboolean isFailoverSafe()
true
if this semaphore is safe to use after node failure.
If not, IgniteInterruptedException is thrown on every other node after node failure.true
if this semaphore has failoverSafe set trueboolean hasQueuedThreads()
true
return does not guarantee that any other thread will ever acquire. This method is designed
primarily for use in monitoring of the system state.true
if there may be other threads waiting to acquire the lockint getQueueLength()
boolean isBroken()
broken
status of the semaphore.True
if a node failed on this semaphore and failoverSafe flag was set to false, false
otherwise.boolean removed()
removed
status of the semaphore.True
if semaphore was removed from cache, false
otherwise.void close()
close
in interface AutoCloseable
close
in interface Closeable
IgniteException
- If operation failed.
GridGain In-Memory Computing Platform : ver. 8.9.14 Release Date : November 5 2024