io.rsocket.lease

Class LeaseImpl

java.lang.Object

io.rsocket.lease.LeaseImpl

All Implemented Interfaces:

Availability, Lease

public class LeaseImpl
extends Object
implements Lease

Method Summary

Modifier and Type	Method and Description
double	availability()
long	expiry() Absolute time since epoch at which this lease will expire.
int	getAllowedRequests() Number of requests allowed by this lease.
ByteBuf	getMetadata() Metadata for the lease.
int	getStartingAllowedRequests() Initial number of requests allowed by this lease.
int	getTimeToLiveMillis() Number of milliseconds that this lease is valid from the time it is received.
boolean	isValid() Checks if the lease has not expired and there are allowed requests available
String	toString()
boolean	use() try use 1 allowed request of Lease

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.rsocket.lease.Lease

create, getRemainingTimeToLiveMillis, isEmpty, isExpired, isExpired

Method Detail

getTimeToLiveMillis

public int getTimeToLiveMillis()

Description copied from interface: Lease

Number of milliseconds that this lease is valid from the time it is received.

Specified by:

getTimeToLiveMillis in interface Lease

Returns:

Number of milliseconds that this lease is valid from the time it is received.

getAllowedRequests

public int getAllowedRequests()

Description copied from interface: Lease

Number of requests allowed by this lease.

Specified by:

getAllowedRequests in interface Lease

Returns:

The number of requests allowed by this lease.

getStartingAllowedRequests

public int getStartingAllowedRequests()

Description copied from interface: Lease

Initial number of requests allowed by this lease.

Specified by:

getStartingAllowedRequests in interface Lease

Returns:

initial number of requests allowed by this lease.

getMetadata

@Nonnull
public ByteBuf getMetadata()

Description copied from interface: Lease

Metadata for the lease.

Specified by:

getMetadata in interface Lease

Returns:

Metadata for the lease.

expiry

public long expiry()

Description copied from interface: Lease

Absolute time since epoch at which this lease will expire.

Specified by:

expiry in interface Lease

Returns:

Absolute time since epoch at which this lease will expire.

isValid

public boolean isValid()

Description copied from interface: Lease

Checks if the lease has not expired and there are allowed requests available

Specified by:

isValid in interface Lease

use

public boolean use()

try use 1 allowed request of Lease

Returns:

true if used successfully, false if Lease is expired or no allowed requests available

availability

public double availability()

Specified by:

availability in interface Availability

Returns:

a positive numbers representing the availability of the entity. Higher is better, 0.0 means not available

toString

public String toString()

Overrides:

toString in class Object