[RateLimiter] Document reserve() method and rename to RateLimiter #14435
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
javiereguiluz
approved these changes
Oct 17, 2020
|
|
||
| // optional, pass a maximum wait time (in seconds), a MaxWaitDurationExceededException | ||
| // is thrown if the process has to wait longer. E.g. to wait at most 20 seconds: | ||
| //$limiter->reserve(1, 20)->wait(); |
There was a problem hiding this comment.
Is this example correct? I would expect it to be:
$limiter->reserve(1)->wait(20);There was a problem hiding this comment.
Unfortunately, yes. I would also prefer your way, but the goal of max time is avoid reserving a token if we know the wait time is longer than its value. So the reserve() method must be aware of the max wait time.
There was a problem hiding this comment.
Thinking out loud: what if we had these methods instead?
reserve(int $tokens = 1);
reserveAndWait(int $tokens = 1, float $maxTime);
reserve();
reserve(2);
reserveAndWait();
reserveAndWait(2);
reserveAndWait(1, 20);There was a problem hiding this comment.
In any case, I'm merging your nice PR because this discussion is something to discuss (or not) in the code repository instead of here. Thanks!
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.
Fixes #14426
After the first round of documentation, the component has had some tweaks to improve usage. This PR updates the docs to be in sync with the current state of the component.