RFQ: make TimedRead and TimedPeek virtual #11236
Open
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
👋 Hello imwhocodes, we appreciate your contribution to this project! 📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more. 🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project. Click to see more instructions ...
Review and merge process you can expect ...
|
me-no-dev
added
Peripheral: UART
Status: Review needed
Test Results 76 files 76 suites 12m 49s ⏱️ Results for commit 9401f23. |
Memory usage test (comparing PR against master branch)The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.
Click to expand the detailed deltas report [usage change in BYTES]
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
@imwhocodes - I have a question: Currently, ESP32 Stream Class has Both are not virtual, but implemented in ESP32 HardwareSerial + CDC Classes has the Stream Class implementation by Inheritance. Therefore, with the current code, it is possible to execute Stream methods: // It should be tested within an ESP32-S3 using UART, HW CDC and OTG CDC
char buffer[100];
void setup() {
Serial.setTimeout(10000); // reading Stream methods timeout - 10 seconds
Serial.begin(115200);
}
void loop() {
Serial.println("===============================================================");
size_t numBytesRead = 0;
buffer[0] = '\0';
Serial.println("Send some text with up to 10 bytes using the Serial Monitor");
numBytesRead = Serial.readBytes(buffer, 10);
buffer[numBytesRead] = '\0';
Serial.printf("Got %d bytes [%s]\r\n", numBytesRead, buffer);
buffer[0] = '\0';
Serial.println("Send some text with a '#' that will terminate the Bytes reading");
numBytesRead = Serial.readBytesUntil('#', buffer, 10);
buffer[numBytesRead] = '\0';
Serial.printf("Got %d bytes [%s]\r\n", numBytesRead, buffer);
Serial.println("Send some text with a '#' that will terminate the String reading");
String Sbuffer = Serial.readStringUntil('#');
Serial.printf("Got %d bytes [%s]\r\n", Sbuffer.length() , Sbuffer.c_str());
}OUTPUT - respects the timeout correctly@imwhocodes - Have you found an example that does work correctly? |
SuGlider
added
Status: Awaiting Response
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 is a request for comment / proof of concept
Right now
Stream::TimedRead()andStream::TimedPeek()are concrete functions insideStreamThis mean that when a function that can wait up to a timeout (like
Stream::readBytes,Stream::readBytesUntil,Stream::readStringUntilecc) and there is nothing in the RX buffer the default implementation simply keep spinning in a tight/busy loop calling eitherChildClass::read()orChildClass::peek()This PR keep the default implementation of the two function but add virtual to it so each concrete child class (like
HardwareSerial,HWCDC) can implement an optimised version that relay on the FreeRTOS scheduler and not on busy-polling the interfaceIn this PR there is implementation for two interfaces