Add a purge() method #59
Draft
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
added 2 commits
November 2, 2019 01:31
Also added to SerialDevice and the default implementation. A queue selection enum is included to easily signal which queue should be purged.
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.
Both Windows and Unix have functions (
PurgeCommandtcflush) that clear out the underlying send and receive buffers without sending the data. This can be useful for call-and-response serial connections, where it makes sense to discard any existing data as invalid. There is a user demand for this addition (#56). This PR proposes a purge API and provides a Windows implementation.Both
PurgeCommandtcflushare single functions that accept a parameter indicating whether the input/receive queue, the output/send queue, or both queues should be flushed. This mimics that arrangement, adding apurge(&self, queue: Queue)toSerialPortandSerialDevice. TheQueueenum allows for input, output, or both.On Windows,
purgeis implemented using a single call toPurgeComm. The Unix implementation should be similar, but I don't have a machine nearby to test with, so this is submitted as a draft PR for now with no Unix implementation.