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 final int	rcvBufSize
private final int	sndBufSize
private final boolean	soKeepAlive
private final int	soLinger
private final boolean	soReuseAddress
private final int	soTimeout
private final boolean	tcpNoDelay

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

Method Summary

Modifier and Type	Method and Description
protected SocketConfig	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public static SocketConfig.Builder	copy(final SocketConfig config)
public static SocketConfig.Builder	custom()
public int	Returns: the maximum queue length for incoming connection indications getBacklogSize() Determines the maximum queue length for incoming connection indications (a request to connect) also known as server socket backlog.
public int	Returns: the default value of the `java.net.SocketOptions#SO_RCVBUF` parameter. getRcvBufSize() Determines the default value of the `java.net.SocketOptions#SO_RCVBUF` parameter for newly created sockets.
public int	Returns: the default value of the `java.net.SocketOptions#SO_SNDBUF` parameter. getSndBufSize() Determines the default value of the `java.net.SocketOptions#SO_SNDBUF` parameter for newly created sockets.
public int	Returns: the default value of the `java.net.SocketOptions#SO_LINGER` parameter. getSoLinger() Determines the default value of the `java.net.SocketOptions#SO_LINGER` parameter for newly created sockets.
public int	Returns: the default socket timeout value for non-blocking I/O operations. getSoTimeout() Determines the default socket timeout value for non-blocking I/O operations.
public boolean	Returns: the default value of the `java.net.SocketOptions#SO_KEEPALIVE` parameter. isSoKeepAlive() Determines the default value of the `java.net.SocketOptions#SO_KEEPALIVE` parameter for newly created sockets.
public boolean	Returns: the default value of the `java.net.SocketOptions#SO_REUSEADDR` parameter. isSoReuseAddress() Determines the default value of the `java.net.SocketOptions#SO_REUSEADDR` parameter for newly created sockets.
public boolean	Returns: the default value of the `java.net.SocketOptions#TCP_NODELAY` parameter. isTcpNoDelay() Determines the default value of the `java.net.SocketOptions#TCP_NODELAY` parameter for newly created sockets.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

backlogSize	back to summary
private final int backlogSize

DEFAULT	back to summary
public static final SocketConfig DEFAULT

rcvBufSize	back to summary
private final int rcvBufSize

sndBufSize	back to summary
private final int sndBufSize

soKeepAlive	back to summary
private final boolean soKeepAlive

soLinger	back to summary
private final int soLinger

soReuseAddress	back to summary
private final boolean soReuseAddress

soTimeout	back to summary
private final int soTimeout

tcpNoDelay	back to summary
private final boolean tcpNoDelay

Constructor Detail

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

Method Detail

clone back to summary

clone	back to summary
protected SocketConfig clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:SocketConfig a clone of this instance. Annotations @Override Exceptions CloneNotSupportedException: if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

protected SocketConfig clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:SocketConfig

a clone of this instance.

Annotations

@Override

Exceptions

CloneNotSupportedException:: if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

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

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

public int getBacklogSize()

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

Default: 0 (system default)

Returns:int: the maximum queue length for incoming connection indications
Since: 4.4

getRcvBufSize back to summary

getRcvBufSize	back to summary
public int getRcvBufSize() Determines the default value of the `java.net.SocketOptions#SO_RCVBUF` parameter for newly created sockets. Default: `0` (system default) Returns:int the default value of the `java.net.SocketOptions#SO_RCVBUF` parameter. Since 4.4 See Also `java.net.SocketOptions#SO_RCVBUF`

public int getRcvBufSize()

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

Default: 0 (system default)

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

getSndBufSize back to summary

getSndBufSize	back to summary
public int getSndBufSize() Determines the default value of the `java.net.SocketOptions#SO_SNDBUF` parameter for newly created sockets. Default: `0` (system default) Returns:int the default value of the `java.net.SocketOptions#SO_SNDBUF` parameter. Since 4.4 See Also `java.net.SocketOptions#SO_SNDBUF`

public int getSndBufSize()

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

Default: 0 (system default)

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

getSoLinger back to summary

getSoLinger	back to summary
public int getSoLinger() Determines the default value of the `java.net.SocketOptions#SO_LINGER` parameter for newly created sockets. Default: `-1` Returns:int the default value of the `java.net.SocketOptions#SO_LINGER` parameter. See Also `java.net.SocketOptions#SO_LINGER`

public int getSoLinger()

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

Default: -1

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

getSoTimeout back to summary

getSoTimeout	back to summary
public int getSoTimeout() Determines the default socket timeout value for non-blocking I/O operations. Default: `0` (no timeout) Returns:int the default socket timeout value for non-blocking I/O operations. See Also `java.net.SocketOptions#SO_TIMEOUT`

public int getSoTimeout()

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

Default: 0 (no timeout)

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

isSoKeepAlive back to summary

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

public boolean isSoKeepAlive()

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

Default: false

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

isSoReuseAddress back to summary

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

public boolean isSoReuseAddress()

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

Default: false

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

isTcpNoDelay back to summary

isTcpNoDelay	back to summary
public boolean isTcpNoDelay() Determines the default value of the `java.net.SocketOptions#TCP_NODELAY` parameter for newly created sockets. Default: `true` Returns:boolean the default value of the `java.net.SocketOptions#TCP_NODELAY` parameter. See Also `java.net.SocketOptions#TCP_NODELAY`

public boolean isTcpNoDelay()

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

Default: true

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

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.http.config back to summary

public Class SocketConfig.Builder

Class Inheritance

extends Object

java.lang.Object
org.apache.http.config.SocketConfig.Builder

Field Summary

Modifier and Type	Field and Description
private int	backlogSize
private int	rcvBufSize
private int	sndBufSize
private boolean	soKeepAlive
private int	soLinger
private boolean	soReuseAddress
private int	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	setBacklogSize(final int backlogSize)
public SocketConfig.Builder	setRcvBufSize(final int rcvBufSize)
public SocketConfig.Builder	setSndBufSize(final int sndBufSize)
public SocketConfig.Builder	setSoKeepAlive(final boolean soKeepAlive)
public SocketConfig.Builder	setSoLinger(final int soLinger)
public SocketConfig.Builder	setSoReuseAddress(final boolean soReuseAddress)
public SocketConfig.Builder	setSoTimeout(final int soTimeout)
public SocketConfig.Builder	setTcpNoDelay(final boolean tcpNoDelay)

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

soKeepAlive	back to summary
private boolean soKeepAlive

soLinger	back to summary
private int soLinger

soReuseAddress	back to summary
private boolean soReuseAddress

soTimeout	back to summary
private int 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
public SocketConfig.Builder setBacklogSize(final int backlogSize) Since 4.4

setRcvBufSize	back to summary
public SocketConfig.Builder setRcvBufSize(final int rcvBufSize) Since 4.4

setSndBufSize	back to summary
public SocketConfig.Builder setSndBufSize(final int sndBufSize) Since 4.4

setSoKeepAlive	back to summary
public SocketConfig.Builder setSoKeepAlive(final boolean soKeepAlive)

setSoLinger	back to summary
public SocketConfig.Builder setSoLinger(final int soLinger)

setSoReuseAddress	back to summary
public SocketConfig.Builder setSoReuseAddress(final boolean soReuseAddress)

setSoTimeout	back to summary
public SocketConfig.Builder setSoTimeout(final int soTimeout)

setTcpNoDelay	back to summary
public SocketConfig.Builder setTcpNoDelay(final boolean tcpNoDelay)

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