Struct nrf_modem::TcpStream

pub struct TcpStream { /* private fields */ }

A TCP stream that is connected to another endpoint

Implementations

impl TcpStream

pub async fn connect(addr: impl ToSocketAddrs) -> Result<Self, Error>

Connect a TCP stream to the given address

pub async fn connect_with_cancellation( addr: impl ToSocketAddrs, token: &CancellationToken, ) -> Result<Self, Error>

Connect a TCP stream to the given address

pub fn as_raw_fd(&self) -> i32

Get the raw underlying file descriptor for when you need to interact with the nrf libraries directly

pub async fn split_owned( self, ) -> Result<(OwnedTcpReadStream, OwnedTcpWriteStream), Error>

Split the stream into an owned read and write half

pub fn split(&self) -> (TcpReadStream<'_>, TcpWriteStream<'_>)

Split the stream into a borrowed read and write half

pub async fn receive<'buf>( &self, buf: &'buf mut [u8], ) -> Result<&'buf mut [u8], Error>

Try fill the given buffer with the data that has been received. The written part of the buffer is returned.

pub async fn receive_with_cancellation<'buf>( &self, buf: &'buf mut [u8], token: &CancellationToken, ) -> Result<&'buf mut [u8], Error>

Try fill the given buffer with the data that has been received. The written part of the buffer is returned.

pub async fn receive_exact<'buf>( &self, buf: &'buf mut [u8], ) -> Result<(), (Error, &'buf mut [u8])>

Fill the entire buffer with data that has been received. This will wait as long as necessary to fill up the buffer.

If there’s an error while receiving, then the error is returned as well as the part of the buffer that was partially filled with received data.

pub async fn receive_exact_with_cancellation<'buf>( &self, buf: &'buf mut [u8], token: &CancellationToken, ) -> Result<(), (Error, &'buf mut [u8])>

Fill the entire buffer with data that has been received. This will wait as long as necessary to fill up the buffer.

If there’s an error while receiving, then the error is returned as well as the part of the buffer that was partially filled with received data.

pub async fn write(&self, buf: &[u8]) -> Result<(), Error>

Write the entire buffer to the stream

pub async fn write_with_cancellation( &self, buf: &[u8], token: &CancellationToken, ) -> Result<(), Error>

Write the entire buffer to the stream

pub async fn deactivate(self) -> Result<(), Error>

Deactivates the socket and the LTE link. A normal drop will do the same thing, but blocking.