Modifier and Type	Class and Description
public static class	IOReactorConfig.Builder

Modifier and Type	Field and Description
private final int	backlogSize
public static final IOReactorConfig	DEFAULT
private final int	ioThreadCount
private final int	rcvBufSize
private final TimeValue	selectInterval
private final int	sndBufSize
private final SocketAddress	socksProxyAddress
private final String	socksProxyPassword
private final String	socksProxyUsername
private final boolean	soKeepAlive
private final TimeValue	soLinger
private final boolean	soReuseAddress
private final Timeout	soTimeout
private final boolean	tcpNoDelay
private final int	trafficClass

Access	Constructor and Description
pack-priv	IOReactorConfig(final TimeValue selectInterval, final int ioThreadCount, final Timeout soTimeout, final boolean soReuseAddress, final TimeValue soLinger, final boolean soKeepAlive, final boolean tcpNoDelay, final int trafficClass, final int sndBufSize, final int rcvBufSize, final int backlogSize, final SocketAddress socksProxyAddress, final String socksProxyUsername, final String socksProxyPassword)

Modifier and Type	Method and Description
public static IOReactorConfig.Builder	copy(final IOReactorConfig config)
public static IOReactorConfig.Builder	custom()
public int	getBacklogSize()
public int	getIoThreadCount()
public int	getRcvBufSize()
public TimeValue	getSelectInterval()
public int	getSndBufSize()
public SocketAddress	getSocksProxyAddress()
public String	getSocksProxyPassword()
public String	getSocksProxyUsername()
public TimeValue	getSoLinger()
public Timeout	getSoTimeout()
public int	getTrafficClass()
public boolean	isSoKeepAlive()
public boolean	isSoKeepalive() Deprecated use `isSoKeepAlive()`.
public boolean	isSoReuseAddress()
public boolean	isTcpNoDelay()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

backlogSize	back to summary
private final int backlogSize

DEFAULT	back to summary
public static final IOReactorConfig DEFAULT

ioThreadCount	back to summary
private final int ioThreadCount

rcvBufSize	back to summary
private final int rcvBufSize

selectInterval	back to summary
private final TimeValue selectInterval

sndBufSize	back to summary
private final int sndBufSize

socksProxyAddress	back to summary
private final SocketAddress socksProxyAddress

socksProxyPassword	back to summary
private final String socksProxyPassword

socksProxyUsername	back to summary
private final String socksProxyUsername

soKeepAlive	back to summary
private final boolean soKeepAlive

soLinger	back to summary
private final TimeValue soLinger

soReuseAddress	back to summary
private final boolean soReuseAddress

soTimeout	back to summary
private final Timeout soTimeout

tcpNoDelay	back to summary
private final boolean tcpNoDelay

trafficClass	back to summary
private final int trafficClass

IOReactorConfig	back to summary
pack-priv IOReactorConfig(final TimeValue selectInterval, final int ioThreadCount, final Timeout soTimeout, final boolean soReuseAddress, final TimeValue soLinger, final boolean soKeepAlive, final boolean tcpNoDelay, final int trafficClass, final int sndBufSize, final int rcvBufSize, final int backlogSize, final SocketAddress socksProxyAddress, final String socksProxyUsername, final String socksProxyPassword)

Method Detail

copy	back to summary
public static IOReactorConfig.Builder copy(final IOReactorConfig config)

custom	back to summary
public static IOReactorConfig.Builder custom()

getBacklogSize	back to summary
public int getBacklogSize() See Also `Builder#setBacklogSize(int)`

getIoThreadCount	back to summary
public int getIoThreadCount() See Also `Builder#setIoThreadCount(int)`

getRcvBufSize	back to summary
public int getRcvBufSize() See Also `Builder#setRcvBufSize(int)`

getSelectInterval	back to summary
public TimeValue getSelectInterval() See Also `Builder#setSelectInterval(TimeValue)`

getSndBufSize	back to summary
public int getSndBufSize() See Also `Builder#setSndBufSize(int)`

getSocksProxyAddress	back to summary
public SocketAddress getSocksProxyAddress() See Also `Builder#setSocksProxyAddress(SocketAddress)`

getSocksProxyPassword	back to summary
public String getSocksProxyPassword() See Also `Builder#setSocksProxyAddress(SocketAddress)`

getSocksProxyUsername	back to summary
public String getSocksProxyUsername() See Also `Builder#setSocksProxyUsername(String)`

getSoLinger	back to summary
public TimeValue getSoLinger() See Also `Builder#setSoLinger(TimeValue)`

getSoTimeout	back to summary
public Timeout getSoTimeout() See Also `Builder#setSoTimeout(Timeout)`

getTrafficClass	back to summary
public int getTrafficClass() Since 5.1 See Also `Builder#setTrafficClass(int)`

isSoKeepAlive	back to summary
public boolean isSoKeepAlive() Since 5.2 See Also `Builder#setSoKeepAlive(boolean)`

isSoKeepalive	back to summary
public boolean isSoKeepalive() Deprecated use `isSoKeepAlive()`. Annotations @Deprecated See Also `Builder#setSoKeepAlive(boolean)`

isSoReuseAddress	back to summary
public boolean isSoReuseAddress() See Also `Builder#setSoReuseAddress(boolean)`

isTcpNoDelay	back to summary
public boolean isTcpNoDelay() See Also `Builder#setTcpNoDelay(boolean)`

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

org.apache.hc.core5.reactor back to summary

public Class IOReactorConfig.Builder

Class Inheritance

extends Object

java.lang.Object
org.apache.hc.core5.reactor.IOReactorConfig.Builder

Field Summary

Modifier and Type	Field and 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 boolean	tcpNoDelay
private int	trafficClass

Constructor Summary

Access	Constructor and Description
pack-priv	Builder()

Method Summary

Modifier and Type	Method and Description
public IOReactorConfig	build()
public static int	Returns: the default value for ioThreadCount. getDefaultMaxIOThreadCount() Gets the default value for `ioThreadCount`.
public IOReactorConfig.Builder	setBacklogSize(final int backlogSize) Determines the default backlog size value for server sockets binds.
public static void	setDefaultMaxIOThreadCount(final int the default value for ioThreadCount. defaultMaxIOThreadCount) Sets the default value for `ioThreadCount`.
public IOReactorConfig.Builder	setIoThreadCount(final int ioThreadCount) Determines the number of I/O dispatch threads to be used by the I/O reactor.
public IOReactorConfig.Builder	setRcvBufSize(final int rcvBufSize) Determines the default value of the `java.net.SocketOptions#SO_RCVBUF` parameter for newly created sockets.
public IOReactorConfig.Builder	setSelectInterval(final TimeValue selectInterval) Determines time interval at which the I/O reactor wakes up to check for timed out sessions and session requests.
public IOReactorConfig.Builder	setSndBufSize(final int sndBufSize) Determines the default value of the `java.net.SocketOptions#SO_SNDBUF` parameter for newly created sockets.
public IOReactorConfig.Builder	setSocksProxyAddress(final SocketAddress socksProxyAddress) The address of the SOCKS proxy to use.
public IOReactorConfig.Builder	setSocksProxyPassword(final String socksProxyPassword) The password to provide to the SOCKS proxy for username/password authentication.
public IOReactorConfig.Builder	setSocksProxyUsername(final String socksProxyUsername) The username to provide to the SOCKS proxy for username/password authentication.
public IOReactorConfig.Builder	setSoKeepAlive(final boolean soKeepAlive) Determines the default value of the `java.net.SocketOptions#SO_KEEPALIVE` parameter for newly created sockets.
public IOReactorConfig.Builder	setSoLinger(final int soLinger, final TimeUnit timeUnit) Determines the default value of the `java.net.SocketOptions#SO_LINGER` parameter for newly created sockets.
public IOReactorConfig.Builder	setSoLinger(final TimeValue soLinger) Determines the default value of the `java.net.SocketOptions#SO_LINGER` parameter for newly created sockets.
public IOReactorConfig.Builder	setSoReuseAddress(final boolean soReuseAddress) Determines the default value of the `java.net.SocketOptions#SO_REUSEADDR` parameter for newly created sockets.
public IOReactorConfig.Builder	setSoTimeout(final int soTimeout, final TimeUnit timeUnit) Determines the default socket timeout value for non-blocking I/O operations.
public IOReactorConfig.Builder	setSoTimeout(final Timeout soTimeout) Determines the default socket timeout value for non-blocking I/O operations.
public IOReactorConfig.Builder	setTcpNoDelay(final boolean tcpNoDelay) Determines the default value of the `java.net.SocketOptions#TCP_NODELAY` parameter for newly created sockets.
public IOReactorConfig.Builder	setTrafficClass(final int trafficClass) Determines the default value of the `java.net.SocketOptions#IP_TOS` parameter for newly created sockets.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

backlogSize	back to summary
private int backlogSize

defaultMaxIOThreadCount	back to summary
private static int defaultMaxIOThreadCount

ioThreadCount	back to summary
private int ioThreadCount

rcvBufSize	back to summary
private int rcvBufSize

selectInterval	back to summary
private TimeValue selectInterval

sndBufSize	back to summary
private int sndBufSize

socksProxyAddress	back to summary
private SocketAddress socksProxyAddress

socksProxyPassword	back to summary
private String socksProxyPassword

socksProxyUsername	back to summary
private String socksProxyUsername

soKeepAlive	back to summary
private boolean soKeepAlive

soLinger	back to summary
private TimeValue soLinger

soReuseAddress	back to summary
private boolean soReuseAddress

soTimeout	back to summary
private Timeout soTimeout

tcpNoDelay	back to summary
private boolean tcpNoDelay

trafficClass	back to summary
private int trafficClass

Constructor Detail

Builder	back to summary
pack-priv Builder()

Method Detail

build	back to summary
public IOReactorConfig build()

getDefaultMaxIOThreadCount back to summary

public static int getDefaultMaxIOThreadCount()

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

Returns:int: the default value for ioThreadCount.
Since: 4.4.10

setBacklogSize back to summary

public IOReactorConfig.Builder setBacklogSize(final int backlogSize)

Determines the default backlog size value for server sockets binds.

Default: 0 (system default)

Since: 4.4

setDefaultMaxIOThreadCount back to summary

public static void setDefaultMaxIOThreadCount(final int defaultMaxIOThreadCount)

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

Parameters

defaultMaxIOThreadCount:int: the default value for ioThreadCount.

Since

4.4.10

setIoThreadCount back to summary

public IOReactorConfig.Builder setIoThreadCount(final int ioThreadCount)

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

Default: 2

setRcvBufSize back to summary

public IOReactorConfig.Builder setRcvBufSize(final int rcvBufSize)

Determines the default value of the java.net.SocketOptions#SO_RCVBUF parameter for newly created sockets.

Default: 0 (system default)

See Also: java.net.SocketOptions#SO_RCVBUF

setSelectInterval back to summary

public IOReactorConfig.Builder setSelectInterval(final TimeValue selectInterval)

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

Default: 1000 milliseconds.

setSndBufSize back to summary

public IOReactorConfig.Builder setSndBufSize(final int sndBufSize)

Determines the default value of the java.net.SocketOptions#SO_SNDBUF parameter for newly created sockets.

Default: 0 (system default)

See Also: java.net.SocketOptions#SO_SNDBUF

setSocksProxyAddress	back to summary
public IOReactorConfig.Builder setSocksProxyAddress(final SocketAddress socksProxyAddress) The address of the SOCKS proxy to use.

setSocksProxyPassword	back to summary
public IOReactorConfig.Builder setSocksProxyPassword(final String socksProxyPassword) The password to provide to the SOCKS proxy for username/password authentication.

setSocksProxyUsername	back to summary
public IOReactorConfig.Builder setSocksProxyUsername(final String socksProxyUsername) The username to provide to the SOCKS proxy for username/password authentication.

setSoKeepAlive back to summary

public IOReactorConfig.Builder setSoKeepAlive(final boolean soKeepAlive)

Determines the default value of the java.net.SocketOptions#SO_KEEPALIVE parameter for newly created sockets.

Default: -1

See Also: java.net.SocketOptions#SO_KEEPALIVE

setSoLinger back to summary

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

Determines the default value of the java.net.SocketOptions#SO_LINGER parameter for newly created sockets.

Default: -1

See Also: java.net.SocketOptions#SO_LINGER

setSoLinger back to summary

public IOReactorConfig.Builder setSoLinger(final TimeValue soLinger)

Determines the default value of the java.net.SocketOptions#SO_LINGER parameter for newly created sockets.

Default: -1

See Also: java.net.SocketOptions#SO_LINGER

setSoReuseAddress back to summary

public IOReactorConfig.Builder setSoReuseAddress(final boolean soReuseAddress)

Determines the default value of the java.net.SocketOptions#SO_REUSEADDR parameter for newly created sockets.

Default: false

See Also: java.net.SocketOptions#SO_REUSEADDR

setSoTimeout back to summary

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

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

Default: 0 (no timeout)

See Also: java.net.SocketOptions#SO_TIMEOUT

setSoTimeout back to summary

public IOReactorConfig.Builder setSoTimeout(final Timeout soTimeout)

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

Default: 0 (no timeout)

See Also: java.net.SocketOptions#SO_TIMEOUT

setTcpNoDelay back to summary

public IOReactorConfig.Builder setTcpNoDelay(final boolean tcpNoDelay)

Determines the default value of the java.net.SocketOptions#TCP_NODELAY parameter for newly created sockets.

Default: false

See Also: java.net.SocketOptions#TCP_NODELAY

setTrafficClass back to summary

public IOReactorConfig.Builder setTrafficClass(final int trafficClass)

Determines the default value of the java.net.SocketOptions#IP_TOS parameter for newly created sockets.

Default: 0

Since: 5.1
See Also: java.net.SocketOptions#IP_TOS

public final Class IOReactorConfig

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class IOReactorConfig.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail