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

Modifier and Type	Field and Description
private final int	backlogSize
public static final SocketConfig	DEFAULT
private static final Timeout	DEFAULT_SOCKET_TIMEOUT
private final int	rcvBufSize
private final int	sndBufSize
private final SocketAddress	socksProxyAddress
private final boolean	soKeepAlive
private final TimeValue	soLinger
private final boolean	soReuseAddress
private final Timeout	soTimeout
private final boolean	tcpNoDelay

Access	Constructor and Description
pack-priv	SocketConfig(final Timeout soTimeout, final boolean soReuseAddress, final TimeValue soLinger, final boolean soKeepAlive, final boolean tcpNoDelay, final int sndBufSize, final int rcvBufSize, final int backlogSize, final SocketAddress socksProxyAddress)

Modifier and Type	Method and Description
public static SocketConfig.Builder	copy(final SocketConfig config)
public static SocketConfig.Builder	custom()
public int	getBacklogSize()
public int	getRcvBufSize()
public int	getSndBufSize()
public SocketAddress	getSocksProxyAddress()
public TimeValue	getSoLinger()
public Timeout	getSoTimeout()
public boolean	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 SocketConfig DEFAULT

DEFAULT_SOCKET_TIMEOUT	back to summary
private static final Timeout DEFAULT_SOCKET_TIMEOUT

rcvBufSize	back to summary
private final int rcvBufSize

sndBufSize	back to summary
private final int sndBufSize

socksProxyAddress	back to summary
private final SocketAddress socksProxyAddress

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

SocketConfig	back to summary
pack-priv SocketConfig(final Timeout soTimeout, final boolean soReuseAddress, final TimeValue soLinger, final boolean soKeepAlive, final boolean tcpNoDelay, final int sndBufSize, final int rcvBufSize, final int backlogSize, final SocketAddress socksProxyAddress)

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

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

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

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

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

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

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

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

isSoKeepAlive	back to summary
public boolean isSoKeepAlive() 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

org.apache.hc.core5.http.io back to summary

public Class SocketConfig.Builder

Class Inheritance

extends Object

java.lang.Object
org.apache.hc.core5.http.io.SocketConfig.Builder

Field Summary

Modifier and Type	Field and Description
private int	backlogSize
private int	rcvBufSize
private int	sndBufSize
private SocketAddress	socksProxyAddress
private boolean	soKeepAlive
private TimeValue	soLinger
private boolean	soReuseAddress
private Timeout	soTimeout
private boolean	tcpNoDelay

Constructor Summary

Access	Constructor and Description
pack-priv	Builder()

Method Summary

Modifier and Type	Method and Description
public SocketConfig	build()
public SocketConfig.Builder	Returns: the maximum queue length for incoming connection indications setBacklogSize(final int backlogSize) Determines the maximum queue length for incoming connection indications (a request to connect) also known as server socket backlog.
public SocketConfig.Builder	Returns: the default value of the `java.net.SocketOptions#SO_RCVBUF` parameter. setRcvBufSize(final int rcvBufSize) Determines the default value of the `java.net.SocketOptions#SO_RCVBUF` parameter for newly created sockets.
public SocketConfig.Builder	Returns: the default value of the `java.net.SocketOptions#SO_SNDBUF` parameter. setSndBufSize(final int sndBufSize) Determines the default value of the `java.net.SocketOptions#SO_SNDBUF` parameter for newly created sockets.
public SocketConfig.Builder	setSocksProxyAddress(final SocketAddress socksProxyAddress) The address of the SOCKS proxy to use.
public SocketConfig.Builder	Returns: the default value of the `java.net.SocketOptions#SO_KEEPALIVE` parameter. setSoKeepAlive(final boolean soKeepAlive) Determines the default value of the `java.net.SocketOptions#SO_KEEPALIVE` parameter for newly created sockets.
public SocketConfig.Builder	setSoLinger(final int soLinger, final TimeUnit timeUnit)
public SocketConfig.Builder	Returns: the default value of the `java.net.SocketOptions#SO_LINGER` parameter. setSoLinger(final TimeValue soLinger) Determines the default value of the `java.net.SocketOptions#SO_LINGER` parameter for newly created sockets.
public SocketConfig.Builder	Returns: the default value of the `java.net.SocketOptions#SO_REUSEADDR` parameter. setSoReuseAddress(final boolean soReuseAddress) Determines the default value of the `java.net.SocketOptions#SO_REUSEADDR` parameter for newly created sockets.
public SocketConfig.Builder	setSoTimeout(final int soTimeout, final TimeUnit timeUnit)
public SocketConfig.Builder	Returns: the default socket timeout value for blocking I/O operations. setSoTimeout(final Timeout soTimeout) Determines the default socket timeout value for blocking I/O operations.
public SocketConfig.Builder	Returns: the default value of the `java.net.SocketOptions#TCP_NODELAY` parameter. setTcpNoDelay(final boolean tcpNoDelay) Determines the default value of the `java.net.SocketOptions#TCP_NODELAY` 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

rcvBufSize	back to summary
private int rcvBufSize

sndBufSize	back to summary
private int sndBufSize

socksProxyAddress	back to summary
private SocketAddress socksProxyAddress

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

Constructor Detail

Builder	back to summary
pack-priv Builder()

Method Detail

build	back to summary
public SocketConfig build()

setBacklogSize back to summary

setBacklogSize	back to summary
public SocketConfig.Builder setBacklogSize(final int backlogSize) Determines the maximum queue length for incoming connection indications (a request to connect) also known as server socket backlog. Default: `0` (system default) Returns:SocketConfig.Builder the maximum queue length for incoming connection indications Since 4.4

public SocketConfig.Builder setBacklogSize(final int backlogSize)

Determines the maximum queue length for incoming connection indications (a request to connect) also known as server socket backlog.

Default: 0 (system default)

Returns:SocketConfig.Builder: the maximum queue length for incoming connection indications
Since: 4.4

setRcvBufSize back to summary

setRcvBufSize	back to summary
public SocketConfig.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) Returns:SocketConfig.Builder the default value of the `java.net.SocketOptions#SO_RCVBUF` parameter. Since 4.4 See Also `java.net.SocketOptions#SO_RCVBUF`

public SocketConfig.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)

Returns:SocketConfig.Builder: the default value of the java.net.SocketOptions#SO_RCVBUF parameter.
Since: 4.4
See Also: java.net.SocketOptions#SO_RCVBUF

setSndBufSize back to summary

setSndBufSize	back to summary
public SocketConfig.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) Returns:SocketConfig.Builder the default value of the `java.net.SocketOptions#SO_SNDBUF` parameter. Since 4.4 See Also `java.net.SocketOptions#SO_SNDBUF`

public SocketConfig.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)

Returns:SocketConfig.Builder: the default value of the java.net.SocketOptions#SO_SNDBUF parameter.
Since: 4.4
See Also: java.net.SocketOptions#SO_SNDBUF

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

setSoKeepAlive back to summary

setSoKeepAlive	back to summary
public SocketConfig.Builder setSoKeepAlive(final boolean soKeepAlive) Determines the default value of the `java.net.SocketOptions#SO_KEEPALIVE` parameter for newly created sockets. Default: `false` Returns:SocketConfig.Builder the default value of the `java.net.SocketOptions#SO_KEEPALIVE` parameter. See Also `java.net.SocketOptions#SO_KEEPALIVE`

public SocketConfig.Builder setSoKeepAlive(final boolean soKeepAlive)

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

Default: false

Returns:SocketConfig.Builder: the default value of the java.net.SocketOptions#SO_KEEPALIVE parameter.
See Also: java.net.SocketOptions#SO_KEEPALIVE

setSoLinger	back to summary
public SocketConfig.Builder setSoLinger(final int soLinger, final TimeUnit timeUnit) See Also `setSoLinger(TimeValue)`

setSoLinger back to summary

setSoLinger	back to summary
public SocketConfig.Builder setSoLinger(final TimeValue soLinger) Determines the default value of the `java.net.SocketOptions#SO_LINGER` parameter for newly created sockets. Default: `-1` Returns:SocketConfig.Builder the default value of the `java.net.SocketOptions#SO_LINGER` parameter. See Also `java.net.SocketOptions#SO_LINGER`

public SocketConfig.Builder setSoLinger(final TimeValue soLinger)

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

Default: -1

Returns:SocketConfig.Builder: the default value of the java.net.SocketOptions#SO_LINGER parameter.
See Also: java.net.SocketOptions#SO_LINGER

setSoReuseAddress back to summary

setSoReuseAddress	back to summary
public SocketConfig.Builder setSoReuseAddress(final boolean soReuseAddress) Determines the default value of the `java.net.SocketOptions#SO_REUSEADDR` parameter for newly created sockets. Default: `false` Returns:SocketConfig.Builder the default value of the `java.net.SocketOptions#SO_REUSEADDR` parameter. See Also `java.net.SocketOptions#SO_REUSEADDR`

public SocketConfig.Builder setSoReuseAddress(final boolean soReuseAddress)

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

Default: false

Returns:SocketConfig.Builder: the default value of the java.net.SocketOptions#SO_REUSEADDR parameter.
See Also: java.net.SocketOptions#SO_REUSEADDR

setSoTimeout	back to summary
public SocketConfig.Builder setSoTimeout(final int soTimeout, final TimeUnit timeUnit) See Also `setSoTimeout(Timeout)`

setSoTimeout back to summary

public SocketConfig.Builder setSoTimeout(final Timeout soTimeout)

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

Default: 3 minutes

Returns:SocketConfig.Builder: the default socket timeout value for blocking I/O operations.
See Also: java.net.SocketOptions#SO_TIMEOUT

setTcpNoDelay back to summary

public SocketConfig.Builder setTcpNoDelay(final boolean tcpNoDelay)

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

Default: false

Returns:SocketConfig.Builder: the default value of the java.net.SocketOptions#TCP_NODELAY parameter.
See Also: java.net.SocketOptions#TCP_NODELAY

public Class SocketConfig

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class SocketConfig.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail