docs: Clarify timer cleanup comment in removeTask #326
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.
Summary
removeTaskto better explain the timer cleanup flowContext
While investigating timer memory management, I tested uncommenting the
CFRelease(timer)call and confirmed it causes a double-free crash. This validates that the current implementation is correct.The new comment clearly explains the cleanup flow:
CFRunLoopTimerInvalidatetriggers ourTimerReleasecallbackTimerContext, whose destructor callsCFRelease(task->timer)Why this clarification helps
Apple's CFRunLoopTimerInvalidate documentation states:
This does not make it obvious that invalidation also triggers the context's release callback, which is what actually handles the cleanup in this implementation.
Test plan
CFRelease(timer)crashes (double-free)