CoreBluetooth callback fixes and cleanups #678
Merged
Conversation
This file contains 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
In the CoreBluetooth backend, futures are used to pass results/errors from the delegate callbacks to methods that are waiting for them. The futures are stored as part of the object state so that the delegates can access them. Prior to this change, completed futures were not removed from the object status. This worked most of the time because a second call of the same method would replace the completed future from the prior call. However, in the case of notifications and reads, the same delegate callback is shared with two methods. So when both of these were used, notifications would attempt to complete the already completed read future which raises an InvalidStateError. Fixes #675.
This updates CoreBluetooth to read the changed value in the delegate callback and pass it back to the BleakClient method via the future object. By reading the value in the delegate callback rather than the method scheduled by call_soon_threadsafe(), we ensure that we get the original value from the delegate callback and not a possibly changed value later.
This removes `return True` from several PeripheralDelegate methods. These methods unconditionally return `True`, so we can simplify the code by removing it.
The same delegate callback is used for notifications and reading characteristics. This rearranges the logic so that if there is a read request pending, it will complete the read, otherwise it will trigger a notification callback. Previously, reads would also trigger notification callbacks.
dlech
added
the
Backend: Core Bluetooth
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.
This started as a fix for #675 and I found some cleanups to do in the surrounding code. See commit messages for details.