This repository was archived by the owner on Jul 1, 2024. It is now read-only.
Make reporting of parse result non-blocking in WatchDeviceChanges#185
Open
amrbekhit wants to merge 1 commit intomuka:masterfrom
Open
Make reporting of parse result non-blocking in WatchDeviceChanges#185amrbekhit wants to merge 1 commit intomuka:masterfrom
amrbekhit wants to merge 1 commit intomuka:masterfrom
Conversation
The `WatchDeviceChanges` function creates a goroutine that watches for any change notifications coming from the underlying Device. The result of `b.Parse` is sent to the channel `ch` using a blocking send. Because of this, the caller to `WatchDeviceChanges` must continuously empty this channel otherise the goroutine will simply hang on this line, meaning it will never exit and result in a goroutine leak. So the caller code looks something like this:
```go
ch, err := b.WatchDeviceChanges(ctx)
if err != nil {
...
}
// Make sure to empty the channel
go func() {
for range ch {}
}()
```
The use of `ch` to return the value of `b.Parse` here seems a bit clunky. It would be useful to just call `WatchDeviceChanges` and check for errors without needing to do any other maintenance except call `UnwatchDeviceChanges` when the beacon is removed. Is `ch` used to notify the caller that the beacon properties have changed so that they can take action? If so, is it critical that no events are missed such that a blocking send is required? If not, perhaps the blocking send to `ch` in the goroutine could be changed to a non-blocking one. This simplifies the caller code, as they can choose to ignore the channel if they don't need it:
```go
if changed.Name == "ManufacturerData" || changed.Name == "ServiceData" {
select {
case ch <- b.Parse():
// Result of parse sent to channel
default:
// The channel is blocked, so result is discarded
}
}
```
The caller code is thus simplified:
```go
_, err := b.WatchDeviceChanges(ctx)
if err != nil {
...
}
// No need to empty the channel now
```
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
WatchDeviceChangesfunction creates a goroutine that watches for any change notifications coming from the underlying Device. The result ofb.Parseis sent to the channelchusing a blocking send. Because of this, the caller toWatchDeviceChangesmust continuously empty this channel otherise the goroutine will simply hang on this line, meaning it will never exit and result in a goroutine leak. So the caller code looks something like this:The use of
chto return the value ofb.Parsehere seems a bit clunky. It would be useful to just callWatchDeviceChangesand check for errors without needing to do any other maintenance except callUnwatchDeviceChangeswhen the beacon is removed. Ischused to notify the caller that the beacon properties have changed so that they can take action? If so, is it critical that no events are missed such that a blocking send is required? If not, perhaps the blocking send tochin the goroutine could be changed to a non-blocking one. This simplifies the caller code, as they can choose to ignore the channel if they don't need it:The caller code is thus simplified: