net.citrusleaf
Class CitrusleafClient.ClOptions

java.lang.Object
  extended by net.citrusleaf.CitrusleafClient.ClOptions
Enclosing class:
CitrusleafClient

public static class CitrusleafClient.ClOptions
extends java.lang.Object

Container object for transaction policy attributes used in all database operation calls.

This object is passed in all database operation calls to specify options. null may be passed to use defaults for all options.


Constructor Summary
CitrusleafClient.ClOptions()
          Constructor, sets default options.
CitrusleafClient.ClOptions(int timeoutMillisec)
          Constructor, specifying timeout.
 
Method Summary
 void setOneShot()
          Specify no transaction retries.
 void setTimeout(int timeoutMillisec)
          Specify timeout.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CitrusleafClient.ClOptions

public CitrusleafClient.ClOptions()
Constructor, sets default options.

The object is constructed with timeout set to 5000 milliseconds and default transaction retry policy.


CitrusleafClient.ClOptions

public CitrusleafClient.ClOptions(int timeoutMillisec)
Constructor, specifying timeout.

The object is constructed with specified timeout and default transaction retry policy.

A timeout value of 0 means never timeout.

Parameters:
timeoutMillisec - transaction duration limit, milliseconds
Method Detail

setOneShot

public void setOneShot()
Specify no transaction retries.


setTimeout

public void setTimeout(int timeoutMillisec)
Specify timeout.

A timeout value of 0 means never timeout.

Parameters:
timeoutMillisec - transaction duration limit, milliseconds