Documentation for timer API and clean up unneeded timer API#102
Merged
WyriHaximus merged 5 commits intoreactphp:masterfrom Apr 28, 2017
Merged
Documentation for timer API and clean up unneeded timer API#102WyriHaximus merged 5 commits intoreactphp:masterfrom
WyriHaximus merged 5 commits intoreactphp:masterfrom
Conversation
The mixed "data" attribute is mostly unused and can easily be replaced by closure binding instead. This also prepares the timer instance to become an immutable data structure.
These can easily be replaced by Loop::cancelTimer() and Loop::isTimerActive(). This change ensures that timers are now a plain immutable data structure and offer no methods to change its state. This also prepares the timer to remove the cyclic dependency with the loop instance.
Thid can easily be replaced by using closure binding as documented.
WyriHaximus
approved these changes
Apr 26, 2017
nrk
approved these changes
Apr 27, 2017
Member
nrk
left a comment
There was a problem hiding this comment.
These changes definitely make sense at this stage of ReactPHP. The current API defined by React\EventLoop\TimerInterface was motivated by an hypothetical transition to a full object-based approach that wrapped resources managed by the event loop, but this vision never really took shape for various reasons (even practical ones). Probably this was never discussed in the public or maybe just on IRC, this is something that happened at the very early stages of the project after all.
jsor
approved these changes
Apr 28, 2017
This was referenced Jul 29, 2018
Closed
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
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.
The timer API is currently entirely undocumented and offers several duplicate methods and accessors not really required. Arguably, this makes the timer API appear more difficult than it actually is. The loop accessors also causes an unneeded cyclic dependency which hinders garbage collection.
This PR adds documentation for the existing timer API and then subsequently removes unneeded methods and the cyclic dependency. Note that while this PR does remove parts of the existing API, it does not add any new APIs or otherwise modify the existing APIs. While this does contain some BC breaks, many consumers will not be affected by this due to the duplicate methods. This PR ensures to provide some upgrade guides to those affected by the BC breaks.
Performance improvement is not a major motivation here, but shows a negligible 3-5% improvement anyway (running examples 92 and 94).
If you want to review, consider also looking at the individual commits.
Builds on top of #99 and #100.
cancelTimer() and isTimerActive()
Use closure binding to add arbitrary data to timer
Remove getLoop() and suggest using closure binding instead