io.rsocket.lease

Interface Lease

All Known Implementing Classes:

LeaseImpl

public interface Lease

A contract for RSocket lease, which is sent by a request acceptor and is time bound.

Method Summary

Modifier and Type	Method and Description
long	expiry() Absolute time since epoch at which this lease will expire.
int	getAllowedRequests() Number of requests allowed by this lease.
ByteBuffer	getMetadata() Metadata for the lease.
int	getTtl() Number of seconds that this lease is valid from the time it is received.
default boolean	isExpired() Checks if the lease is expired now.
default boolean	isExpired(long now) Checks if the lease is expired for the passed now.

Method Detail

getAllowedRequests

int getAllowedRequests()

Number of requests allowed by this lease.

Returns:

The number of requests allowed by this lease.

getTtl

int getTtl()

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

Returns:

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

expiry

long expiry()

Absolute time since epoch at which this lease will expire.

Returns:

Absolute time since epoch at which this lease will expire.

getMetadata

@Nullable
ByteBuffer getMetadata()

Metadata for the lease.

Returns:

Metadata for the lease.

isExpired

default boolean isExpired()

Checks if the lease is expired now.

Returns:

true if the lease has expired.

isExpired

default boolean isExpired(long now)

Checks if the lease is expired for the passed now.

Parameters:

now - current time in millis.

Returns:

true if the lease has expired.