Struct TcpClient

pub struct TcpClient<'d, const N: usize, const TX_SZ: usize = 1024, const RX_SZ: usize = 1024> { /* private fields */ }

Available on crate feature tcp only.

TCP client connection pool compatible with embedded-nal-async traits.

The pool is capable of managing up to N concurrent connections with tx and rx buffers according to TX_SZ and RX_SZ.

Implementations

impl<'d, const N: usize, const TX_SZ: usize, const RX_SZ: usize> TcpClient<'d, N, TX_SZ, RX_SZ>

pub fn new( stack: Stack<'d>, state: &'d TcpClientState<N, TX_SZ, RX_SZ>, ) -> TcpClient<'d, N, TX_SZ, RX_SZ>

Create a new TcpClient.

pub fn set_timeout(&mut self, timeout: Option<Duration>)

Set the timeout for each socket created by this TcpClient.

If the timeout is set, the socket will be closed if no data is received for the specified duration.

Trait Implementations

impl<'d, const N: usize, const TX_SZ: usize, const RX_SZ: usize> TcpConnect for TcpClient<'d, N, TX_SZ, RX_SZ>

type Error = Error

Error type returned on connect failure.

type Connection<'m> = TcpConnection<'m, N, TX_SZ, RX_SZ> where TcpClient<'d, N, TX_SZ, RX_SZ>: 'm

Type holding state of a TCP connection. Should close the connection when dropped.

async fn connect<'a>( &'a self, remote: SocketAddr, ) -> Result<<TcpClient<'d, N, TX_SZ, RX_SZ> as TcpConnect>::Connection<'a>, <TcpClient<'d, N, TX_SZ, RX_SZ> as TcpConnect>::Error>

Connect to the given remote host and port.