mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-03 09:01:54 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

spa: utils: hook: add comments and fix code in documentation

Browse source 
Extend the examples with comments and fix issues in the code.
This commit is contained in:
Barnabás Pőcze 2022-03-11 21:14:19 +01:00
parent 344cacd24a
commit 25980f947f
1 changed files with 17 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

25
spa/include/spa/utils/hook.h
View file

@ -261,8 +261,10 @@ struct spa_interface {
* The below (pseudo)code is a minimal example outlining the use of hooks: * The below (pseudo)code is a minimal example outlining the use of hooks:
* \code{.c} * \code{.c}
* // the public interface * // the public interface
* #define VERSION_BAR_EVENTS 0 // version of the vtable
* struct bar_events { * struct bar_events {
* uint32_t version; * uint32_t version; // NOTE: an integral member named `version`
* // must be present in the vtable
* void (*boom)(void *data, const char *msg); * void (*boom)(void *data, const char *msg);
* }; * };
* *
@ -272,17 +274,23 @@ struct spa_interface {
* }; * };
* *
* void party_add_event_listener(struct party *p, struct spa_hook *listener, * void party_add_event_listener(struct party *p, struct spa_hook *listener,
* struct bar_events *events, void *data) * const struct bar_events *events, void *data)
* { * {
* spa_hook_list_append(&p->bar_list, listener, events, data); * spa_hook_list_append(&p->bar_list, listener, events, data);
* } * }
* *
* static void party_on(struct party *p) * static void party_on(struct party *p)
* { * {
* spa_hook_list_call(&p->list, struct bar_events, * // NOTE: this is a macro, it evaluates to an integer,
* boom, // function name * // which is the number of hooks called
* 0 // hardcoded version, * spa_hook_list_call(&p->list,
* "party on, wayne"); * struct bar_events, // vtable type
* boom, // function name
* 0, // hardcoded version,
* // usually the version in which `boom`
* // has been added to the vtable
* "party on, wayne" // function argument(s)
* );
* } * }
* \endcode * \endcode
* *
@ -293,7 +301,8 @@ struct spa_interface {
* printf("%s", msg); * printf("%s", msg);
* } * }
* *
* static const struct bar_events { * static const struct bar_events events = {
* .version = VERSION_BAR_EVENTS, // version of the implemented interface
* .boom = boom_cb, * .boom = boom_cb,
* }; * };
* *
@ -302,7 +311,7 @@ struct spa_interface {
* struct spa_hook hook; * struct spa_hook hook;
* struct party *p = start_the_party(); * struct party *p = start_the_party();
* *
* party_add_event_listener(p, &hook, boom_cb, userdata); * party_add_event_listener(p, &hook, &events, userdata);
* *
* mainloop(); * mainloop();
* return 0; * return 0;