Struct pal_async::socket::PolledSocket

pub struct PolledSocket<T> { /* private fields */ }

A polled socket.

Implementations

impl<T: AsSockRef> PolledSocket<T>

pub fn new(driver: &(impl ?Sized + Driver), socket: T) -> Result<Self>

Creates a new polled socket.

pub fn into_inner(self) -> T

Extracts the inner socket.

impl<T> PolledSocket<T>

pub fn get(&self) -> &T

Gets a reference to the inner socket.

pub fn get_mut(&mut self) -> &mut T

Gets a mutable reference to the inner socket.

pub fn convert<T2: From<T>>(self) -> PolledSocket<T2>

Converts the inner socket type.

impl<T> PolledSocket<T>

pub fn poll_io<F, R>( &mut self, cx: &mut Context<'_>, slot: InterestSlot, events: PollEvents, f: F, ) -> Poll<Result<R>>

where F: FnMut(&mut Self) -> Result<R>,

Calls nonblocking operation f when the socket has least one event in events ready.

Uses interest slot slot to allow multiple concurrent operations.

If f returns Err(err) with err.kind() == io::ErrorKind::WouldBlock, then this re-polls the socket for readiness and returns Poll::Pending.

impl<T> PolledSocket<T>

where T: AsSockRef + Read + Write,

pub fn split(self) -> (ReadHalf<T>, WriteHalf<T>)

Splits the socket into a read and write half that can be used concurrently.

This is more flexible and efficient than [futures::io::AsyncReadExt::split], since it avoids holding a lock while calling into the kernel, and it provides access to the underlying socket for more advanced operations.

impl PolledSocket<Socket>

pub async fn connect(&mut self, addr: &SockAddr) -> Result<()>

Connects the socket to address addr.

impl PolledSocket<UnixStream>

pub async fn connect_unix( driver: &(impl ?Sized + Driver), addr: impl AsRef<Path>, ) -> Result<Self>

Creates a new connected Unix stream socket.

impl PolledSocket<Socket>

pub fn listen(&self, backlog: i32) -> Result<()>

Listens for incoming connections.

impl<T: Listener> PolledSocket<T>

pub fn poll_accept( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<(T::Socket, T::Address)>>

Polls for a new connection.

pub async fn accept(&mut self) -> Result<(T::Socket, T::Address)>

Accepts a new connection.

Trait Implementations

impl<T: AsSockRef + Read> AsyncRead for PolledSocket<T>

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<T: AsSockRef + Write> AsyncWrite for PolledSocket<T>

fn poll_write( self: Pin<&mut Self>, cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<T: AsSockRef> PollReady for PolledSocket<T>

fn poll_ready( &mut self, cx: &mut Context<'_>, events: PollEvents, ) -> Poll<PollEvents>

Polls an object for readiness.