Skip to content

Fix WiFiClientSecure read() and available() logic to properly include peeked byte #2151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed

Fix WiFiClientSecure read() and available() logic to properly include peeked byte #2151

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c19d5b8
#2147 available() shouldn't return 0 after disconnect if there is sti…
rdowning-triax Dec 3, 2018
a9779a8
fix read() logic to correctly return number of bytes 'read' including…
rdowning-triax Dec 3, 2018
c6fb71a
available() shouldn't return 0 if there is still data to read. fixed …
rdowning-triax Dec 3, 2018
409ceaa
remove unneeded peek handling case. this is now handled in read(*buf,…
rdowning-triax Dec 4, 2018
e9e9f61
don't decrease size twice
rdowning-triax Dec 4, 2018
0aabf7e
Merge branch 'master' into develop
me-no-dev Dec 15, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions libraries/WiFiClientSecure/src/WiFiClientSecure.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,6 @@ size_t WiFiClientSecure::write(const uint8_t *buf, size_t size)

int WiFiClientSecure::read(uint8_t *buf, size_t size)
{
int peeked = 0;
if ((!buf && size) || (_peek < 0 && !available())) {
return -1;
}
Expand All @@ -196,19 +195,16 @@ int WiFiClientSecure::read(uint8_t *buf, size_t size)
buf[0] = _peek;
_peek = -1;
size--;
if(!size || !available()){
return 1;
}
buf++;
peeked = 1;
int ret = read(buf+1, size-1);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I fail to see what this fixes? Also calling a function on itself? Why? Note that size has already been subtracted. Every time there is a peek byte, you will get 1 byte less.

Copy link
Contributor Author

@rdowning-triax rdowning-triax Dec 4, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes, the double subtraction was my mistake. I pushed a commit to fix that. The changes to read(...) and the recursive function call just clean up and remove a bunch of redundant code.

What's really meant to be fixed is available(). Here it has the same problem WiFiClient had, where if not connected it would return 0, even if there was data available. Another problem was, if the data_to_read result res was less than 0, it would just return that negative value, even if there is a peeked byte available.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually there was a problem in read(...) too, where if you have a peeked byte, but then res is a negative number, you just return the negative, whereas it should be returning 1 to indicate you read the peeked byte at the very least.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still I would rather you revert this recursive call and fix the "returns -1 if read failed but there was a peek" when get_ssl_receive returns negative.

return 1 + ((ret > 0) ? ret : 0);
}

int res = get_ssl_receive(sslclient, buf, size);
if (res < 0) {
stop();
return res;
}
return res + peeked;
return res;
}

int WiFiClientSecure::available()
Expand Down