Struct pipewire::thread_loop::ThreadLoop

pub struct ThreadLoop { /* private fields */ }

A wrapper around the pipewire threaded loop interface. ThreadLoops are a higher level of abstraction around the loop interface. A ThreadLoop can be used to spawn a new thread that runs the wrapped loop.

Implementations

impl ThreadLoop

pub unsafe fn new( name: Option<&str>, properties: Option<&DictRef> ) -> Result<Self, Error>

Initialize Pipewire and create a new ThreadLoop with the given name and optional properties.

Safety

TODO

pub unsafe fn new_cstr( name: Option<&CStr>, properties: Option<&DictRef> ) -> Result<Self, Error>

Initialize Pipewire and create a new ThreadLoop with the given name as Cstr

Safety

TODO

pub fn downgrade(&self) -> WeakThreadLoop

pub fn as_raw_ptr(&self) -> *mut pw_thread_loop

pub fn loop_(&self) -> &LoopRef

pub fn lock(&self) -> ThreadLoopLockGuard<'_>

Lock the Loop

This ensures that the loop thread will not access objects associated with the loop while the lock is held, lock() can be used multiple times from the same thread.

The lock needs to be held whenever you call any PipeWire function that uses an object associated with this loop. Make sure to not hold on to the lock more than necessary though, as the threaded loop stops while the lock is held.

pub fn start(&self)

Start the ThreadLoop

pub fn stop(&self)

Stop the ThreadLoop

Stopping the ThreadLoop must be called without the lock

pub fn signal(&self, signal: bool)

Signal all threads waiting with wait()

pub fn wait(&self)

Release the lock and wait

Release the lock and wait until some thread calls signal()

pub fn timed_wait(&self, wait_max_sec: Duration)

Release the lock and wait a maximum of wait_max_sec seconds until some thread calls signal() or time out

pub fn get_time(&self, timeout: i64) -> TimeSpec

Get a timespec suitable for timed_wait_full()

pub fn timed_wait_full(&self, abstime: TimeSpec)

Release the lock and wait up to abs seconds until some thread calls signal(). Use get_time() to get a suitable timespec

pub fn accept(&self)

Signal all threads executing signal() with wait_for_accept

pub fn in_thread(&self)

Check if inside the thread

Trait Implementations

impl AsRef<LoopRef> for ThreadLoop

fn as_ref(&self) -> &LoopRef

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ThreadLoop

fn clone(&self) -> ThreadLoop

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ThreadLoop

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl IsLoopRc for ThreadLoop