Struct vmm_vhost::FrontendServer

pub struct FrontendServer<S: Frontend> {
    pub(crate) sub_sock: Connection<BackendReq>,
    reply_ack_negotiated: bool,
    frontend: S,
}

Handles requests from a vhost-user backend connection by dispatching them to [Frontend] methods.

Fields

sub_sock: Connection<BackendReq>

reply_ack_negotiated: bool

frontend: S

Implementations

impl<S: Frontend> FrontendServer<S>

pub fn with_stream(backend: S) -> Result<(Self, SafeDescriptor)>

Create a FrontendServer that uses a Unix stream internally.

The returned SafeDescriptor is the client side of the stream and should be sent to the backend using BackendClient::set_slave_request_fd().

impl<S: Frontend> FrontendServer<S>

pub(crate) fn new( frontend: S, connection: Connection<BackendReq> ) -> Result<Self>

Create a server to handle requests from connection.

pub fn set_reply_ack_flag(&mut self, enable: bool)

Set the negotiation state of the VHOST_USER_PROTOCOL_F_REPLY_ACK protocol feature.

When the VHOST_USER_PROTOCOL_F_REPLY_ACK protocol feature has been negotiated, the “REPLY_ACK” flag will be set in the message header for every request message.

pub fn frontend_mut(&mut self) -> &mut S

Get the underlying frontend

pub fn handle_request(&mut self) -> Result<u64>

Process the next received request.

The caller needs to:

• serialize calls to this function
• decide what to do when errer happens
• optional recover from failure

fn check_msg_size( &self, hdr: &VhostUserMsgHeader<BackendReq>, size: usize, expected: usize ) -> Result<()>

fn check_attached_files( &self, hdr: &VhostUserMsgHeader<BackendReq>, files: &[File] ) -> Result<()>

fn extract_msg_body<T: Sized + VhostUserMsgValidator>( &self, hdr: &VhostUserMsgHeader<BackendReq>, size: usize, buf: &[u8] ) -> Result<T>

fn new_reply_header<T: Sized>( &self, req: &VhostUserMsgHeader<BackendReq> ) -> Result<VhostUserMsgHeader<BackendReq>>

fn send_reply( &mut self, req: &VhostUserMsgHeader<BackendReq>, res: &Result<u64> ) -> Result<()>

Trait Implementations

impl<S: Frontend> AsRawDescriptor for FrontendServer<S>

fn as_raw_descriptor(&self) -> RawDescriptor

Returns the underlying raw descriptor.

impl<S: Frontend> ReadNotifier for FrontendServer<S>

fn get_read_notifier(&self) -> &dyn AsRawDescriptor

Gets a descriptor that can be used in EventContext to wait for events to be available (e.g. to avoid receive_events blocking).