Skip to content

Commit

Permalink
Docs: Explain closing the high level client
Browse files Browse the repository at this point in the history
It looks like we weren't clear on when and why you should close the high
level client and folks were closing it after every request which is not
efficient. This explains why you should close the client and when so
this shouldn't be as common.

Closes #32001
  • Loading branch information
nik9000 committed Jul 12, 2018
1 parent de476d5 commit 8b10f84
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions docs/java-rest/high-level/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -127,12 +127,11 @@ include-tagged::{doc-tests}/MainDocumentationIT.java[rest-high-level-client-init
--------------------------------------------------

The high-level client will internally create the low-level client used to
perform requests based on the provided builder, and manage its lifecycle.

The high-level client instance needs to be closed when no longer needed so that
all the resources used by it get properly released, as well as the underlying
http client instance and its threads. This can be done through the `close`
method, which will close the internal `RestClient` instance.
perform requests based on the provided builder. That low-level client
maintains a pool of connections and starts some threads so you should
close the high-level client when you are well and truly done with
it and it will in turn close the internal low-level client to free those
resources. This can be done through the `close`:

["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
Expand Down

0 comments on commit 8b10f84

Please sign in to comment.