org.apache.http.params.HttpConnectionParams
An adaptor for accessing connection parameters in HttpParams.
Note that the implements relation to CoreConnectionPNames
is for compatibility with existing application code only. References to
the parameter names should use the interface, not this class.
Summary
|
|
|
Value |
|
String |
CONNECTION_TIMEOUT |
Determines the timeout until a connection is etablished. |
"http.connection.timeout" |
String |
MAX_HEADER_COUNT |
Determines the maximum HTTP header count allowed. |
"http.connection.max-header-count" |
String |
MAX_LINE_LENGTH |
Determines the maximum line length limit. |
"http.connection.max-line-length" |
String |
SOCKET_BUFFER_SIZE |
Determines the size of the internal socket buffer used to buffer data
while receiving / transmitting HTTP messages. |
"http.socket.buffer-size" |
String |
SO_LINGER |
Sets SO_LINGER with the specified linger time in seconds. |
"http.socket.linger" |
String |
SO_TIMEOUT |
Defines the default socket timeout (SO_TIMEOUT) in milliseconds which is the
timeout for waiting for data. |
"http.socket.timeout" |
String |
STALE_CONNECTION_CHECK |
Determines whether stale connection check is to be used. |
"http.connection.stalecheck" |
String |
TCP_NODELAY |
Determines whether Nagle's algorithm is to be used. |
"http.tcp.nodelay" |
Public Methods
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
Details
Public Methods
public
static
int
getConnectionTimeout(HttpParams params)
Returns the timeout until a connection is etablished. A value of zero
means the timeout is not used. The default value is zero.
public
static
int
getLinger(HttpParams params)
Returns linger-on-close timeout. Value
0 implies that the option is
disabled. Value
-1 implies that the JRE default is used.
Returns
- the linger-on-close timeout
public
static
int
getSoTimeout(HttpParams params)
Returns the default socket timeout (
SO_TIMEOUT) in milliseconds which is the
timeout for waiting for data. A timeout value of zero is interpreted as an infinite
timeout. This value is used when no socket timeout is set in the
method parameters.
public
static
int
getSocketBufferSize(HttpParams params)
public
static
boolean
getTcpNoDelay(HttpParams params)
Tests if Nagle's algorithm is to be used.
Returns
- true if the Nagle's algorithm is to NOT be used
(that is enable TCP_NODELAY), false otherwise.
public
static
boolean
isStaleCheckingEnabled(HttpParams params)
Tests whether stale connection check is to be used. Disabling
stale connection check may result in slight performance improvement
at the risk of getting an I/O error when executing a request over a
connection that has been closed at the server side.
Returns
- true if stale connection check is to be used,
false otherwise.
public
static
void
setConnectionTimeout(HttpParams params, int timeout)
Sets the timeout until a connection is etablished. A value of zero
means the timeout is not used. The default value is zero.
Parameters
timeout
| Timeout in milliseconds.
|
public
static
void
setLinger(HttpParams params, int value)
Returns linger-on-close timeout. This option disables/enables immediate return
from a close() of a TCP Socket. Enabling this option with a non-zero Integer
timeout means that a close() will block pending the transmission and
acknowledgement of all data written to the peer, at which point the socket is
closed gracefully. Value
0 implies that the option is
disabled. Value
-1 implies that the JRE default is used.
Parameters
value
| the linger-on-close timeout
|
public
static
void
setSoTimeout(HttpParams params, int timeout)
Sets the default socket timeout (
SO_TIMEOUT) in milliseconds which is the
timeout for waiting for data. A timeout value of zero is interpreted as an infinite
timeout. This value is used when no socket timeout is set in the
method parameters.
Parameters
timeout
| Timeout in milliseconds
|
public
static
void
setSocketBufferSize(HttpParams params, int size)
public
static
void
setStaleCheckingEnabled(HttpParams params, boolean value)
Defines whether stale connection check is to be used. Disabling
stale connection check may result in slight performance improvement
at the risk of getting an I/O error when executing a request over a
connection that has been closed at the server side.
Parameters
value
| true if stale connection check is to be used,
false otherwise.
|
public
static
void
setTcpNoDelay(HttpParams params, boolean value)
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.
Parameters
value
| true if the Nagle's algorithm is to NOT be used
(that is enable TCP_NODELAY), false otherwise.
|