Details
-
Task
-
Resolution: Done
-
Minor
-
3.0.19.Final
-
None
-
None
Description
There is an error in the documentation of org.jboss.resteasy.client.jaxrs.ResteasyClientBuilder#socketTimeout
It reads:
* Socket inactivity timeout
However, the implementation sets org.apache.commons.httpclient.params.HttpConnectionParams#setSoTimeout
if (socketTimeout > -1) { HttpConnectionParams.setSoTimeout(params, (int) socketTimeoutUnits.toMillis(socketTimeout)); }
and its documentation reads:
* Sets the default socket timeout (<tt>SO_TIMEOUT</tt>) 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 * {@link HttpMethodParams HTTP method parameters}.
So in fact it sets the amount of time to wait for data, not a timeout for socket inactivity.
