io.rsocket.lease

Class Lease

java.lang.Object

io.rsocket.lease.Lease

public final class Lease
extends Object

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

Method Summary

Modifier and Type	Method and Description
static Lease	create(Duration timeToLive, int numberOfRequests)
static Lease	create(Duration timeToLive, int numberOfRequests, ByteBuf metadata)
static Lease	empty()
long	expirationTime() Absolute time since epoch at which this lease will expire.
ByteBuf	metadata() Metadata for the lease.
int	numberOfRequests() Number of requests allowed by this lease.
int	timeToLiveInMillis() Time to live for the given lease
String	toString()
static Lease	unbounded()
static Lease	unbounded(ByteBuf metadata)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Lease create(Duration timeToLive,
                           int numberOfRequests,
                           @Nullable
                           ByteBuf metadata)

create

public static Lease create(Duration timeToLive,
                           int numberOfRequests)

unbounded

public static Lease unbounded()

unbounded

public static Lease unbounded(@Nullable
                              ByteBuf metadata)

empty

public static Lease empty()

numberOfRequests

public int numberOfRequests()

Number of requests allowed by this lease.

Returns:

The number of requests allowed by this lease.

timeToLiveInMillis

public int timeToLiveInMillis()

Time to live for the given lease

Returns:

relative duration in milliseconds

expirationTime

public long expirationTime()

Absolute time since epoch at which this lease will expire.

Returns:

Absolute time since epoch at which this lease will expire.

metadata

@Nullable
public ByteBuf metadata()

Metadata for the lease.

Returns:

Metadata for the lease.

toString

public String toString()

Overrides:

toString in class Object