Struct libpulse_glib_binding::Mainloop

pub struct Mainloop {
    pub _inner: Rc<MainloopInner<MainloopInternal>>,
}

This acts as a safe interface to the internal PA Mainloop.

The mainloop object pointers are further enclosed here in a ref counted wrapper, allowing this outer wrapper to have clean methods for creating event objects, which can cleanly pass a copy of the inner ref counted mainloop object to them. Giving this to events serves two purposes, firstly because they need the API pointer, secondly, it ensures that event objects do not outlive the mainloop object.

Fields

_inner: Rc<MainloopInner<MainloopInternal>>

The ref-counted inner data

Methods

impl Mainloop

fn new(context: Option<&mut GMainContext>) -> Option<Self>

Create a new GLIB main loop object for the specified GLIB main loop context.

Takes an argument context for the GMainContext to use. If context is None the default context is used.

This returns the object in an Rc wrapper, allowing multiple references to be held, which allows event objects to hold one, thus ensuring they do not outlive it.

fn get_api(&self) -> *mut MainloopApi

Return the abstract main loop abstraction layer vtable for this main loop.

No need to free the API as it is owned by the loop and is destroyed when the loop is freed.

Talking to PA directly with C requires fetching this pointer explicitly via this function. This is actually unecessary through this binding. The pointer is retrieved automatically upon Mainloop creation, stored internally, and automatically obtained from it by functions that need it.

Trait Implementations

impl Mainloop for Mainloop

type MI = MainloopInner<MainloopInternal>

fn inner(&self) -> Rc<MainloopInner<MainloopInternal>>

fn new_io_event(
    &self,
    fd: i32,
    events: u32,
    cb: (extern "C" fn(*mut MainloopApi, *mut pa_io_event, i32, u32, *mut c_void), *mut c_void)
) -> Option<IoEvent<Self::MI>>

Create a new IO event

fn new_timer_event(
    &self,
    tv: &timeval,
    cb: (extern "C" fn(*mut pa_mainloop_api, *mut pa_time_event, *const timeval, *mut c_void), *mut c_void)
) -> Option<TimeEvent<Self::MI>>

Create a new timer event

fn new_deferred_event(
    &self,
    cb: (extern "C" fn(*mut MainloopApi, *mut pa_defer_event, *mut c_void), *mut c_void)
) -> Option<DeferEvent<Self::MI>>

Create a new deferred event

fn set_api_userdata(&self, userdata: *mut c_void)

Set the userdata pointer held in the api vtable object

fn get_api_userdata(&self) -> *mut c_void

Get the userdata pointer held in the api vtable object

fn quit(&self, retval: i32)

Call quit