Top Description Methods
io.rsocket.resume

public Interface ResumableFramesStore

extends Closeable
Known Direct Implementers
io.rsocket.resume.InMemoryResumableFramesStore
Imports
io.netty.buffer.ByteBuf, io.rsocket.Closeable, reactor.core.publisher.Flux, .Mono
Store for resumable frames

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

Implied frame position as defined by RSocket protocol
frameImpliedPosition()

public long

Returns:

Local frame position as defined by RSocket protocol
framePosition()

public void
releaseFrames(long remoteImpliedPos)

Release frames from tail of the store up to remote implied position

public boolean

Returns:

true if information about the frame has been stored
resumableFrameReceived(ByteBuf frame)

Received resumable frame as defined by RSocket protocol.

public Flux<ByteBuf>

Returns:

Flux of frames from store tail to head. It should terminate with error if frames are not continuous
resumeStream()

public Mono<Void>

Returns:

Mono which completes once all resume frames are written
saveFrames(Flux<ByteBuf>
Flux of resumable frames
frames)

Save resumable frames for potential resumption

Inherited from io.rsocket.Closeable:
onClose

Method Detail

frameImpliedPositionback to summary
public long frameImpliedPosition()
Returns:long

Implied frame position as defined by RSocket protocol

framePositionback to summary
public long framePosition()
Returns:long

Local frame position as defined by RSocket protocol

releaseFramesback to summary
public void releaseFrames(long remoteImpliedPos)

Release frames from tail of the store up to remote implied position

resumableFrameReceivedback to summary
public boolean resumableFrameReceived(ByteBuf frame)

Received resumable frame as defined by RSocket protocol. Implementation must increment frame implied position

Returns:boolean

true if information about the frame has been stored

resumeStreamback to summary
public Flux<ByteBuf> resumeStream()
Returns:Flux<ByteBuf>

Flux of frames from store tail to head. It should terminate with error if frames are not continuous

saveFramesback to summary
public Mono<Void> saveFrames(Flux<ByteBuf> frames)

Save resumable frames for potential resumption

Parameters
frames:Flux<ByteBuf>

Flux of resumable frames

Returns:Mono<Void>

Mono which completes once all resume frames are written