io.jarasandha.util.concurrent

Class GuardedSession<I>

java.lang.Object

io.jarasandha.util.concurrent.GuardedSession<I>

@ThreadSafe
public final class GuardedSession<I>
extends Object

A utility to wrap a contented object (I) within predefined usage permits.

See access(long, TimeUnit, Consumer).

Created by ashwin.jayaprakash.

Constructor Summary

Constructors

Constructor and Description
GuardedSession(I item)
GuardedSession(int concurrentPermits, I item)

Method Summary

Modifier and Type	Method and Description
boolean	access(Consumer<? super I> consumer)
boolean	access(long waitDuration, TimeUnit waitDurationUnits, Consumer<? super I> consumer)
I	discard() Waits for all borrowers to safely return their items.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GuardedSession

public GuardedSession(I item)

Parameters:

item -

See Also:

Concurrency permit of 1.

GuardedSession

public GuardedSession(int concurrentPermits,
                      I item)

Parameters:

concurrentPermits -

item - Cannot be null.

Method Detail

access

public boolean access(Consumer<? super I> consumer)
               throws InterruptedException

Parameters:

consumer -

Returns:

If the item could be borrowed and then provided to the consumer.

Throws:

InterruptedException

See Also:

access(long, TimeUnit, Consumer)

access

public boolean access(long waitDuration,
                      TimeUnit waitDurationUnits,
                      Consumer<? super I> consumer)
               throws InterruptedException

Parameters:

waitDuration -

waitDurationUnits -

consumer -

Returns:

If the item could be borrowed and then provided to the consumer.

Throws:

InterruptedException - If the item could not be borrowed because:

- Session has already been discarded

- Or, the permit could not acquired within the given duration.

discard

public I discard()
          throws InterruptedException

Waits for all borrowers to safely return their items.

Returns:

The item after this session has been safely stopped. After this method returns successfully, this session cannot be used.

Null if the session has already been discarded.

Throws:

InterruptedException