io.rsocket.core

Class Resume

java.lang.Object

io.rsocket.core.Resume

public class Resume
extends Object

Simple holder of configuration settings for the RSocket Resume capability. This can be used to configure an RSocketConnector or an RSocketServer except for retry(Retry) and token(Supplier) which apply only to the client side.

Constructor Summary

Constructors

Constructor and Description
Resume()

Method Summary

Modifier and Type	Method and Description
Resume	cleanupStoreOnKeepAlive() When this property is enabled, hints from KEEPALIVE frames about how much data has been received by the other side, is used to proactively clean frames from the store.
Resume	retry(Retry retry) Configure the logic for reconnecting.
Resume	sessionDuration(Duration sessionDuration) The maximum time for a client to keep trying to reconnect.
Resume	storeFactory(Function<? super ByteBuf,? extends ResumableFramesStore> storeFactory) Configure a factory to create the storage for buffering (or persisting) a window of frames that may need to be sent again to resume after a dropped connection.
Resume	streamTimeout(Duration streamTimeout) A timeout value to apply to the resumed session stream obtained from the store after a reconnect.
Resume	token(Supplier<ByteBuf> supplier) Customize the generation of the resume identification token used to resume.

Methods inherited from class java.lang.Object

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

Constructor Detail

Resume

public Resume()

Method Detail

sessionDuration

public Resume sessionDuration(Duration sessionDuration)

The maximum time for a client to keep trying to reconnect. During this time client and server continue to store unsent frames to keep the session warm and ready to resume.

By default this is set to 2 minutes.

Parameters:

sessionDuration - the max duration for a session

Returns:

the same instance for method chaining

cleanupStoreOnKeepAlive

public Resume cleanupStoreOnKeepAlive()

When this property is enabled, hints from KEEPALIVE frames about how much data has been received by the other side, is used to proactively clean frames from the store.

By default this is set to false in which case information from KEEPALIVE is ignored and old frames from the store are removed only when the store runs out of space.

Returns:

the same instance for method chaining

storeFactory

public Resume storeFactory(Function<? super ByteBuf,? extends ResumableFramesStore> storeFactory)

Configure a factory to create the storage for buffering (or persisting) a window of frames that may need to be sent again to resume after a dropped connection.

By default InMemoryResumableFramesStore is used with its cache size set to 100,000 bytes. When the cache fills up, the oldest frames are gradually removed to create space for new ones.

Parameters:

storeFactory - the factory to use to create the store

Returns:

the same instance for method chaining

streamTimeout

public Resume streamTimeout(Duration streamTimeout)

A timeout value to apply to the resumed session stream obtained from the store after a reconnect. The resume stream must not take longer than the specified time to emit each frame.

By default this is set to 10 seconds.

Parameters:

streamTimeout - the timeout value for resuming a session stream

Returns:

the same instance for method chaining

retry

public Resume retry(Retry retry)

Configure the logic for reconnecting. This setting is for use with RSocketConnector.resume(Resume) on the client side only.

By default this is set to:

 Retry.backoff(Long.MAX_VALUE, Duration.ofSeconds(1))
     .maxBackoff(Duration.ofSeconds(16))
     .jitter(1.0)
 

Parameters:

retry - the Retry spec to use when attempting to reconnect

Returns:

the same instance for method chaining

token

public Resume token(Supplier<ByteBuf> supplier)

Customize the generation of the resume identification token used to resume. This setting is for use with RSocketConnector.resume(Resume) on the client side only.

By default this is ResumeFrameFlyweight::generateResumeToken.

Parameters:

supplier - a custom generator for a resume identification token

Returns:

the same instance for method chaining