Struct libpulse_binding::mainloop::standard::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

pub fn new() -> Option<Self>

Allocate a new main loop object

pub fn prepare(&mut self, timeout: Option<i32>) -> Result<(), PAErr>

Prepare for a single iteration of the main loop.

Returns Err on error or exit request.

timeout specifies a maximum timeout for the subsequent poll, or None for blocking behaviour. Only positive values should be provided, negative values will have the same effect as None.

pub fn poll(&mut self) -> Result<u32, PAErr>

Execute the previously prepared poll.

pub fn dispatch(&mut self) -> Result<u32, PAErr>

Dispatch timeout, io and deferred events from the previously executed poll. On success returns the number of source dispatched.

pub fn get_retval(&self) -> Retval

Return the return value as specified with the main loop's quit routine.

pub fn iterate(&mut self, block: bool) -> InterateResult

Run a single iteration of the main loop.

This is a convenience function for prepare, poll and dispatch.

If block is true, block for events if none are queued.

Returns an InterateResult variant:

• On success, returns InterateResult::Success containing the number of sources dispatched in this iteration.
• If exit was requested, returns InterateResult::Quit containing quit's retval.
• On error, returns InterateResult::Err containing error value.

pub fn run(&mut self) -> Result<Retval, (PAErr, Retval)>

Run unlimited iterations of the main loop object until the main loop's quit routine is called.

On success, returns Ok containing quit's return value. On error returns Err containing a tuple of the error value and quit's return value.

pub fn get_api<'a>(&self) -> &'a 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.

pub fn quit(&mut self, retval: Retval)

Shutdown the main loop with the specified return value

pub fn wakeup(&mut self)

Interrupt a running poll (for threaded systems)

pub fn set_poll_func(&mut self, poll_cb: (PollFn, *mut c_void))

Change the poll() implementation

Trait Implementations

impl Mainloop for Mainloop

type MI = MainloopInner<MainloopInternal>

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

fn new_io_event(     &mut self,     fd: i32,     events: IoEventFlagSet,     cb: (IoEventCb, *mut c_void) ) -> Option<IoEvent<Self::MI>>

Create a new IO event

fn new_timer_event(     &mut self,     tv: &Timeval,     cb: (TimeEventCb, *mut c_void) ) -> Option<TimeEvent<Self::MI>>

Create a new timer event

fn new_deferred_event(     &mut self,     cb: (DeferEventCb, *mut c_void) ) -> Option<DeferEvent<Self::MI>>

Create a new deferred event

fn set_api_userdata(&mut 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(&mut self, retval: Retval)

Call quit