Struct VsockSocket 

pub struct VsockSocket { /* private fields */ }

A virtio sequential packet socket between a local and a remote host.

This is the vsock equivalent of std::net::UdpSocket.

Implementations

impl VsockSocket

pub fn bind<A: SockaddrLike>(addr: &A) -> Result<Self>

Bind to an address and listen for connections.

Analogous to std::net::UdpSocket::bind

pub fn bind_with_cid_port(cid: u32, port: u32) -> Result<Self>

Bind to a specified cid and port and listen for connections.

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

Receive a message from a remote host.

Analogous to std::net::UdpSocket::recv_from

Returns

The number of bytes read and the address of the remote host.

pub fn send_to<A: SockaddrLike>(&self, buf: &[u8], addr: &A) -> Result<usize>

Send a message to a remote host.

Analogous to std::net::UdpSocket::send_to

pub fn send_to_with_cid_port( &self, buf: &[u8], cid: u32, port: u32, ) -> Result<usize>

Send a message to a remote host with specified cid and port.

pub fn peer_addr(&self) -> Result<VsockAddr>

Virtio socket address of the remote peer associated with this connection.

pub fn local_addr(&self) -> Result<VsockAddr>

Virtio socket address of the local address associated with this connection.

pub fn try_clone(&self) -> Result<Self>

Create a new independently owned handle to the underlying socket.

pub fn set_read_timeout(&self, dur: Option<Duration>) -> Result<()>

Set the timeout on read operations.

pub fn set_write_timeout(&self, dur: Option<Duration>) -> Result<()>

Set the timeout on write operations.

pub fn take_error(&self) -> Result<Option<Error>>

Retrieve the latest error associated with the underlying socket.

pub fn connect<A: SockaddrLike>(&self, addr: &A) -> Result<()>

Open a connection to a remote host (you need to bind to an address with Self::bind first).

Allows you to send and receive messages from this host directly through Self::send and Self::recv.

Analogous to std::net::UdpSocket::connect

pub fn connect_with_cid_port(&self, cid: u32, port: u32) -> Result<()>

Open a connection to a remote host with specified cid and port (you need to bind to an address with Self::bind first).

Allows you to send and receive messages from this host directly through Self::send and Self::recv.

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

Send data to the connected remote host.

Analogous to std::net::UdpSocket::send

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

Receive data from the connected remote host.

Analogous to std::net::UdpSocket::recv

pub fn set_nonblocking(&self, nonblocking: bool) -> Result<()>

Move this stream in and out of nonblocking mode.

Trait Implementations

impl AsFd for VsockSocket

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for VsockSocket

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for VsockSocket

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromRawFd for VsockSocket

unsafe fn from_raw_fd(fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor.

impl IntoRawFd for VsockSocket

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.