Lease (rsocket-core 1.0.0-RC7 API)

All Superinterfaces:

Availability

All Known Implementing Classes:

LeaseImpl
```
public interface Lease
extends Availability
```
A contract for RSocket lease, which is sent by a request acceptor and is time bound.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Lease`	`create(int timeToLiveMillis, int numberOfRequests)`
`static Lease`	`create(int timeToLiveMillis, int numberOfRequests, ByteBuf metadata)`
`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.
`default int`	`getRemainingTimeToLiveMillis(long now)` Number of milliseconds that this lease is still valid from now.
`default 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.
`default boolean`	`isEmpty()` Checks if the lease is empty(default value if no lease was received yet)
`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`.
`default boolean`	`isValid()` Checks if the lease has not expired and there are allowed requests available

Methods inherited from interface io.rsocket.Availability
availability

- Method Detail
  - create
```
static Lease create(int timeToLiveMillis,
                    int numberOfRequests,
                    @Nullable
                    ByteBuf metadata)
```
  - create
```
static Lease create(int timeToLiveMillis,
                    int numberOfRequests)
```
  - getAllowedRequests
```
int getAllowedRequests()
```
    Number of requests allowed by this lease.
    
    Returns:
    
    The number of requests allowed by this lease.
  - getStartingAllowedRequests
```
default int getStartingAllowedRequests()
```
    Initial number of requests allowed by this lease.
    
    Returns:
    
    initial number of requests allowed by this lease.
  - getTimeToLiveMillis
```
int getTimeToLiveMillis()
```
    Number of milliseconds that this lease is valid from the time it is received.
    
    Returns:
    
    Number of milliseconds that this lease is valid from the time it is received.
  - getRemainingTimeToLiveMillis
```
default int getRemainingTimeToLiveMillis(long now)
```
    Number of milliseconds that this lease is still valid from now.
    
    Parameters:
    
    now - millis since epoch
    
    Returns:
    
    Number of milliseconds that this lease is still valid from now, or 0 if expired.
  - 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
```
@Nonnull
ByteBuf 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.
  - isValid
```
default boolean isValid()
```
    Checks if the lease has not expired and there are allowed requests available
  - isEmpty
```
default boolean isEmpty()
```
    Checks if the lease is empty(default value if no lease was received yet)

Interface Lease

Method Summary

Methods inherited from interface io.rsocket.Availability

Method Detail

create

create

getAllowedRequests

getStartingAllowedRequests

getTimeToLiveMillis

getRemainingTimeToLiveMillis

expiry

getMetadata

isExpired

isExpired

isValid

isEmpty