Struct MainLoop 

pub struct MainLoop { /* private fields */ }

An event loop implementation. This event loop is used for communication with PipeWire, and provides a number of primitives for integration with applications and any other event loops or event sources they might have.

Many of these primitives are quite low-level, and it is also possible to use the main loop only for PipeWire-related events. This can be done by creating the MainLoop and invoking MainLoop::run on a separate thread. In this case, it is important to make sure that any access to common data structures is protected from concurrent access. The MainLoop::lock and MainLoop::unlock methods provide such a mechanism.

Implementations

impl MainLoop

pub fn new(props: &Properties) -> Option<MainLoop>

Create a new main loop.

pub fn run(&self)

Run the main loop. This takes over executation of the current thread until MainLoop::quit is invoked.

pub fn quit(&self)

Terminate execution of the main loop.

pub fn add_listener(&self, events: MainLoopEvents) -> HookId

Add a listener for main loop events.

pub fn remove_listener(&self, hook_id: HookId)

Remove a set of event listeners.

pub fn iterate(&self, timeout: Option<Duration>) -> Result<i32>

Run one iteration of the loop, returning if no events occurred in timeout time. A value of None signifies an infinite timeout. Returns the number of iterations performed.

pub fn lock(&self) -> Result<()>

Take the main loop lock, preventing it from running until the lock is released. The main loop takes this lock in each of its iterations.

pub fn unlock(&self) -> Result<()>

Release the main loop lock, allowing it to run again.

pub fn get_time(&self, timeout: Duration) -> Result<timespec>

Get the time corresponding to the specified timeout, which can be used with MainLoop::wait.

pub fn wait(&self, abstime: &timespec) -> Result<()>

Wait until the specified time or until signalled.

pub fn signal(&self, wait_for_accept: bool) -> Result<()>

Signal any threads waiting with MainLoop::wait to wake up.

pub fn accept(&self) -> Result<()>

Acknowledge a MainLoop::signal with wait_for_accept: true, allowing that thread to proceed.

pub fn add_io( &self, fd: RawFd, mask: Io, close: bool, func: Box<SourceIoFn>, ) -> Option<Source>

Add an I/O event source using the given fd.

pub fn update_io(&self, source: &mut Source, mask: Io) -> Result<i32>

Update the set of events of interest (given by mask).

pub fn add_idle(&self, enabled: bool, func: Box<SourceIdleFn>) -> Option<Source>

Add an idle event source (called after each iteration of the main loop).

pub fn enable_idle(&self, source: &mut Source, enabled: bool) -> Result<i32>

Enable or disable an idle event source.

pub fn add_event(&self, func: Box<SourceEventFn>) -> Option<Source>

Add a source which can be triggered using Self::signal_event.

pub fn signal_event(&self, source: &mut Source) -> Result<i32>

Signal a source added with Self::add_event.

pub fn add_timer(&self, func: Box<SourceTimerFn>) -> Option<Source>

Add a timer source.

pub fn update_timer( &self, source: &mut Source, value: &timespec, interval: Option<&timespec>, absolute: bool, ) -> Result<i32>

Update the timer interval of a timer source.

pub fn add_signal( &self, signal_number: i32, func: Box<SourceSignalFn>, ) -> Option<Source>

Add a source triggered by UNIX signals.

pub fn destroy_source(&self, source: Source)

Remove and destroy an event source.

pub fn set_name(&mut self, name: &str)

Set the main loop name.

Trait Implementations

impl Clone for MainLoop

fn clone(&self) -> MainLoop

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Refcounted for MainLoop

type WeakRef = WeakMainLoop

The type of a weak reference to the object

fn upgrade(this: &Self::WeakRef) -> Option<Self>

Try to convert a weak reference to a strong reference. If the underlying object isstill alive, returns a Some continaing the value. If the underlying object’s strong reference count dropped to zero, and was thus freed, this returns None.

fn downgrade(&self) -> Self::WeakRef

Create a weak reference to the object. This reference does not impact the object’s lifecycle, and merely allows us the option to try to retrieve the object using Self::upgrade().

impl Send for MainLoop

impl Sync for MainLoop