Struct virtio_drivers::device::socket::VsockConnectionManager

pub struct VsockConnectionManager<H: Hal, T: Transport> { /* private fields */ }

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

This keeps track of multiple vsock connections.

Example

use virtio_drivers::device::socket::{VirtIOSocket, VsockAddr, VsockConnectionManager};

let mut socket = VsockConnectionManager::new(VirtIOSocket::<HalImpl, _>::new(transport)?);

// Start a thread to call `socket.poll()` and handle events.

let remote_address = VsockAddr { cid: 2, port: 42 };
let local_port = 1234;
socket.connect(remote_address, local_port)?;

// Wait until `socket.poll()` returns an event indicating that the socket is connected.

socket.send(remote_address, local_port, "Hello world".as_bytes())?;

socket.shutdown(remote_address, local_port)?;

Implementations

impl<H: Hal, T: Transport> VsockConnectionManager<H, T>

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

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

pub fn guest_cid(&self) -> u64

Returns the CID which has been assigned to this guest.

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 connect(&mut self, destination: VsockAddr, src_port: u32) -> Result

Sends a request to connect to the given destination.

This returns as soon as the request is sent; you should wait until poll returns a VsockEventType::Connected event indicating that the peer has accepted the connection before sending data.

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 currently available in the recv buffer.

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.

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.