io.rsocket.framing

Class LeaseFrame

java.lang.Object

io.rsocket.framing.LeaseFrame

All Implemented Interfaces:

Frame, MetadataFrame, Disposable

public final class LeaseFrame
extends Object

An RSocket LEASE frame.

See Also:

Lease Frame

Nested Class Summary

Nested classes/interfaces inherited from interface reactor.core.Disposable

Disposable.Composite, Disposable.Swap

Field Summary

Fields inherited from interface io.rsocket.framing.Frame

FRAME_TYPE_SHIFT

Method Summary

Modifier and Type	Method and Description
static LeaseFrame	createLeaseFrame(ByteBuf byteBuf) Creates the LEASE frame.
static LeaseFrame	createLeaseFrame(ByteBufAllocator byteBufAllocator, Duration timeToLive, int numberOfRequests, ByteBuf metadata) Creates the LEASE frame.
void	dispose()
boolean	equals(Object o)
FrameType	getFrameType() Returns the FrameType.
int	getNumberOfRequests() Returns the number of requests
Duration	getTimeToLive() Returns the time to live.
ByteBuf	getUnsafeFrame() Returns the frame directly.
ByteBuf	getUnsafeMetadata() Returns the metadata directly.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.rsocket.framing.MetadataFrame

getMetadataAsUtf8, getMetadataLength, getUnsafeMetadataAsUtf8, getUnsafeMetadataLength, mapMetadata

Methods inherited from interface io.rsocket.framing.Frame

consumeFrame, getFrameType, getUnsafeFrame, mapFrame

Methods inherited from interface reactor.core.Disposable

dispose, isDisposed

Method Detail

createLeaseFrame

public static LeaseFrame createLeaseFrame(ByteBuf byteBuf)

Creates the LEASE frame.

Parameters:

byteBuf - the ByteBuf representing the frame

Returns:

the LEASE frame.

Throws:

NullPointerException - if byteBuf is null

createLeaseFrame

public static LeaseFrame createLeaseFrame(ByteBufAllocator byteBufAllocator,
                                          Duration timeToLive,
                                          int numberOfRequests,
                                          @Nullable
                                          ByteBuf metadata)

Creates the LEASE frame.

Parameters:

byteBufAllocator - the ByteBufAllocator to use

timeToLive - the validity of lease from time of reception

numberOfRequests - the number of requests that may be sent until the next lease

metadata - the metadata

Returns:

the LEASE frame

Throws:

IllegalArgumentException - if timeToLive is not a positive duration

IllegalArgumentException - if numberOfRequests is not positive

NullPointerException - if byteBufAllocator or timeToLive is null

IllegalArgumentException - if timeToLive is not a positive duration or numberOfRequests is not positive

getNumberOfRequests

public int getNumberOfRequests()

Returns the number of requests

Returns:

the number of requests

getTimeToLive

public Duration getTimeToLive()

Returns the time to live.

Returns:

the time to live

getUnsafeMetadata

@Nullable
public ByteBuf getUnsafeMetadata()

Description copied from interface: MetadataFrame

Returns the metadata directly. If the Metadata flag is not set, returns null.

Note: this metadata will be outside of the Frame's lifecycle and may be released at any time. It is highly recommended that you ByteBuf.retain() the metadata if you store it.

Returns:

the metadata directly, or null if the Metadata flag is not set

See Also:

MetadataFrame.getMetadataAsUtf8(), MetadataFrame.mapMetadata(Function)

toString

public String toString()

Overrides:

toString in class Object

dispose

public final void dispose()

Specified by:

dispose in interface Disposable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getFrameType

public FrameType getFrameType()

Description copied from interface: Frame

Returns the FrameType.

Specified by:

getFrameType in interface Frame

Returns:

the FrameType

getUnsafeFrame

public final ByteBuf getUnsafeFrame()

Description copied from interface: Frame

Returns the frame directly.

Note: this frame will be outside of the Frame's lifecycle and may be released at any time. It is highly recommended that you ByteBuf.retain() the frame if you store it.

Specified by:

getUnsafeFrame in interface Frame

Returns:

the frame directly

See Also:

Frame.consumeFrame(Consumer), Frame.mapFrame(Function)

hashCode

public int hashCode()

Overrides:

hashCode in class Object