com.sleepycat.je.utilint

Class TaskCoordinator.Permit

java.lang.Object

com.sleepycat.je.utilint.TaskCoordinator.Permit

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

TaskCoordinator

public abstract class TaskCoordinator.Permit
extends Object
implements Closeable

Permits acquired by Tasks are represented by Permit objects. Permits acquired by the application (via TaskCoordinator.setAppPermitPercent(int)) are implemented as bookkeeping adjustments and are not represented by Permit objects.

Constructor Summary

Constructors

Constructor and Description
Permit(TaskCoordinator.Task task, long leaseIntervalMs)

Method Summary

Modifier and Type	Method and Description
protected void	checkLeaseExpiry()
void	close()
abstract boolean	isDeficit()
boolean	isExpired() Returns true if the lease has expired.
boolean	isReleased()
void	releasePermit() Marks the permit as being released after verifying that it was not already released or expired.
void	setLease(long leaseInterval, TimeUnit unit) Used to Extend the lease associated with the permit, when the initial lease time cannot easily be predicted.

Methods inherited from class java.lang.Object

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

Constructor Detail

Permit

public Permit(TaskCoordinator.Task task,
              long leaseIntervalMs)

Method Detail

isReleased

public boolean isReleased()

isExpired

public boolean isExpired()

Returns true if the lease has expired.

checkLeaseExpiry

protected void checkLeaseExpiry()

setLease

public void setLease(long leaseInterval,
                     TimeUnit unit)

Used to Extend the lease associated with the permit, when the initial lease time cannot easily be predicted. It replaces the current lease time. Upon expiration of the lease, the resources associated with the permit are reclaimed upon the (possibly incorrect) assumption that the permit was leaked.

Parameters:

leaseInterval - the new lease interval

unit - the units used to express the lease interval

releasePermit

public void releasePermit()

Marks the permit as being released after verifying that it was not already released or expired.

isDeficit

public abstract boolean isDeficit()

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable