Struct TcpSocket 

pub struct TcpSocket { /* private fields */ }

Available on crate feature p3 only.

A TCP socket resource.

The socket can be in one of the following states:

• unbound
• bound (See note below)
• listening
• connecting
• connected
• closed See https://github.com/WebAssembly/WASI/blob/main/proposals/sockets/TcpSocketOperationalSemantics-0.3.0-draft.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, listening, connecting or connected)

WASI uses shared ownership semantics: the tcp-socket handle and all derived stream and future values reference a single underlying OS socket:

• Send/receive streams remain functional after the original tcp-socket handle is dropped.
• The stream returned by listen behaves similarly.
• Client sockets returned by tcp-socket::listen are independent and do not keep the listening socket alive.

The OS socket is closed only after the last handle is dropped. This model has observable effects; for example, it affects when the local port binding is released.

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

Trait Implementations

impl Pollable 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.