nordic-dev.net/embassy
2
0
Fork 0
mirror of https://github.com/embassy-rs/embassy.git synced 2024-11-21 22:32:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3277 from dvdsk/main

Browse Source 
embassy-net/read document return value Ok(0)
This commit is contained in:
Dario Nieuwenhuis 2024-09-10 21:34:11 +00:00 committed by GitHub
commit aff1e74862
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
embassy-net/src/tcp.rs
View File

@ -79,6 +79,15 @@ impl<'a> TcpReader<'a> {
/// ///
/// Returns how many bytes were read, or an error. If no data is available, it waits /// Returns how many bytes were read, or an error. If no data is available, it waits
/// until there is at least one byte available. /// until there is at least one byte available.
///
/// # Note
/// A return value of Ok(0) means that we have read all data and the remote
/// side has closed our receive half of the socket. The remote can no longer
/// send bytes.
///
/// The send half of the socket is still open. If you want to reconnect using
/// the socket you split this reader off the send half needs to be closed using
/// [`abort()`](TcpSocket::abort).
pub async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error> { pub async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error> {
self.io.read(buf).await self.io.read(buf).await
} }
@ -273,6 +282,9 @@ impl<'a> TcpSocket<'a> {
/// ///
/// Returns how many bytes were read, or an error. If no data is available, it waits /// Returns how many bytes were read, or an error. If no data is available, it waits
/// until there is at least one byte available. /// until there is at least one byte available.
///
/// A return value of Ok(0) means that the socket was closed and is longer
/// able to receive any data.
pub async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error> { pub async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error> {
self.io.read(buf).await self.io.read(buf).await
} }
@ -297,6 +309,10 @@ impl<'a> TcpSocket<'a> {
/// ///
/// If the timeout is set, the socket will be closed if no data is received for the /// If the timeout is set, the socket will be closed if no data is received for the
/// specified duration. /// specified duration.
///
/// # Note:
/// Set a keep alive interval ([`set_keep_alive`] to prevent timeouts when
/// the remote could still respond.
pub fn set_timeout(&mut self, duration: Option<Duration>) { pub fn set_timeout(&mut self, duration: Option<Duration>) {
self.io self.io
.with_mut(|s, _| s.set_timeout(duration.map(duration_to_smoltcp))) .with_mut(|s, _| s.set_timeout(duration.map(duration_to_smoltcp)))
@ -308,6 +324,9 @@ impl<'a> TcpSocket<'a> {
/// the specified duration of inactivity. /// the specified duration of inactivity.
/// ///
/// If not set, the socket will not send keep-alive packets. /// If not set, the socket will not send keep-alive packets.
///
/// By setting a [`timeout`](Self::timeout) larger then the keep alive you
/// can detect a remote endpoint that no longer answers.
pub fn set_keep_alive(&mut self, interval: Option<Duration>) { pub fn set_keep_alive(&mut self, interval: Option<Duration>) {
self.io self.io
.with_mut(|s, _| s.set_keep_alive(interval.map(duration_to_smoltcp))) .with_mut(|s, _| s.set_keep_alive(interval.map(duration_to_smoltcp)))