PipeWire  1.0.0
thread-loop.h
Go to the documentation of this file.
1 /* PipeWire */
2 /* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
3 /* SPDX-License-Identifier: MIT */
4 
5 #ifndef PIPEWIRE_THREAD_LOOP_H
6 #define PIPEWIRE_THREAD_LOOP_H
7 
8 #ifdef __cplusplus
9 extern "C" {
10 #endif
11 
12 #include <pipewire/loop.h>
13 
80 struct pw_thread_loop;
81 
83 struct pw_thread_loop_events {
84 #define PW_VERSION_THREAD_LOOP_EVENTS 0
85  uint32_t version;
86 
88  void (*destroy) (void *data);
89 };
90 
92 struct pw_thread_loop *
93 pw_thread_loop_new(const char *name, const struct spa_dict *props);
94 
97 struct pw_thread_loop *
98 pw_thread_loop_new_full(struct pw_loop *loop, const char *name, const struct spa_dict *props);
99 
101 void pw_thread_loop_destroy(struct pw_thread_loop *loop);
102 
105  struct spa_hook *listener,
106  const struct pw_thread_loop_events *events,
107  void *data);
108 
111 
114 
117 
120 
123 
126 
129 int pw_thread_loop_timed_wait(struct pw_thread_loop *loop, int wait_max_sec);
130 
133 int pw_thread_loop_get_time(struct pw_thread_loop *loop, struct timespec *abstime, int64_t timeout);
134 
138 int pw_thread_loop_timed_wait_full(struct pw_thread_loop *loop, const struct timespec *abstime);
139 
141 void pw_thread_loop_signal(struct pw_thread_loop *loop, bool wait_for_accept);
142 
145 
148 
153 #ifdef __cplusplus
154 }
155 #endif
156 
157 #endif /* PIPEWIRE_THREAD_LOOP_H */
void pw_thread_loop_unlock(struct pw_thread_loop *loop)
Unlock the loop.
Definition: thread-loop.c:382
int pw_thread_loop_start(struct pw_thread_loop *loop)
Start the thread loop.
Definition: thread-loop.c:317
int pw_thread_loop_timed_wait(struct pw_thread_loop *loop, int wait_max_sec)
Release the lock and wait a maximum of 'wait_max_sec' seconds until some thread calls pw_thread_loop_...
Definition: thread-loop.c:446
void pw_thread_loop_add_listener(struct pw_thread_loop *loop, struct spa_hook *listener, const struct pw_thread_loop_events *events, void *data)
Add an event listener.
Definition: thread-loop.c:268
struct pw_thread_loop * pw_thread_loop_new(const char *name, const struct spa_dict *props)
Make a new thread loop with the given name and optional properties.
Definition: thread-loop.c:215
void pw_thread_loop_destroy(struct pw_thread_loop *loop)
Destroy a thread loop.
Definition: thread-loop.c:244
struct pw_loop * pw_thread_loop_get_loop(struct pw_thread_loop *loop)
Get the loop implementation of the thread loop.
Definition: thread-loop.c:278
int pw_thread_loop_get_time(struct pw_thread_loop *loop, struct timespec *abstime, int64_t timeout)
Get a struct timespec suitable for pw_thread_loop_timed_wait_full.
Definition: thread-loop.c:467
void pw_thread_loop_accept(struct pw_thread_loop *loop)
Signal all threads executing pw_thread_loop_signal with wait_for_accept.
Definition: thread-loop.c:508
void pw_thread_loop_stop(struct pw_thread_loop *loop)
Stop the thread loop.
Definition: thread-loop.c:350
void pw_thread_loop_lock(struct pw_thread_loop *loop)
Lock the loop.
Definition: thread-loop.c:370
bool pw_thread_loop_in_thread(struct pw_thread_loop *loop)
Check if inside the thread.
Definition: thread-loop.c:521
struct pw_thread_loop * pw_thread_loop_new_full(struct pw_loop *loop, const char *name, const struct spa_dict *props)
Make a new thread loop with the given loop, name and optional properties.
Definition: thread-loop.c:236
void pw_thread_loop_wait(struct pw_thread_loop *loop)
Release the lock and wait until some thread calls pw_thread_loop_signal.
Definition: thread-loop.c:422
int pw_thread_loop_timed_wait_full(struct pw_thread_loop *loop, const struct timespec *abstime)
Release the lock and wait up to abstime until some thread calls pw_thread_loop_signal.
Definition: thread-loop.c:490
void pw_thread_loop_signal(struct pw_thread_loop *loop, bool wait_for_accept)
Signal all threads waiting with pw_thread_loop_wait.
Definition: thread-loop.c:398
pipewire/loop.h
Definition: loop.h:31
struct spa_loop * loop
wrapped loop
Definition: loop.h:33
Thread loop events.
Definition: thread-loop.h:88
void(* destroy)(void *data)
the loop is destroyed
Definition: thread-loop.h:94
uint32_t version
Definition: thread-loop.h:91
Definition: dict.h:39
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:350