|
| |
|
| java.lang.Object
 org.apache.commons.httpclient.params.DefaultHttpParams
org.apache.commons.httpclient.params.HttpConnectionParams
All known Subclasses: org.apache.commons.httpclient.params.HttpConnectionManagerParams,
| HttpConnectionParams | | public class HttpConnectionParams extends DefaultHttpParams (Code) | | This class represents a collection of HTTP protocol parameters applicable to
org.apache.commons.httpclient.HttpConnection HTTP connections .
Protocol parameters may be linked together to form a hierarchy. If a particular
parameter value has not been explicitly defined in the collection itself, its
value will be drawn from the parent collection of parameters.
author:
Oleg Kalnichevski
version:
$Revision: 480424 $
since:
3.0 |
| Field Summary | |
| final public static String | CONNECTION_TIMEOUT
Determines the timeout until a connection is etablished. | | final public static String | SO_LINGER
Sets SO_LINGER with the specified linger time in seconds. | | final public static String | SO_RCVBUF
Determines a hint the size of the underlying buffers used by the platform
for incoming network I/O. | | final public static String | SO_SNDBUF
Determines a hint the size of the underlying buffers used by the platform
for outgoing network I/O. | | final public static String | SO_TIMEOUT
Defines the default socket timeout (SO_TIMEOUT) in milliseconds which is the
timeout for waiting for data. | | final public static String | STALE_CONNECTION_CHECK
Determines whether stale connection check is to be used. | | final public static String | TCP_NODELAY
Determines whether Nagle's algorithm is to be used. |
| Method Summary | |
| public int | getConnectionTimeout()
Returns the timeout until a connection is etablished. | | public int | getLinger()
Returns linger-on-close timeout. | | public int | getReceiveBufferSize()
Returns a hint the size of the underlying buffers used by the platform
for incoming network I/O. | | public int | getSendBufferSize()
Returns a hint the size of the underlying buffers used by the platform for
outgoing network I/O. | | public int | getSoTimeout()
Returns the default socket timeout (SO_TIMEOUT) in milliseconds which is the
timeout for waiting for data. | | public boolean | getTcpNoDelay()
Tests if Nagle's algorithm is to be used. | | public boolean | isStaleCheckingEnabled()
Tests whether stale connection check is to be used. | | public void | setConnectionTimeout(int timeout)
Sets the timeout until a connection is etablished. | | public void | setLinger(int value)
Returns linger-on-close timeout. | | public void | setReceiveBufferSize(int size)
Sets a hint the size of the underlying buffers used by the platform
for incoming network I/O. | | public void | setSendBufferSize(int size)
Sets a hint the size of the underlying buffers used by the platform for
outgoing network I/O. | | public void | setSoTimeout(int timeout)
Sets the default socket timeout (SO_TIMEOUT) in milliseconds which is the
timeout for waiting for data. | | public void | setStaleCheckingEnabled(boolean value)
Defines whether stale connection check is to be used. | | public void | setTcpNoDelay(boolean value)
Determines whether Nagle's algorithm is to be used. |
| CONNECTION_TIMEOUT | | final public static String CONNECTION_TIMEOUT(Code) | | Determines the timeout until a connection is etablished. A value of zero
means the timeout is not used. The default value is zero.
This parameter expects a value of type
Integer .
|
| SO_LINGER | | final public static String SO_LINGER(Code) | | 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
socket close.
This parameter expects a value of type
Integer .
See Also: java.net.SocketOptions.SO_LINGER |
| SO_RCVBUF | | final public static String SO_RCVBUF(Code) | | Determines a hint the size of the underlying buffers used by the platform
for incoming network I/O. This value is a suggestion to the kernel from
the application about the size of buffers to use for the data to be received
over the socket.
This parameter expects a value of type
Integer .
See Also: java.net.SocketOptions.SO_RCVBUF |
| SO_SNDBUF | | final public static String SO_SNDBUF(Code) | | Determines a hint the size of the underlying buffers used by the platform
for outgoing network I/O. This value is a suggestion to the kernel from
the application about the size of buffers to use for the data to be sent
over the socket.
This parameter expects a value of type
Integer .
See Also: java.net.SocketOptions.SO_SNDBUF |
| SO_TIMEOUT | | final public static String SO_TIMEOUT(Code) | | Defines 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
HttpMethodParams HTTP method parameters .
This parameter expects a value of type
Integer .
See Also: java.net.SocketOptions.SO_TIMEOUT |
| STALE_CONNECTION_CHECK | | final public static String STALE_CONNECTION_CHECK(Code) | | Determines 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.
This parameter expects a value of type
Boolean .
|
| TCP_NODELAY | | final public static String TCP_NODELAY(Code) | | 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 |
| getConnectionTimeout | | public int getConnectionTimeout()(Code) | | Returns the timeout until a connection is etablished. A value of zero
means the timeout is not used. The default value is zero.
timeout in milliseconds. |
| getLinger | | public int getLinger()(Code) | | Returns linger-on-close timeout. Value 0 implies that the option is
disabled. Value -1 implies that the JRE default is used.
the linger-on-close timeout |
| getReceiveBufferSize | | public int getReceiveBufferSize()(Code) | | Returns a hint the size of the underlying buffers used by the platform
for incoming network I/O. This value is a suggestion to the kernel from
the application about the size of buffers to use for the data to be received
over the socket.
the hint size of the send buffer |
| getSendBufferSize | | public int getSendBufferSize()(Code) | | Returns a hint the size of the underlying buffers used by the platform for
outgoing network I/O. This value is a suggestion to the kernel from the
application about the size of buffers to use for the data to be sent over
the socket.
the hint size of the send buffer |
| getSoTimeout | | public int getSoTimeout()(Code) | | 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
HttpMethodParams HTTP method parameters .
timeout in milliseconds |
| getTcpNoDelay | | public boolean getTcpNoDelay()(Code) | | Tests if Nagle's algorithm is to be used.
true if the Nagle's algorithm is to NOT be used(that is enable TCP_NODELAY), false otherwise. |
| isStaleCheckingEnabled | | public boolean isStaleCheckingEnabled()(Code) | | 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.
true if stale connection check is to be used, false otherwise. |
| setConnectionTimeout | | public void setConnectionTimeout(int timeout)(Code) | | 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. |
| setLinger | | public void setLinger(int value)(Code) | | 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 |
| setReceiveBufferSize | | public void setReceiveBufferSize(int size)(Code) | | Sets a hint the size of the underlying buffers used by the platform
for incoming network I/O. This value is a suggestion to the kernel from
the application about the size of buffers to use for the data to be received
over the socket.
Parameters:
size - the hint size of the send buffer |
| setSendBufferSize | | public void setSendBufferSize(int size)(Code) | | Sets a hint the size of the underlying buffers used by the platform for
outgoing network I/O. This value is a suggestion to the kernel from the
application about the size of buffers to use for the data to be sent over
the socket.
Parameters:
size - the hint size of the send buffer |
| setSoTimeout | | public void setSoTimeout(int timeout)(Code) | | 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
HttpMethodParams HTTP method parameters .
Parameters:
timeout - Timeout in milliseconds |
| setStaleCheckingEnabled | | public void setStaleCheckingEnabled(boolean value)(Code) | | 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. |
| setTcpNoDelay | | public void setTcpNoDelay(boolean value)(Code) | | 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. |
| Methods inherited from org.apache.commons.httpclient.params.DefaultHttpParams | public void clear()(Code)(Java Doc)
public Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean getBooleanParameter(String name, boolean defaultValue)(Code)(Java Doc)
public static HttpParams getDefaultParams()(Code)(Java Doc)
public synchronized HttpParams getDefaults()(Code)(Java Doc)
public double getDoubleParameter(String name, double defaultValue)(Code)(Java Doc)
public int getIntParameter(String name, int defaultValue)(Code)(Java Doc)
public long getLongParameter(String name, long defaultValue)(Code)(Java Doc)
public synchronized Object getParameter(String name)(Code)(Java Doc)
public boolean isParameterFalse(String name)(Code)(Java Doc)
public boolean isParameterSet(String name)(Code)(Java Doc)
public boolean isParameterSetLocally(String name)(Code)(Java Doc)
public boolean isParameterTrue(String name)(Code)(Java Doc)
public void setBooleanParameter(String name, boolean value)(Code)(Java Doc)
public synchronized void setDefaults(HttpParams params)(Code)(Java Doc)
public void setDoubleParameter(String name, double value)(Code)(Java Doc)
public static void setHttpParamsFactory(HttpParamsFactory httpParamsFactory)(Code)(Java Doc)
public void setIntParameter(String name, int value)(Code)(Java Doc)
public void setLongParameter(String name, long value)(Code)(Java Doc)
public synchronized void setParameter(String name, Object value)(Code)(Java Doc)
public synchronized void setParameters(String[] names, Object value)(Code)(Java Doc)
|
|
|
|