Return IDisposable from Watch #38
Draft
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
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.
A common convention in .NET for managing/cleaning up resources for cancellable operations is to return an IDisposable type. Consumers can then use
using var subscription = ..., which automatically callssubscription.Dispose()when subscription leaves scope.This PR returns an IDisposable from the Watch method which users can use to stop watching queries. The old
SQLWatchOptions.Signalapproach is still available for users which need the ability to stop watching the query from within the OnResult or OnError callbacks, or who prefer to work with CancellationTokens. Also removes a potential memory caused from never cleaning up a CancellationToken.Register call.