Struct MessagePipe

pub struct MessagePipe<M: RingMem>(/* private fields */);

An open vmbus pipe in message mode, which can send and receive datagrams.

Implementations

impl<M: RingMem> MessagePipe<M>

pub fn new(channel: RawAsyncChannel<M>) -> Result<Self>

Creates a new pipe from an open channel.

pub fn new_raw(channel: RawAsyncChannel<M>) -> Result<Self>

Creates a new raw pipe from an open channel.

A raw pipe has no additional framing and sends and receives vmbus packets directly. As a result, packet sizes will be rounded up to an 8-byte multiple.

pub fn split(&mut self) -> (MessageReadHalf<'_, M>, MessageWriteHalf<'_, M>)

Splits the pipe into read and write halves so that reads and writes may be concurrently issued.

pub async fn wait_write_ready(&mut self, send_size: usize) -> Result<()>

Waits for the outgoing ring buffer to have enough space to write a message of size send_size.

pub fn try_send(&mut self, buf: &[u8]) -> Result<()>

Tries to send a datagram, failing with io::ErrorKind::WouldBlock if there is not enough space in the ring.

pub fn try_send_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<()>

Tries to send a datagram, failing with io::ErrorKind::WouldBlock if there is not enough space in the ring.

Trait Implementations

impl<M: RingMem> AsyncRecv for MessagePipe<M>

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

Polls for an incoming datagram, which will be gathered into bufs.

impl<M: RingMem> AsyncSend for MessagePipe<M>

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

Polls to send a datagram given by bufs.

impl<M: RingMem> InspectMut for MessagePipe<M>

fn inspect_mut(&mut self, req: Request<'_>)

Inspects the object.