New Return Value to Distinguish "Non-update" from Successful Update #75
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
The NTPClient method update() has been changed to only return "TRUE" after a successful update. The following conditions return "FALSE": - Interval duration requirement not met - forceUpdate() times out
|
|
per1234
added
type: enhancement
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.
Currently,
update()returns false only when an update fails during the call toforceUpdate(). This behavior is potentially useful for debugging. However, two other things can happen duringupdate(): a successful update and a "non-update" (whenupdate()does not callforceUpdate()because the_updateIntervalrequirement has not been met). However, no distinction exists between a successful update and a non-update—both situations return true. Users have expressed interest in knowing whether are not a successful update has actually occurred (see Issue #55).That being the case, I propose revising
update()andforceUpdate()to return an 8-bit unsigned integer value rather than a boolean so that a failed update returns 0, a “non-update” returns 1, and a successful update returns 2. It maintains the current boolean behavior to avoid breaking other people’s implementations of the library yet also returns distinct values for both successful updates and non-updates.