PipeWire  0.3.33
main-loop.h
Go to the documentation of this file.
1 /* PipeWire
2  *
3  * Copyright © 2018 Wim Taymans
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice (including the next
13  * paragraph) shall be included in all copies or substantial portions of the
14  * Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  * DEALINGS IN THE SOFTWARE.
23  */
24 
25 #ifndef PIPEWIRE_MAIN_LOOP_H
26 #define PIPEWIRE_MAIN_LOOP_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
43 struct pw_main_loop;
44 
45 #include <pipewire/loop.h>
46 
49 #define PW_VERSION_MAIN_LOOP_EVENTS 0
50  uint32_t version;
51 
53  void (*destroy) (void *data);
54 };
55 
57 struct pw_main_loop *
58 pw_main_loop_new(const struct spa_dict *props);
59 
61 void pw_main_loop_add_listener(struct pw_main_loop *loop,
62  struct spa_hook *listener,
63  const struct pw_main_loop_events *events,
64  void *data);
65 
67 struct pw_loop * pw_main_loop_get_loop(struct pw_main_loop *loop);
68 
70 void pw_main_loop_destroy(struct pw_main_loop *loop);
71 
73 int pw_main_loop_run(struct pw_main_loop *loop);
74 
76 int pw_main_loop_quit(struct pw_main_loop *loop);
77 
82 #ifdef __cplusplus
83 }
84 #endif
85 
86 #endif /* PIPEWIRE_MAIN_LOOP_H */
pw_loop_new
struct pw_loop * pw_loop_new(const struct spa_dict *props)
Create a new loop.
Definition: loop.c:54
pw_main_loop_add_listener
void pw_main_loop_add_listener(struct pw_main_loop *loop, struct spa_hook *listener, const struct pw_main_loop_events *events, void *data)
Add an event listener.
Definition: main-loop.c:110
pw_main_loop_events::destroy
void(* destroy)(void *data)
Emitted when the main loop is destroyed.
Definition: main-loop.h:53
pw_loop_leave
#define pw_loop_leave(l)
Definition: src/pipewire/loop.h:69
loop.h
data
user data to add to an object
Definition: filter.c:75
pw_loop
Definition: src/pipewire/loop.h:47
SPA_EXPORT
#define SPA_EXPORT
Definition: defs.h:208
spa_hook_list_append
void spa_hook_list_append(struct spa_hook_list *list, struct spa_hook *hook, const void *funcs, void *data)
Append a hook.
Definition: hook.h:316
pw_main_loop_new
struct pw_main_loop * pw_main_loop_new(const struct spa_dict *props)
Create a new main loop.
Definition: main-loop.c:86
NAME
#define NAME
Definition: main-loop.c:29
props
const char * props
Definition: media-session.c:2382
pw_main_loop_get_loop
struct pw_loop * pw_main_loop_get_loop(struct pw_main_loop *loop)
Get the loop implementation.
Definition: main-loop.c:119
pw_loop_add_event
#define pw_loop_add_event(l,...)
Definition: src/pipewire/loop.h:75
pw_main_loop_run
int pw_main_loop_run(struct pw_main_loop *loop)
Start a main loop.
Definition: main-loop.c:145
spa_hook
A hook, contains the structure with functions and the data passed to the functions.
Definition: hook.h:295
pw_main_loop_events::version
uint32_t version
Definition: main-loop.h:50
spa_dict
Definition: utils/dict.h:48
pw_loop_signal_event
#define pw_loop_signal_event(l,...)
Definition: src/pipewire/loop.h:76
pw_main_loop_quit
int pw_main_loop_quit(struct pw_main_loop *loop)
Stop a main loop.
Definition: main-loop.c:131
spa_strerror
#define spa_strerror(err)
Definition: result.h:51
pw_log_debug
#define pw_log_debug(...)
Definition: src/pipewire/log.h:89
pw_loop_enter
#define pw_loop_enter(l)
Definition: src/pipewire/loop.h:67
main-loop.h
pw_loop_iterate
#define pw_loop_iterate(l,...)
Definition: src/pipewire/loop.h:68
pw_log_warn
#define pw_log_warn(...)
Definition: src/pipewire/log.h:87
pw_loop_destroy
void pw_loop_destroy(struct pw_loop *loop)
Destroy a loop.
Definition: loop.c:156
spa_hook_list_init
void spa_hook_list_init(struct spa_hook_list *list)
Initialize a hook list to the empty list.
Definition: hook.h:305
pw_loop::loop
struct spa_loop * loop
wrapped loop
Definition: src/pipewire/loop.h:49
pw_main_loop_events
Events of the main loop.
Definition: main-loop.h:48
log.h
spa_hook_list_clean
void spa_hook_list_clean(struct spa_hook_list *list)
Remove all hooks from the list.
Definition: hook.h:344
pw_main_loop_destroy
void pw_main_loop_destroy(struct pw_main_loop *loop)
Destroy a main loop.
Definition: main-loop.c:96