Struct libpulse_binding::mainloop::threaded::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() -> Option<Self>

Allocate a new threaded main loop object.

You have to call start before the event loop thread starts running.

fn start(&self) -> Result<(), i32>

Start the event loop thread.

fn stop(&self)

Terminate the event loop thread cleanly. Make sure to unlock the mainloop object before calling this function.

fn lock(&self)

Lock the event loop object, effectively blocking the event loop thread from processing events. You can use this to enforce exclusive access to all objects attached to the event loop. This lock is recursive. This function may not be called inside the event loop thread. Events that are dispatched from the event loop thread are executed with this lock held.

fn unlock(&self)

Unlock the event loop object, inverse of lock.

fn wait(&self)

Wait for an event to be signalled by the event loop thread. You can use this to pass data from the event loop thread to the main thread in a synchronized fashion. This function may not be called inside the event loop thread. Prior to this call the event loop object needs to be locked using lock. While waiting the lock will be released. Immediately before returning it will be acquired again. This function may spuriously wake up even without signal being called. You need to make sure to handle that!

fn signal(&self, wait_for_accept: bool)

Signal all threads waiting for a signalling event in wait. If wait_for_accept is non-zero, do not return before the signal was accepted by an accept call. While waiting for that condition the event loop object is unlocked.

fn accept(&self)

Accept a signal from the event thread issued with signal.

This call should only be used in conjunction with signal with wait_for_accept as true.

fn get_retval(&self) -> i32

Return the return value as specified with the main loop's quit routine (used internally by threaded mainloop).

fn get_api(&self) -> &mut MainloopApi

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

There is no need to free this object 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.

fn in_thread(&self) -> bool

Returns true when called from within the event loop thread.

fn set_name(&self, name: &str)

Sets the name of the thread.

Trait Implementations

impl Mainloop for Mainloop

type MI = MainloopInner<MainloopInternal>

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

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

Create a new IO event

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

Create a new timer event

fn new_deferred_event(
    &self,
    cb: (DeferEventCb, *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