Package org.redisson.api

Class TransactionOptions

java.lang.Object

org.redisson.api.TransactionOptions

public class TransactionOptions
extends Object

Configuration for Transaction.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
static TransactionOptions	defaults()
long	getResponseTimeout()
int	getRetryAttempts()
long	getRetryInterval()
long	getSyncTimeout()
long	getTimeout()
TransactionOptions	responseTimeout(long timeout, TimeUnit unit)	Defines timeout for Redis response.
TransactionOptions	retryAttempts(int retryAttempts)	Defines attempts amount to send transaction if it hasn't been sent already.
TransactionOptions	retryInterval(long retryInterval, TimeUnit retryIntervalUnit)	Defines time interval for each attempt to send transaction if it hasn't been sent already.
TransactionOptions	syncSlavesTimeout(long syncTimeout, TimeUnit syncUnit)	Synchronization data timeout between Redis master participating in transaction and its slaves.
TransactionOptions	timeout(long timeout, TimeUnit timeoutUnit)	If transaction hasn't been committed within timeout it will rollback automatically.

Methods inherited from class java.lang.Object

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

Method Detail

defaults

public static TransactionOptions defaults()

getResponseTimeout

public long getResponseTimeout()

responseTimeout

public TransactionOptions responseTimeout(long timeout,
                                          TimeUnit unit)

Defines timeout for Redis response. Starts to countdown when transaction has been successfully sent.

Default is 3000 milliseconds

Parameters:

timeout - value

unit - value

Returns:

self instance

getRetryAttempts

public int getRetryAttempts()

retryAttempts

public TransactionOptions retryAttempts(int retryAttempts)

Defines attempts amount to send transaction if it hasn't been sent already.

Default is 3 attempts

Parameters:

retryAttempts - value

Returns:

self instance

getRetryInterval

public long getRetryInterval()

retryInterval

public TransactionOptions retryInterval(long retryInterval,
                                        TimeUnit retryIntervalUnit)

Defines time interval for each attempt to send transaction if it hasn't been sent already.

Default is 1500 milliseconds

Parameters:

retryInterval - - time interval

retryIntervalUnit - - time interval unit

Returns:

self instance

syncSlavesTimeout

public TransactionOptions syncSlavesTimeout(long syncTimeout,
                                            TimeUnit syncUnit)

Synchronization data timeout between Redis master participating in transaction and its slaves.

Default is 5000 milliseconds

Parameters:

syncTimeout - - synchronization timeout

syncUnit - - synchronization timeout time unit

Returns:

self instance

getSyncTimeout

public long getSyncTimeout()

getTimeout

public long getTimeout()

timeout

public TransactionOptions timeout(long timeout,
                                  TimeUnit timeoutUnit)

If transaction hasn't been committed within timeout it will rollback automatically. Set -1 to disable.

Default is 5000 milliseconds

Parameters:

timeout - in milliseconds

timeoutUnit - timeout time unit

Returns:

self instance