Struct VsockDeviceConnectionManager 

pub struct VsockDeviceConnectionManager<H: DeviceHal, T: DeviceTransport>(/* private fields */);

A high level interface for VirtIO socket (vsock) devices.

Implementations

impl<H: DeviceHal, T: DeviceTransport> VsockDeviceConnectionManager<H, T>

pub fn new(driver: VirtIOSocketDevice<H, T>) -> Self

Construct a new connection manager wrapping the given low-level VirtIO socket driver.

pub fn new_with_capacity( driver: VirtIOSocketDevice<H, T>, per_connection_buffer_capacity: u32, ) -> Self

Construct a new connection manager wrapping the given low-level VirtIO socket driver, with the given per-connection buffer capacity.

pub fn listen(&mut self, port: u32)

Allows incoming connections on the given port number.

pub fn unlisten(&mut self, port: u32)

Stops allowing incoming connections on the given port number.

pub fn send( &mut self, destination: VsockAddr, src_port: u32, buffer: &[u8], ) -> Result

Sends the buffer to the destination.

pub fn poll(&mut self) -> Result<Option<VsockEvent>>

Polls the vsock device to receive data or other updates.

pub fn recv( &mut self, peer: VsockAddr, src_port: u32, buffer: &mut [u8], ) -> Result<usize>

Reads data received from the given connection.

pub fn recv_buffer_available_bytes( &mut self, peer: VsockAddr, src_port: u32, ) -> Result<usize>

Returns the number of bytes in the receive buffer available to be read by recv.

When the available bytes is 0, it indicates that the receive buffer is empty and does not contain any data.

pub fn update_credit(&mut self, peer: VsockAddr, src_port: u32) -> Result

Sends a credit update to the given peer.

pub fn wait_for_event(&mut self) -> Result<VsockEvent>

Blocks until we get some event from the vsock device.

pub fn shutdown(&mut self, destination: VsockAddr, src_port: u32) -> Result

Requests to shut down the connection cleanly, telling the peer that we won’t send or receive any more data.

This returns as soon as the request is sent; you should wait until poll returns a VsockEventType::Disconnected event if you want to know that the peer has acknowledged the shutdown.

pub fn force_close(&mut self, destination: VsockAddr, src_port: u32) -> Result

Forcibly closes the connection without waiting for the peer.

Trait Implementations

impl<H: DeviceHal, T: DeviceTransport> VsockManager for VsockDeviceConnectionManager<H, T>

fn connect(&mut self, _destination: VsockAddr, _src_port: u32) -> Result

Sends a request to connect to the given destination on the driver side.

fn send(&mut self, dest: VsockAddr, src_port: u32, buffer: &[u8]) -> Result

Sends the buffer to the destination.

fn update_credit(&mut self, peer: VsockAddr, src_port: u32) -> Result

Sends a credit update to the given peer.

fn force_close(&mut self, dest: VsockAddr, src_port: u32) -> Result

Forcibly closes the connection without waiting for the peer.

fn listen(&mut self, port: u32)

Allows incoming connections on the given port number.

fn poll(&mut self) -> Result<Option<VsockEvent>>

Polls the vsock device to receive data or other updates.

fn local_cid(&self) -> u64

Returns the local CID, i.e. the CID of the guest on the driver side and the CID of the host on the device side.

fn shutdown(&mut self, dest: VsockAddr, src_port: u32) -> Result

Requests to shut down the connection cleanly, telling the peer that we won’t send or receive any more data.

fn recv( &mut self, peer: VsockAddr, src_port: u32, buffer: &mut [u8], ) -> Result<usize>

Reads data received from the given connection.

unsafe fn ack_interrupt(_ptr: *mut Self) -> InterruptStatus

Acknowledges an interrupt using a pointer to the VsockManager impl