Class IOReactorConfig.Builder

java.lang.Object

org.apache.hc.core5.reactor.IOReactorConfig.Builder

Enclosing class:

IOReactorConfig

public static class IOReactorConfig.Builder
extends Object

Since:

4.2

Field Summary

Fields

Modifier and Type	Field	Description
private int	backlogSize
private static int	defaultMaxIOThreadCount
private int	ioThreadCount
private int	rcvBufSize
private TimeValue	selectInterval
private int	sndBufSize
private SocketAddress	socksProxyAddress
private String	socksProxyPassword
private String	socksProxyUsername
private boolean	soKeepAlive
private TimeValue	soLinger
private boolean	soReuseAddress
private Timeout	soTimeout
private int	tcpKeepCount
private int	tcpKeepIdle
private int	tcpKeepInterval
private boolean	tcpNoDelay
private int	trafficClass

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IOReactorConfig	build()
static int	getDefaultMaxIOThreadCount()	Gets the default value for ioThreadCount.
IOReactorConfig.Builder	setBacklogSize(int backlogSize)	Sets the default backlog size value for server sockets binds.
static void	setDefaultMaxIOThreadCount(int defaultMaxIOThreadCount)	Sets the default value for ioThreadCount.
IOReactorConfig.Builder	setIoThreadCount(int ioThreadCount)	Sets the number of I/O dispatch threads to be used by the I/O reactor.
IOReactorConfig.Builder	setRcvBufSize(int rcvBufSize)	Sets the default value of the SocketOptions.SO_RCVBUF parameter for newly created sockets.
IOReactorConfig.Builder	setSelectInterval(TimeValue selectInterval)	Sets time interval at which the I/O reactor wakes up to check for timed out sessions and session requests.
IOReactorConfig.Builder	setSndBufSize(int sndBufSize)	Sets the default value of the SocketOptions.SO_SNDBUF parameter for newly created sockets.
IOReactorConfig.Builder	setSocksProxyAddress(SocketAddress socksProxyAddress)	Sets the address of the SOCKS proxy to use.
IOReactorConfig.Builder	setSocksProxyPassword(String socksProxyPassword)	Sets the password to provide to the SOCKS proxy for username/password authentication.
IOReactorConfig.Builder	setSocksProxyUsername(String socksProxyUsername)	Sets the username to provide to the SOCKS proxy for username/password authentication.
IOReactorConfig.Builder	setSoKeepAlive(boolean soKeepAlive)	Sets the default value of the SocketOptions.SO_KEEPALIVE parameter for newly created sockets.
IOReactorConfig.Builder	setSoLinger(int soLinger, TimeUnit timeUnit)	Sets the default value of the SocketOptions.SO_LINGER parameter for newly created sockets.
IOReactorConfig.Builder	setSoLinger(TimeValue soLinger)	Sets the default value of the SocketOptions.SO_LINGER parameter for newly created sockets.
IOReactorConfig.Builder	setSoReuseAddress(boolean soReuseAddress)	Sets the default value of the SocketOptions.SO_REUSEADDR parameter for newly created sockets.
IOReactorConfig.Builder	setSoTimeout(int soTimeout, TimeUnit timeUnit)	Sets the default socket timeout value for non-blocking I/O operations.
IOReactorConfig.Builder	setSoTimeout(Timeout soTimeout)	Sets the default socket timeout value for non-blocking I/O operations.
IOReactorConfig.Builder	setTcpKeepCount(int tcpKeepCount)	Sets the maximum number of keepalive probes TCP should send before dropping the connection.
IOReactorConfig.Builder	setTcpKeepIdle(int tcpKeepIdle)	Sets the time (in seconds) the connection needs to remain idle before TCP starts sending keepalive probes.
IOReactorConfig.Builder	setTcpKeepInterval(int tcpKeepInterval)	Sets the time (in seconds) between individual keepalive probes.
IOReactorConfig.Builder	setTcpNoDelay(boolean tcpNoDelay)	Sets the default value of the SocketOptions.TCP_NODELAY parameter for newly created sockets.
IOReactorConfig.Builder	setTrafficClass(int trafficClass)	Sets the default value of the SocketOptions.IP_TOS parameter for newly created sockets.

Methods inherited from class Object

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

Field Details

defaultMaxIOThreadCount

private static int defaultMaxIOThreadCount

selectInterval

private TimeValue selectInterval

ioThreadCount

private int ioThreadCount

soTimeout

private Timeout soTimeout

soReuseAddress

private boolean soReuseAddress

soLinger

private TimeValue soLinger

soKeepAlive

private boolean soKeepAlive

tcpNoDelay

private boolean tcpNoDelay

trafficClass

private int trafficClass

sndBufSize

private int sndBufSize

rcvBufSize

private int rcvBufSize

backlogSize

private int backlogSize

tcpKeepIdle

private int tcpKeepIdle

tcpKeepInterval

private int tcpKeepInterval

tcpKeepCount

private int tcpKeepCount

socksProxyAddress

private SocketAddress socksProxyAddress

socksProxyUsername

private String socksProxyUsername

socksProxyPassword

private String socksProxyPassword

Constructor Details

Builder

Builder()

Method Details

getDefaultMaxIOThreadCount

public static int getDefaultMaxIOThreadCount()

Gets the default value for ioThreadCount. Returns Runtime.availableProcessors() if setDefaultMaxIOThreadCount(int) was called with a value less <= 0.

Returns:

the default value for ioThreadCount.

Since:

4.4.10

setDefaultMaxIOThreadCount

public static void setDefaultMaxIOThreadCount(int defaultMaxIOThreadCount)

Sets the default value for ioThreadCount. Use a value <= 0 to cause getDefaultMaxIOThreadCount() to return Runtime.availableProcessors().

Parameters:

defaultMaxIOThreadCount - the default value for ioThreadCount.

Since:

4.4.10

setSelectInterval

public IOReactorConfig.Builder setSelectInterval(TimeValue selectInterval)

Sets time interval at which the I/O reactor wakes up to check for timed out sessions and session requests.

Default: 1000 milliseconds.

Returns:

this instance.

setIoThreadCount

public IOReactorConfig.Builder setIoThreadCount(int ioThreadCount)

Sets the number of I/O dispatch threads to be used by the I/O reactor.

Default: 2

Returns:

this instance.

setSoTimeout

public IOReactorConfig.Builder setSoTimeout(int soTimeout,
 TimeUnit timeUnit)

Sets the default socket timeout value for non-blocking I/O operations.

Default: 0 (no timeout)

Returns:

this instance.

See Also:

• SocketOptions.SO_TIMEOUT

setSoTimeout

public IOReactorConfig.Builder setSoTimeout(Timeout soTimeout)

Sets the default socket timeout value for non-blocking I/O operations.

Default: 0 (no timeout)

Returns:

this instance.

See Also:

• SocketOptions.SO_TIMEOUT

setSoReuseAddress

public IOReactorConfig.Builder setSoReuseAddress(boolean soReuseAddress)

Sets the default value of the SocketOptions.SO_REUSEADDR parameter for newly created sockets.

Default: false

Returns:

this instance.

See Also:

• SocketOptions.SO_REUSEADDR

setSoLinger

public IOReactorConfig.Builder setSoLinger(int soLinger,
 TimeUnit timeUnit)

Sets the default value of the SocketOptions.SO_LINGER parameter for newly created sockets.

Default: -1

Returns:

this instance.

See Also:

• SocketOptions.SO_LINGER

setSoLinger

public IOReactorConfig.Builder setSoLinger(TimeValue soLinger)

Sets the default value of the SocketOptions.SO_LINGER parameter for newly created sockets.

Default: -1

Returns:

this instance.

See Also:

• SocketOptions.SO_LINGER

setSoKeepAlive

public IOReactorConfig.Builder setSoKeepAlive(boolean soKeepAlive)

Sets the default value of the SocketOptions.SO_KEEPALIVE parameter for newly created sockets.

Default: true

Returns:

this instance.

See Also:

• SocketOptions.SO_KEEPALIVE

setTcpNoDelay

public IOReactorConfig.Builder setTcpNoDelay(boolean tcpNoDelay)

Sets the default value of the SocketOptions.TCP_NODELAY parameter for newly created sockets.

Default: false

Returns:

this instance.

See Also:

• SocketOptions.TCP_NODELAY

setTrafficClass

public IOReactorConfig.Builder setTrafficClass(int trafficClass)

Sets the default value of the SocketOptions.IP_TOS parameter for newly created sockets.

Default: 0

Returns:

this instance.

Since:

5.1

See Also:

• SocketOptions.IP_TOS

setSndBufSize

public IOReactorConfig.Builder setSndBufSize(int sndBufSize)

Sets the default value of the SocketOptions.SO_SNDBUF parameter for newly created sockets.

Default: 0 (system default)

Returns:

this instance.

See Also:

• SocketOptions.SO_SNDBUF

setRcvBufSize

public IOReactorConfig.Builder setRcvBufSize(int rcvBufSize)

Sets the default value of the SocketOptions.SO_RCVBUF parameter for newly created sockets.

Default: 0 (system default)

Returns:

this instance.

See Also:

• SocketOptions.SO_RCVBUF

setBacklogSize

public IOReactorConfig.Builder setBacklogSize(int backlogSize)

Sets the default backlog size value for server sockets binds.

Default: 0 (system default)

Returns:

this instance.

Since:

4.4

setTcpKeepIdle

public IOReactorConfig.Builder setTcpKeepIdle(int tcpKeepIdle)

Sets the time (in seconds) the connection needs to remain idle before TCP starts sending keepalive probes.

Default: 5

Returns:

this instance.

Since:

5.3

setTcpKeepInterval

public IOReactorConfig.Builder setTcpKeepInterval(int tcpKeepInterval)

Sets the time (in seconds) between individual keepalive probes.

Default: 5

Returns:

this instance.

Since:

5.3

setTcpKeepCount

public IOReactorConfig.Builder setTcpKeepCount(int tcpKeepCount)

Sets the maximum number of keepalive probes TCP should send before dropping the connection.

Default: 3

Returns:

this instance.

Since:

5.3

setSocksProxyAddress

public IOReactorConfig.Builder setSocksProxyAddress(SocketAddress socksProxyAddress)

Sets the address of the SOCKS proxy to use.

Returns:

this instance.

setSocksProxyUsername

public IOReactorConfig.Builder setSocksProxyUsername(String socksProxyUsername)

Sets the username to provide to the SOCKS proxy for username/password authentication.

Returns:

this instance.

setSocksProxyPassword

public IOReactorConfig.Builder setSocksProxyPassword(String socksProxyPassword)

Sets the password to provide to the SOCKS proxy for username/password authentication.

Returns:

this instance.

build

public IOReactorConfig build()