Top Description Fields
org.apache.http.params

public Interface CoreConnectionPNames

Known Direct Implementers
org.apache.http.params.HttpConnectionParams
Annotations
@Deprecated

Deprecated

(4.3) use configuration classes provided 'org.apache.http.config' and 'org.apache.http.client.config'

Defines parameter names for connections in HttpCore.
Since
4.0

Field Summary

Modifier and TypeField and Description
public static final String
CONNECTION_TIMEOUT

Determines the timeout in milliseconds until a connection is established.

public static final String
MAX_HEADER_COUNT

Determines the maximum HTTP header count allowed.

public static final String
MAX_LINE_LENGTH

Determines the maximum line length limit.

public static final String
MIN_CHUNK_LIMIT

Defines the size limit below which data chunks should be buffered in a session I/O buffer in order to minimize native method invocations on the underlying network socket.

public static final String
SO_KEEPALIVE

Defines whether or not TCP is to send automatically a keepalive probe to the peer after an interval of inactivity (no data exchanged in either direction) between this host and the peer.

public static final String
SO_LINGER

Sets SO_LINGER with the specified linger time in seconds.

public static final String
SO_REUSEADDR

Defines whether the socket can be bound even though a previous connection is still in a timeout state.

public static final String
SO_TIMEOUT

Defines the socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets).

public static final String
SOCKET_BUFFER_SIZE

Determines the size of the internal socket buffer used to buffer data while receiving / transmitting HTTP messages.

public static final String
STALE_CONNECTION_CHECK

Determines whether stale connection check is to be used.

public static final String
TCP_NODELAY

Determines whether Nagle's algorithm is to be used.

Field Detail

CONNECTION_TIMEOUTback to summary
public static final String CONNECTION_TIMEOUT

Determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout.

Please note this parameter can only be applied to connections that are bound to a particular local address.

This parameter expects a value of type Integer.

MAX_HEADER_COUNTback to summary
public static final String MAX_HEADER_COUNT

Determines the maximum HTTP header count allowed. If set to a positive value, the number of HTTP headers received from the data stream exceeding this limit will cause an IOException. A negative or zero value will effectively disable the check.

This parameter expects a value of type Integer.

MAX_LINE_LENGTHback to summary
public static final String MAX_LINE_LENGTH

Determines the maximum line length limit. If set to a positive value, any HTTP line exceeding this limit will cause an IOException. A negative or zero value will effectively disable the check.

This parameter expects a value of type Integer.

MIN_CHUNK_LIMITback to summary
public static final String MIN_CHUNK_LIMIT

Defines the size limit below which data chunks should be buffered in a session I/O buffer in order to minimize native method invocations on the underlying network socket. The optimal value of this parameter can be platform specific and defines a trade-off between performance of memory copy operations and that of native method invocation.

This parameter expects a value of type Integer.

Since
4.1
SO_KEEPALIVEback to summary
public static final String SO_KEEPALIVE

Defines whether or not TCP is to send automatically a keepalive probe to the peer after an interval of inactivity (no data exchanged in either direction) between this host and the peer. The purpose of this option is to detect if the peer host crashes.

This parameter expects a value of type Boolean.

Since
4.2
See Also
java.net.SocketOptions#SO_KEEPALIVE
SO_LINGERback to summary
public static final String SO_LINGER

Sets SO_LINGER with the specified linger time in seconds. The maximum timeout value is platform specific. Value 0 implies that the option is disabled. Value -1 implies that the JRE default is used. The setting only affects the socket close operation.

This parameter expects a value of type Integer.

See Also
java.net.SocketOptions#SO_LINGER
SO_REUSEADDRback to summary
public static final String SO_REUSEADDR

Defines whether the socket can be bound even though a previous connection is still in a timeout state.

This parameter expects a value of type Boolean.

Since
4.1
See Also
java.net.Socket#setReuseAddress(boolean)
SO_TIMEOUTback to summary
public static final String SO_TIMEOUT

Defines the socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets). A timeout value of zero is interpreted as an infinite timeout.

This parameter expects a value of type Integer.

See Also
java.net.SocketOptions#SO_TIMEOUT
SOCKET_BUFFER_SIZEback to summary
public static final String SOCKET_BUFFER_SIZE

Determines the size of the internal socket buffer used to buffer data while receiving / transmitting HTTP messages.

This parameter expects a value of type Integer.

STALE_CONNECTION_CHECKback to summary
public static final String STALE_CONNECTION_CHECK

Determines whether stale connection check is to be used. The stale connection check can cause up to 30 millisecond overhead per request and should be used only when appropriate. For performance critical operations this check should be disabled.

This parameter expects a value of type Boolean.

TCP_NODELAYback to summary
public static final String TCP_NODELAY

Determines whether Nagle's algorithm is to be used. The Nagle's algorithm tries to conserve bandwidth by minimizing the number of segments that are sent. When applications wish to decrease network latency and increase performance, they can disable Nagle's algorithm (that is enable TCP_NODELAY). Data will be sent earlier, at the cost of an increase in bandwidth consumption.

This parameter expects a value of type Boolean.

See Also
java.net.SocketOptions#TCP_NODELAY