PipeWire 0.2.5

thread-loop.h
Go to the documentation of this file.
1 /* PipeWire
2 * Copyright (C) 2015 Wim Taymans <wim.taymans@gmail.com>
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
13 *
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
18 */
19
20 #ifndef __PIPEWIRE_THREAD_LOOP_H__
21 #define __PIPEWIRE_THREAD_LOOP_H__
22
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27 #include <pipewire/loop.h>
28
90 struct pw_thread_loop;
91
93 struct pw_thread_loop_events {
94 #define PW_VERSION_THREAD_LOOP_EVENTS 0
95 uint32_t version;
96
98 void (*destroy) (void *data);
99 };
100
102 struct pw_thread_loop *
103 pw_thread_loop_new(struct pw_loop *loop, const char *name);
104
106 void pw_thread_loop_destroy(struct pw_thread_loop *loop);
107
109 void pw_thread_loop_add_listener(struct pw_thread_loop *loop,
110 struct spa_hook *listener,
111 const struct pw_thread_loop_events *events,
112 void *data);
113
115 struct pw_loop * pw_thread_loop_get_loop(struct pw_thread_loop *loop);
116
118 int pw_thread_loop_start(struct pw_thread_loop *loop);
119
121 void pw_thread_loop_stop(struct pw_thread_loop *loop);
122
124 void pw_thread_loop_lock(struct pw_thread_loop *loop);
125
127 void pw_thread_loop_unlock(struct pw_thread_loop *loop);
128
130 void pw_thread_loop_wait(struct pw_thread_loop *loop);
131
134 int pw_thread_loop_timed_wait(struct pw_thread_loop *loop, int wait_max_sec);
135
137 void pw_thread_loop_signal(struct pw_thread_loop *loop, bool wait_for_accept);
138
140 void pw_thread_loop_accept(struct pw_thread_loop *loop);
141
143 bool pw_thread_loop_in_thread(struct pw_thread_loop *loop);
144
145 #ifdef __cplusplus
146 }
147 #endif
148
149 #endif /* __PIPEWIRE_THREAD_LOOP_H__ */
pw_thread_loop::pw_thread_loop_start
int pw_thread_loop_start(struct pw_thread_loop *loop)
Start the thread to handle loop.
Definition: thread-loop.c:207
pw_thread_loop::pw_thread_loop_destroy
void pw_thread_loop_destroy(struct pw_thread_loop *loop)
Destroy a threaded loop.
Definition: thread-loop.c:148
pw_loop
PipeWire loop object provides an implementation of the spa loop interfaces.
Definition: loop.h:37
pw_thread_loop_events
Thread loop events.
Definition: thread-loop.h:93
pw_thread_loop
PipeWire threaded loop object.
pw_loop::loop
struct spa_loop * loop
wrapped loop
Definition: loop.h:38
pw_thread_loop::pw_thread_loop_wait
void pw_thread_loop_wait(struct pw_thread_loop *loop)
Wait for the loop thread to call pw_thread_loop_signal()
Definition: thread-loop.c:294
pw_thread_loop_events::destroy
void(* destroy)(void *data)
the loop is destroyed
Definition: thread-loop.h:98
pw_thread_loop::pw_thread_loop_in_thread
bool pw_thread_loop_in_thread(struct pw_thread_loop *loop)
Check if we are inside the thread of the loop.
Definition: thread-loop.c:344
pw_thread_loop::pw_thread_loop_timed_wait
int pw_thread_loop_timed_wait(struct pw_thread_loop *loop, int wait_max_sec)
Wait for the loop thread to call pw_thread_loop_signal() or time out.
Definition: thread-loop.c:310
loop.h
pw_thread_loop::pw_thread_loop_lock
void pw_thread_loop_lock(struct pw_thread_loop *loop)
Lock the mutex associated with loop.
Definition: thread-loop.c:249
pw_thread_loop::pw_thread_loop_unlock
void pw_thread_loop_unlock(struct pw_thread_loop *loop)
Unlock the mutex associated with loop.
Definition: thread-loop.c:260
pw_thread_loop::pw_thread_loop_signal
void pw_thread_loop_signal(struct pw_thread_loop *loop, bool wait_for_accept)
Signal the thread.
Definition: thread-loop.c:275
pw_thread_loop_get_loop
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:175
pw_thread_loop_add_listener
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:166
pw_thread_loop_events::version
uint32_t version
Definition: thread-loop.h:95
pw_thread_loop::pw_thread_loop_accept
void pw_thread_loop_accept(struct pw_thread_loop *loop)
Signal the loop thread waiting for accept with pw_thread_loop_signal()
Definition: thread-loop.c:331
pw_thread_loop::pw_thread_loop_new
struct pw_thread_loop * pw_thread_loop_new(struct pw_loop *loop, const char *name)
Create a new pw_thread_loop.
Definition: thread-loop.c:99
pw_thread_loop::pw_thread_loop_stop
void pw_thread_loop_stop(struct pw_thread_loop *loop)
Quit the loop and stop its thread.
Definition: thread-loop.c:229