Struct TcpSocket

pub struct TcpSocket { /* private fields */ }

A TCP socket resource.

The socket can be in one of the following states:

• unbound
• bind-in-progress
• bound (See note below)
• listen-in-progress
• listening
• connect-in-progress
• connected
• closed See https://github.com/WebAssembly/wasi-sockets/blob/main/TcpSocketOperationalSemantics.md for more information.

Note: Except where explicitly mentioned, whenever this documentation uses the term “bound” without backticks it actually means: in the bound state or higher. (i.e. bound, listen-in-progress, listening, connect-in-progress or connected)

In addition to the general error codes documented on the network::error-code type, TCP socket methods may always return error(invalid-state) when in the closed state. A TCP socket resource.

The socket can be in one of the following states:

• unbound
• bind-in-progress
• bound (See note below)
• listen-in-progress
• listening
• connect-in-progress
• connected
• closed See https://github.com/WebAssembly/wasi-sockets/blob/main/TcpSocketOperationalSemantics.md for more information.

Note: Except where explicitly mentioned, whenever this documentation uses the term “bound” without backticks it actually means: in the bound state or higher. (i.e. bound, listen-in-progress, listening, connect-in-progress or connected)

In addition to the general error codes documented on the network::error-code type, TCP socket methods may always return error(invalid-state) when in the closed state. A host TCP socket, plus associated bookkeeping.

Implementations

impl TcpSocket

pub fn new(family: AddressFamily) -> Result<Self>

Create a new socket in the given family.

impl TcpSocket

pub fn start_bind(&mut self, local_address: SocketAddr) -> Result<()>

pub fn finish_bind(&mut self) -> SocketResult<()>

pub fn start_connect(&mut self, remote_address: SocketAddr) -> SocketResult<()>

pub fn finish_connect(&mut self) -> SocketResult<(InputStream, OutputStream)>

pub fn start_listen(&mut self) -> SocketResult<()>

pub fn finish_listen(&mut self) -> SocketResult<()>

pub fn accept(&mut self) -> SocketResult<(Self, InputStream, OutputStream)>

pub fn local_address(&self) -> SocketResult<SocketAddr>

pub fn remote_address(&self) -> SocketResult<SocketAddr>

pub fn is_listening(&self) -> bool

pub fn address_family(&self) -> SocketAddressFamily

pub fn set_listen_backlog_size(&mut self, value: u32) -> SocketResult<()>

pub fn keep_alive_enabled(&self) -> SocketResult<bool>

pub fn set_keep_alive_enabled(&self, value: bool) -> SocketResult<()>

pub fn keep_alive_idle_time(&self) -> SocketResult<Duration>

pub fn set_keep_alive_idle_time( &mut self, duration: Duration, ) -> SocketResult<()>

pub fn keep_alive_interval(&self) -> SocketResult<Duration>

pub fn set_keep_alive_interval(&self, duration: Duration) -> SocketResult<()>

pub fn keep_alive_count(&self) -> SocketResult<u32>

pub fn set_keep_alive_count(&self, value: u32) -> SocketResult<()>

pub fn hop_limit(&self) -> SocketResult<u8>

pub fn set_hop_limit(&mut self, value: u8) -> SocketResult<()>

pub fn receive_buffer_size(&self) -> SocketResult<usize>

pub fn set_receive_buffer_size(&mut self, value: usize) -> SocketResult<()>

pub fn send_buffer_size(&self) -> SocketResult<usize>

pub fn set_send_buffer_size(&mut self, value: usize) -> SocketResult<()>

pub fn shutdown(&self, how: Shutdown) -> SocketResult<()>

Trait Implementations

impl Subscribe for TcpSocket

fn ready<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

An asynchronous function which resolves when this object’s readiness operation is ready.