Struct vhost_user_backend::VringEpollHandler

source · [−]

pub struct VringEpollHandler<S, V, B> { /* private fields */ }

Expand description

Epoll event handler to manage and process epoll events for registered file descriptor.

The VringEpollHandler structure provides interfaces to:

add file descriptors to be monitored by the epoll fd
remove registered file descriptors from the epoll fd
run the event loop to handle pending events on the epoll fd

Implementations

source

impl<S, V, B> VringEpollHandler<S, V, B>

source

pub fn send_exit_event(&self)

Send exit event to break the event loop.

source

impl<S, V, B> VringEpollHandler<S, V, B> where
 S: VhostUserBackend<V, B>,
 V: VringT<GuestMemoryAtomic<GuestMemoryMmap>>,
 B: Bitmap + 'static,

source

pub fn register_listener(
 &self,
 fd: RawFd,
 ev_type: EventSet,
 data: u64
) -> Result<()>

Register an event into the epoll fd.

When this event is later triggered, the backend implementation of handle_event will be called.

source

pub fn unregister_listener(
 &self,
 fd: RawFd,
 ev_type: EventSet,
 data: u64
) -> Result<()>

Unregister an event from the epoll fd.

If the event is triggered after this function has been called, the event will be silently dropped.

Trait Implementations

source

impl<S, V, B> AsRawFd for VringEpollHandler<S, V, B>

source

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor. Read more

Auto Trait Implementations

impl<S, V, B> RefUnwindSafe for VringEpollHandler<S, V, B> where
 B: RefUnwindSafe,
 S: RefUnwindSafe,
 V: RefUnwindSafe,

impl<S, V, B> Send for VringEpollHandler<S, V, B> where
 B: Send,
 S: Send,
 V: Send,

impl<S, V, B> Sync for VringEpollHandler<S, V, B> where
 B: Sync,
 S: Sync,
 V: Sync,

impl<S, V, B> Unpin for VringEpollHandler<S, V, B> where
 B: Unpin,
 S: Unpin,
 V: Unpin,

impl<S, V, B> UnwindSafe for VringEpollHandler<S, V, B> where
 B: UnwindSafe,
 S: UnwindSafe,
 V: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct vhost_user_backend::VringEpollHandler

Implementations

impl<S, V, B> VringEpollHandler<S, V, B>

pub fn send_exit_event(&self)

impl<S, V, B> VringEpollHandler<S, V, B> where
    S: VhostUserBackend<V, B>,
    V: VringT<GuestMemoryAtomic<GuestMemoryMmap<B>>>,
    B: Bitmap + 'static,

pub fn register_listener(
    &self,
    fd: RawFd,
    ev_type: EventSet,
    data: u64
) -> Result<()>

pub fn unregister_listener(
    &self,
    fd: RawFd,
    ev_type: EventSet,
    data: u64
) -> Result<()>

Trait Implementations

impl<S, V, B> AsRawFd for VringEpollHandler<S, V, B>

fn as_raw_fd(&self) -> RawFd

Auto Trait Implementations

impl<S, V, B> RefUnwindSafe for VringEpollHandler<S, V, B> where
    B: RefUnwindSafe,
    S: RefUnwindSafe,
    V: RefUnwindSafe,

impl<S, V, B> Send for VringEpollHandler<S, V, B> where
    B: Send,
    S: Send,
    V: Send,

impl<S, V, B> Sync for VringEpollHandler<S, V, B> where
    B: Sync,
    S: Sync,
    V: Sync,

impl<S, V, B> Unpin for VringEpollHandler<S, V, B> where
    B: Unpin,
    S: Unpin,
    V: Unpin,

impl<S, V, B> UnwindSafe for VringEpollHandler<S, V, B> where
    B: UnwindSafe,
    S: UnwindSafe,
    V: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where
U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Struct vhost_user_backend::VringEpollHandler

Implementations

impl<S, V, B> VringEpollHandler<S, V, B>

pub fn send_exit_event(&self)

impl<S, V, B> VringEpollHandler<S, V, B> where S: VhostUserBackend<V, B>, V: VringT<GuestMemoryAtomic<GuestMemoryMmap<B>>>, B: Bitmap + 'static,

pub fn register_listener( &self, fd: RawFd, ev_type: EventSet, data: u64) -> Result<()>

pub fn unregister_listener( &self, fd: RawFd, ev_type: EventSet, data: u64) -> Result<()>

Trait Implementations

impl<S, V, B> AsRawFd for VringEpollHandler<S, V, B>

fn as_raw_fd(&self) -> RawFd

Auto Trait Implementations

impl<S, V, B> RefUnwindSafe for VringEpollHandler<S, V, B> where B: RefUnwindSafe, S: RefUnwindSafe, V: RefUnwindSafe,

impl<S, V, B> Send for VringEpollHandler<S, V, B> where B: Send, S: Send, V: Send,

impl<S, V, B> Sync for VringEpollHandler<S, V, B> where B: Sync, S: Sync, V: Sync,

impl<S, V, B> Unpin for VringEpollHandler<S, V, B> where B: Unpin, S: Unpin, V: Unpin,

impl<S, V, B> UnwindSafe for VringEpollHandler<S, V, B> where B: UnwindSafe, S: UnwindSafe, V: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<S, V, B> VringEpollHandler<S, V, B> where
S: VhostUserBackend<V, B>,
V: VringT<GuestMemoryAtomic<GuestMemoryMmap<B>>>,
B: Bitmap + 'static,

pub fn register_listener(
&self,
fd: RawFd,
ev_type: EventSet,
data: u64
) -> Result<()>

pub fn unregister_listener(
&self,
fd: RawFd,
ev_type: EventSet,
data: u64
) -> Result<()>

impl<S, V, B> RefUnwindSafe for VringEpollHandler<S, V, B> where
B: RefUnwindSafe,
S: RefUnwindSafe,
V: RefUnwindSafe,

impl<S, V, B> Send for VringEpollHandler<S, V, B> where
B: Send,
S: Send,
V: Send,

impl<S, V, B> Sync for VringEpollHandler<S, V, B> where
B: Sync,
S: Sync,
V: Sync,

impl<S, V, B> Unpin for VringEpollHandler<S, V, B> where
B: Unpin,
S: Unpin,
V: Unpin,

impl<S, V, B> UnwindSafe for VringEpollHandler<S, V, B> where
B: UnwindSafe,
S: UnwindSafe,
V: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,