Skip to content

Commit

Permalink
doc: S2N renamed
Browse files Browse the repository at this point in the history
  • Loading branch information
dougch committed Mar 3, 2021
1 parent 2d66830 commit 44380a6
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/USAGE-GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -1685,7 +1685,7 @@ do {
uint32_t s2n_peek(struct s2n_connection *conn);
```
**s2n_peek** allows users of S2N to peek inside the data buffer of an S2N connection to see if there more data to be read without actually reading it. This is useful when using select() on the underlying S2N file descriptor with a message based application layer protocol. As a single call to s2n_recv may read all data off the underlying file descriptor, select() will be unable to tell you there if there is more application data ready for processing already loaded into the S2N buffer. s2n_peek can then be used to determine if s2n_recv needs to be called before more data comes in on the raw fd.
**s2n_peek** allows users of s2n-tls to peek inside the data buffer of an s2n-tls connection to see if there more data to be read without actually reading it. This is useful when using select() on the underlying s2n-tls file descriptor with a message based application layer protocol. As a single call to s2n_recv may read all data off the underlying file descriptor, select() will be unable to tell you there if there is more application data ready for processing already loaded into the s2n-tls buffer. s2n_peek can then be used to determine if s2n_recv needs to be called before more data comes in on the raw fd.
Expand Down

0 comments on commit 44380a6

Please sign in to comment.