hc-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Michael Osipov (JIRA)" <j...@apache.org>
Subject [jira] [Created] (HTTPCLIENT-1507) Quick start comments do not correspond to user guide
Date Mon, 12 May 2014 10:01:23 GMT
Michael Osipov created HTTPCLIENT-1507:
------------------------------------------

             Summary: Quick start comments do not correspond to user guide
                 Key: HTTPCLIENT-1507
                 URL: https://issues.apache.org/jira/browse/HTTPCLIENT-1507
             Project: HttpComponents HttpClient
          Issue Type: Improvement
          Components: Documentation
    Affects Versions: 4.3.3
            Reporter: Michael Osipov


[Quick start|http://hc.apache.org/httpcomponents-client-ga/quickstart.html] says:

{quote}
// The underlying HTTP connection is still held by the response object
// to allow the response content to be streamed directly from the network socket.
// In order to ensure correct deallocation of system resources
// the user MUST either fully consume the response content  or abort request
// execution by calling CloseableHttpResponse#close().
{quote}

but the [user guide|http://hc.apache.org/httpcomponents-client-4.3.x/tutorial/html/fundamentals.html#d5e145]
says:

{quote}
The difference between closing the content stream and closing the response is that the former
will attempt to keep the underlying connection alive by consuming the entity content while
the latter immediately shuts down and discards the connection.
{quote}

This is a contradiction. The code which follows in the quick start is correct but not the
comment. Even if I consume the response content the underlying connection is still help open.



--
This message was sent by Atlassian JIRA
(v6.2#6252)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org


Mime
View raw message