Struct libspa_sys::spa_loop_control_methods

#[repr(C)]
pub struct spa_loop_control_methods {
    pub version: u32,
    pub get_fd: Option<unsafe extern "C" fn(object: *mut c_void) -> c_int>,
    pub add_hook: Option<unsafe extern "C" fn(object: *mut c_void, hook: *mut spa_hook, hooks: *const spa_loop_control_hooks, data: *mut c_void)>,
    pub enter: Option<unsafe extern "C" fn(object: *mut c_void)>,
    pub leave: Option<unsafe extern "C" fn(object: *mut c_void)>,
    pub iterate: Option<unsafe extern "C" fn(object: *mut c_void, timeout: c_int) -> c_int>,
    pub check: Option<unsafe extern "C" fn(object: *mut c_void) -> c_int>,
}

Control an event loop

Fields

version: u32

get_fd: Option<unsafe extern "C" fn(object: *mut c_void) -> c_int>

add_hook: Option<unsafe extern "C" fn(object: *mut c_void, hook: *mut spa_hook, hooks: *const spa_loop_control_hooks, data: *mut c_void)>

Add a hook \param ctrl the control to change \param hooks the hooks to add

Adds hooks to the loop controlled by \a ctrl.

enter: Option<unsafe extern "C" fn(object: *mut c_void)>

Enter a loop \param ctrl the control

Start an iteration of the loop. This function should be called before calling iterate and is typically used to capture the thread that this loop will run in.

leave: Option<unsafe extern "C" fn(object: *mut c_void)>

Leave a loop \param ctrl the control

Ends the iteration of a loop. This should be called after calling iterate.

iterate: Option<unsafe extern "C" fn(object: *mut c_void, timeout: c_int) -> c_int>

Perform one iteration of the loop. \param ctrl the control \param timeout an optional timeout in milliseconds. 0 for no timeout, -1 for infinite timeout.

This function will block up to \a timeout milliseconds and then dispatch the fds with activity. The number of dispatched fds is returned.

check: Option<unsafe extern "C" fn(object: *mut c_void) -> c_int>

Check context of the loop \param ctrl the control

This function will check if the current thread is currently the one that did the enter call. Since version 1:1.

returns 1 on success, 0 or negative errno value on error.

Trait Implementations

impl Clone for spa_loop_control_methods

fn clone(&self) -> spa_loop_control_methods

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for spa_loop_control_methods

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

Formats the value using the given formatter.

impl PartialEq for spa_loop_control_methods

fn eq(&self, other: &spa_loop_control_methods) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for spa_loop_control_methods

impl Eq for spa_loop_control_methods

impl StructuralPartialEq for spa_loop_control_methods