com.sequoiadb.base

Class ConfigOptions

java.lang.Object

com.sequoiadb.base.ConfigOptions

All Implemented Interfaces:

Cloneable

public class ConfigOptions
extends Object
implements Cloneable

Database Connection Configuration Option

Constructor Summary

Constructors

Constructor and Description
ConfigOptions()

Method Summary

Modifier and Type	Method and Description
Object	clone() Clone the current options.
int	getConnectTimeout() The connection timeout in milliseconds.
long	getMaxAutoConnectRetryTime() Get the max auto connect retry time in milliseconds.
boolean	getSocketKeepAlive() Get whether the socket keeps alive or not
int	getSocketTimeout() Get the socket timeout in milliseconds.
boolean	getUseNagle() Get whether use the Nagle Algorithm or not
boolean	getUseSSL() Get whether use the SSL or not
void	setConnectTimeout(int connectTimeoutMillis) Set the connection timeout in milliseconds.
void	setMaxAutoConnectRetryTime(long maxRetryTimeMillis) Set the max auto connect retry time in milliseconds.
void	setSocketKeepAlive(boolean on) This flag controls the socket keep alive feature that keeps a connection alive through firewalls Socket.setKeepAlive(boolean)
void	setSocketTimeout(int socketTimeoutMillis) Set the socket timeout in milliseconds.
void	setUseNagle(boolean on) Set whether enable/disable Nagle's algorithm(disable/enable TCP_NODELAY)
void	setUseSSL(boolean on) Set whether use the SSL or not
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigOptions

public ConfigOptions()

Method Detail

clone

public Object clone()
             throws CloneNotSupportedException

Clone the current options.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

Since:

3.4.3

getConnectTimeout

public int getConnectTimeout()

The connection timeout in milliseconds. A timeout of zero is interpreted as an infinite timeout. It is used solely when establishing a new connection Socket.connect(java.net.SocketAddress, int)

Default is 10,000ms.

Returns:

the socket connect timeout

getMaxAutoConnectRetryTime

public long getMaxAutoConnectRetryTime()

Get the max auto connect retry time in milliseconds.

Returns:

the max auto connect retry time in milliseconds.

getSocketKeepAlive

public boolean getSocketKeepAlive()

Get whether the socket keeps alive or not

Returns:

the status of setting

getSocketTimeout

public int getSocketTimeout()

Get the socket timeout in milliseconds. It is used for I/O socket read operations Socket.setSoTimeout(int)

Default is 0ms and means no timeout.

Returns:

the socket timeout

getUseNagle

public boolean getUseNagle()

Get whether use the Nagle Algorithm or not

Returns:

the status of setting

getUseSSL

public boolean getUseSSL()

Get whether use the SSL or not

Returns:

the status of setting

setConnectTimeout

public void setConnectTimeout(int connectTimeoutMillis)

Set the connection timeout in milliseconds. A value of 0 means no timeout. It is used solely when establishing a new connection Socket.connect(java.net.SocketAddress, int)

Parameters:

connectTimeoutMillis - The connection timeout in milliseconds. Default is 10,000ms.

setMaxAutoConnectRetryTime

public void setMaxAutoConnectRetryTime(long maxRetryTimeMillis)

Set the max auto connect retry time in milliseconds. Default to be 15,000ms. when "connectTimeout" is set to 10,000ms(default value), the max number of retries is ceiling("maxAutoConnectRetryTime" / "connectTimeout"), which is 2.

Parameters:

maxRetryTimeMillis - the max auto connect retry time in milliseconds

setSocketKeepAlive

public void setSocketKeepAlive(boolean on)

This flag controls the socket keep alive feature that keeps a connection alive through firewalls Socket.setKeepAlive(boolean)

Parameters:

on - whether keep-alive is enabled on each socket. Default is true.

setSocketTimeout

public void setSocketTimeout(int socketTimeoutMillis)

Set the socket timeout in milliseconds. It is used for I/O socket read operations Socket.setSoTimeout(int)

Parameters:

socketTimeoutMillis - The socket timeout in milliseconds. Default is 0ms and means no timeout.

setUseNagle

public void setUseNagle(boolean on)

Set whether enable/disable Nagle's algorithm(disable/enable TCP_NODELAY)

Parameters:

on - false to enable TCP_NODELAY, default to be false and going to use enable TCP_NODELAY.

setUseSSL

public void setUseSSL(boolean on)

Set whether use the SSL or not

Parameters:

on - Default to be false.

toString

public String toString()

Overrides:

toString in class Object