[−][src]Struct libpulse_binding::mainloop::standard::Mainloop
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
[src]
pub fn new() -> Option<Self>
[src]
Allocates a new main loop object.
pub fn prepare(&mut self, timeout: Option<i32>) -> Result<(), PAErr>
[src]
Prepares 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>
[src]
Executes the previously prepared poll.
pub fn dispatch(&mut self) -> Result<u32, PAErr>
[src]
Dispatchs timeout, IO and deferred events from the previously executed poll.
On success returns the number of source dispatched.
pub fn get_retval(&self) -> Retval
[src]
Gets the return value as specified with the main loop’s quit
routine.
pub fn iterate(&mut self, block: bool) -> IterateResult
[src]
Runs 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 IterateResult
variant:
- On success, returns
IterateResult::Success
containing the number of sources dispatched in this iteration. - If exit was requested, returns
IterateResult::Quit
containing quit’s retval. - On error, returns
IterateResult::Err
containing error value.
pub fn run(&mut self) -> Result<Retval, (PAErr, Retval)>
[src]
Runs 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 MainloopApi
[src]
Gets 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 unnecessary 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)
[src]
Shuts down the main loop with the specified return value.
pub fn wakeup(&mut self)
[src]
Interrupts a running poll (for threaded systems).
pub fn set_poll_func(&mut self, poll_cb: (PollFn, *mut c_void))
[src]
Changes the poll() implementation.
Trait Implementations
impl Mainloop for Mainloop
[src]
type MI = MainloopInner<MainloopInternal>
fn inner(&self) -> Rc<MainloopInner<MainloopInternal>>
[src]
fn new_io_event(
&mut self,
fd: i32,
events: IoEventFlagSet,
callback: Box<dyn FnMut(IoEventRef<Self::MI>, i32, IoEventFlagSet) + 'static>
) -> Option<IoEvent<Self::MI>>
[src]
&mut self,
fd: i32,
events: IoEventFlagSet,
callback: Box<dyn FnMut(IoEventRef<Self::MI>, i32, IoEventFlagSet) + 'static>
) -> Option<IoEvent<Self::MI>>
Creates a new IO event. Read more
fn new_timer_event(
&mut self,
tv: &UnixTs,
callback: Box<dyn FnMut(TimeEventRef<Self::MI>) + 'static>
) -> Option<TimeEvent<Self::MI>>
[src]
&mut self,
tv: &UnixTs,
callback: Box<dyn FnMut(TimeEventRef<Self::MI>) + 'static>
) -> Option<TimeEvent<Self::MI>>
Creates a new timer event. Read more
fn new_timer_event_rt(
&mut self,
t: MonotonicTs,
callback: Box<dyn FnMut(TimeEventRef<Self::MI>) + 'static>
) -> Option<TimeEvent<Self::MI>>
[src]
&mut self,
t: MonotonicTs,
callback: Box<dyn FnMut(TimeEventRef<Self::MI>) + 'static>
) -> Option<TimeEvent<Self::MI>>
Creates a new monotonic-based timer event. Read more
fn new_deferred_event(
&mut self,
callback: Box<dyn FnMut(DeferEventRef<Self::MI>) + 'static>
) -> Option<DeferEvent<Self::MI>>
[src]
&mut self,
callback: Box<dyn FnMut(DeferEventRef<Self::MI>) + 'static>
) -> Option<DeferEvent<Self::MI>>
Creates a new deferred event. Read more
fn once_event(&mut self, callback: Box<dyn FnMut() + 'static>)
[src]
Runs the specified callback once from the main loop using an anonymous defer event. Read more
fn quit(&mut self, retval: Retval)
[src]
Calls quit
impl MainloopSignals for Mainloop
[src]
fn init_signals(&mut self) -> Result<(), PAErr>
[src]
Initializes the UNIX signal subsystem and bind it to the specified main loop.
fn signals_done(&self)
[src]
Cleans up the signal subsystem.
Auto Trait Implementations
impl !Sync for Mainloop
impl !Send for Mainloop
impl Unpin for Mainloop
impl !RefUnwindSafe for Mainloop
impl UnwindSafe for Mainloop
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,