Class SocketConfig

java.lang.Object

org.apache.hc.core5.http.io.SocketConfig

@Contract(threading=IMMUTABLE)
public class SocketConfig
extends Object

Classic I/O network socket configuration.

Since:

4.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SocketConfig.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final int	backlogSize
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 int	tcpKeepCount
private final int	tcpKeepIdle
private final int	tcpKeepInterval
private final boolean	tcpNoDelay

Constructor Summary

Constructors

Constructor	Description
SocketConfig(Timeout soTimeout, boolean soReuseAddress, TimeValue soLinger, boolean soKeepAlive, boolean tcpNoDelay, int sndBufSize, int rcvBufSize, int backlogSize, int tcpKeepIdle, int tcpKeepInterval, int tcpKeepCount, SocketAddress socksProxyAddress)

Method Summary

Modifier and Type	Method	Description
static SocketConfig.Builder	copy(SocketConfig config)
static SocketConfig.Builder	custom()
int	getBacklogSize()
int	getRcvBufSize()
int	getSndBufSize()
SocketAddress	getSocksProxyAddress()
TimeValue	getSoLinger()
Timeout	getSoTimeout()
int	getTcpKeepCount()
int	getTcpKeepIdle()
int	getTcpKeepInterval()
boolean	isSoKeepAlive()
boolean	isSoReuseAddress()
boolean	isTcpNoDelay()
String	toString()

Methods inherited from class Object

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

Field Details

DEFAULT_SOCKET_TIMEOUT

private static final Timeout DEFAULT_SOCKET_TIMEOUT

DEFAULT

public static final SocketConfig DEFAULT

soTimeout

private final Timeout soTimeout

soReuseAddress

private final boolean soReuseAddress

soLinger

private final TimeValue soLinger

soKeepAlive

private final boolean soKeepAlive

tcpNoDelay

private final boolean tcpNoDelay

sndBufSize

private final int sndBufSize

rcvBufSize

private final int rcvBufSize

backlogSize

private final int backlogSize

tcpKeepIdle

private final int tcpKeepIdle

tcpKeepInterval

private final int tcpKeepInterval

tcpKeepCount

private final int tcpKeepCount

socksProxyAddress

private final SocketAddress socksProxyAddress

Constructor Details

SocketConfig

SocketConfig(Timeout soTimeout,
 boolean soReuseAddress,
 TimeValue soLinger,
 boolean soKeepAlive,
 boolean tcpNoDelay,
 int sndBufSize,
 int rcvBufSize,
 int backlogSize,
 int tcpKeepIdle,
 int tcpKeepInterval,
 int tcpKeepCount,
 SocketAddress socksProxyAddress)

Method Details

getSoTimeout

public Timeout getSoTimeout()

See Also:

• SocketConfig.Builder.setSoTimeout(Timeout)

isSoReuseAddress

public boolean isSoReuseAddress()

See Also:

• SocketConfig.Builder.setSoReuseAddress(boolean)

getSoLinger

public TimeValue getSoLinger()

See Also:

• SocketConfig.Builder.setSoLinger(TimeValue)

isSoKeepAlive

public boolean isSoKeepAlive()

See Also:

• SocketConfig.Builder.setSoKeepAlive(boolean)

isTcpNoDelay

public boolean isTcpNoDelay()

See Also:

• SocketConfig.Builder.setTcpNoDelay(boolean)

getSndBufSize

public int getSndBufSize()

Since:

4.4

See Also:

• SocketConfig.Builder.setSndBufSize(int)

getRcvBufSize

public int getRcvBufSize()

Since:

4.4

See Also:

• SocketConfig.Builder.setRcvBufSize(int)

getBacklogSize

public int getBacklogSize()

Since:

4.4

See Also:

• SocketConfig.Builder.setBacklogSize(int)

getTcpKeepIdle

public int getTcpKeepIdle()

Since:

5.3

See Also:

• SocketConfig.Builder.setTcpKeepIdle(int)

getTcpKeepInterval

public int getTcpKeepInterval()

Since:

5.3

See Also:

• SocketConfig.Builder.setTcpKeepInterval(int)

getTcpKeepCount

public int getTcpKeepCount()

Since:

5.3

See Also:

• SocketConfig.Builder.setTcpKeepCount(int)

getSocksProxyAddress

public SocketAddress getSocksProxyAddress()

See Also:

• SocketConfig.Builder.setSocksProxyAddress(SocketAddress)

toString

public String toString()

Overrides:

toString in class Object

custom

public static SocketConfig.Builder custom()

copy

public static SocketConfig.Builder copy(SocketConfig config)