Package org.redisson.api.options

Class CommonParams

java.lang.Object

org.redisson.api.options.CommonParams

All Implemented Interfaces:

CodecOptions<CommonOptions,Codec>, CommonOptions, InvocationOptions<CommonOptions>, ObjectParams

public final class CommonParams
extends Object
implements CommonOptions

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
CommonOptions	codec(Codec codec)	Defines codec used for data stored in Redis
Codec	getCodec()
String	getName()
int	getRetryAttempts()
DelayStrategy	getRetryDelay()
int	getTimeout()
CommonOptions	retryAttempts(int retryAttempts)	Defines command retry attempts.
CommonOptions	retryDelay(DelayStrategy interval)	Defines the delay strategy for a new attempt to send a command.
CommonOptions	retryInterval(Duration interval)	Use InvocationOptions.retryDelay(DelayStrategy) instead.
CommonOptions	timeout(Duration timeout)	Defines Redis server response timeout.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.redisson.api.options.InvocationOptions

retryAttempts, retryDelay, retryInterval, timeout

Method Details

getName

public String getName()

codec

public CommonOptions codec(Codec codec)

Description copied from interface: CodecOptions

Defines codec used for data stored in Redis

Specified by:

codec in interface CodecOptions<T extends InvocationOptions<T>,C>

Parameters:

codec - applied to object instance

Returns:

options object

timeout

public CommonOptions timeout(Duration timeout)

Description copied from interface: InvocationOptions

Defines Redis server response timeout. Starts to countdown when a Redis command was successfully sent.

Default is the value specified for the same parameter in Redisson configuration

Specified by:

timeout in interface InvocationOptions<T extends InvocationOptions<T>>

Parameters:

timeout - Redis server response timeout

Returns:

options instance

retryAttempts

public CommonOptions retryAttempts(int retryAttempts)

Description copied from interface: InvocationOptions

Defines command retry attempts. Error is thrown if the Redis command can't be sent to Redis server after retryAttempts. But if it sent successfully then responseTimeout is started.

Default is the value specified for the same parameter in Redisson configuration

Specified by:

retryAttempts in interface InvocationOptions<T extends InvocationOptions<T>>

Parameters:

retryAttempts - command retry attempts

Returns:

options instance

retryInterval

public CommonOptions retryInterval(Duration interval)

Description copied from interface: InvocationOptions

Use InvocationOptions.retryDelay(DelayStrategy) instead.

Specified by:

retryInterval in interface InvocationOptions<T extends InvocationOptions<T>>

Parameters:

interval - retry time interval

Returns:

options instance

retryDelay

public CommonOptions retryDelay(DelayStrategy interval)

Description copied from interface: InvocationOptions

Defines the delay strategy for a new attempt to send a command.

Specified by:

retryDelay in interface InvocationOptions<T extends InvocationOptions<T>>

Parameters:

interval - delay strategy implementation

Returns:

options instance

getTimeout

public int getTimeout()

Specified by:

getTimeout in interface ObjectParams

getRetryAttempts

public int getRetryAttempts()

Specified by:

getRetryAttempts in interface ObjectParams

getCodec

public Codec getCodec()

getRetryDelay

public DelayStrategy getRetryDelay()

Specified by:

getRetryDelay in interface ObjectParams