add reset method to RateLimiter class #32
Merged
Conversation
This file contains 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
dejabot
previously approved these changes
Nov 30, 2023
dejabot
approved these changes
Nov 30, 2023
Done. I couldn't think of a more clear/concise description for the new method than "Resets the timer." I can add docs for the class and its other method, too. |
|
Thx! Javadoc lg. And yeah it'd be great to have javadoc for the rest of the class - much appreciated. That could be a follow up PR too ofc. Thx much! |
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.
RateLimiteris a class we've occasionally used when we need to make the code wait for a specified period of time without interrupting the rest of the code. I think it would be helpful if the class had a method that simply resets theRateLimiter's "timer".For example, let's say someone wants to use
RateLimiterevery 2 seconds. As soon as theRateLimiteris initialized, it starts checking if it has been 2 seconds since the time it was initialized. Currently, if a programmer wanted to make theRateLimiterrestart its count at a specific part of the code, they would need to create a newRateLimiterobject.So, I added a public method that allows a
RateLimiter's start time to be reset.This change is