Add documention on http client pool #134
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Maybe we could add a paragraph about the different use cases between HttpClientPool and the BachClient? |
joelwurtz
force-pushed
the
feature/http-client-pool
branch
2 times, most recently
from
b35bbeb to
038eafe
Compare
| Using this kind of client is useful is some use cases : | ||
|
|
||
| - When using a cluster (like a Elasticsearch service with multiple master nodes) | ||
| - When you want to use fallback servers with the combination of the ``RetryPlugin`` (see :doc:`/plugins/retry`) |
There was a problem hiding this comment.
lets move the reason why you need this to the top of this section. before reading a code example, readers want to know why they should care or if its relevant for them.
I don't see how they are related ? |
joelwurtz
force-pushed
the
feature/http-client-pool
branch
2 times, most recently
from
d586710 to
69930d3
Compare
|
and this looks good to me as well! |
|
|
||
| Clients added to the pool are decorated with the ``HttpClientPoolItem`` class unless they already are an instance of this class. | ||
|
|
||
| The pool item class lets the pool be aware of the number of requests currently being processed by that client. |
There was a problem hiding this comment.
Merge this paragraph with the paragraph above. We are still talking about the pool item class.
|
Good. I just had some minor comments. |
joelwurtz
force-pushed
the
feature/http-client-pool
branch
from
69930d3 to
c48aa85
Compare
|
cheers joel! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Doc for php-http/client-common#25