mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-20 06:59:58 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
pipewire/spa/include/spa/utils/result.h

63 lines
1.2 KiB
C
Raw Normal View History

treewide: use SPDX tags to specify copyright information SPDX tags make the licensing information easy to understand and clear, and they are machine parseable. See https://spdx.dev for more information.
2023-02-08 18:12:00 +01:00
/* Simple Plugin API */
/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
/* SPDX-License-Identifier: MIT */
node: improve async handling Remove the done and error callbacks. The error callback is in an error message. The done callback is replace with spa_pending. Make enum_params take a callback and data for the results. This allows us to push the results one after another to the app and avoids ownership issues of the passed data. We can then extend this to handle the async case by doing a _wait call with a spa_pending+callback+data that will be called when the _enum_params returns and async result. Add a sync method. All methods can now return SPA_RESULT_IS_ASYNC return values and you can use spa_node_wait() to register a callback when they complete with optional extra parameters. This makes it easier to sync and handle the reply. Make helper methods to simulate the sync enum_params behaviour for sync nodes. Let the transport generate the sequence number for pw_resource_sync() and pw_proxy_sync(). That way we don't need to keep track of numbers ourselves and we can match the reply to the request easily.
2019-02-20 17:51:05 +01:00
#ifndef SPA_UTILS_RESULT_H
#define SPA_UTILS_RESULT_H
#ifdef __cplusplus
extern "C" {
#endif
spa: group the spa headers into doxygen modules Subdirectories buffer, control, debug, monitor, pod, support and utils, others are still missing. Headers are grouped either per subdirectory (e.g. buffer/ gets added to group spa_buffer) or per-file (e.g. spa_json is a separate group), whatever seemed like the most sensible approach.
2021-05-21 14:03:07 +10:00
/**
doc: reorganize Doxygen groups/modules to make more sense The Doxygen "Modules" page is not very illuminative, as different parts of the API are mixed together and not all parts are included. Try to address this: Put all parts of the public API to some Doxygen group, usually one group per header file. Use short, systematic names. Make these groups sub-groups of a few top-level groups, roughly corresponding to the different logical parts of the API (core, impl, stream, filter, spa, utilities).
2021-10-02 20:55:53 +03:00
* \defgroup spa_result Result handling
doc: add brief explanations for all groups
2021-10-04 00:00:41 +03:00
* Asynchronous result utilities
doc: reorganize Doxygen groups/modules to make more sense The Doxygen "Modules" page is not very illuminative, as different parts of the API are mixed together and not all parts are included. Try to address this: Put all parts of the public API to some Doxygen group, usually one group per header file. Use short, systematic names. Make these groups sub-groups of a few top-level groups, roughly corresponding to the different logical parts of the API (core, impl, stream, filter, spa, utilities).
2021-10-02 20:55:53 +03:00
*/
/**
* \addtogroup spa_result
spa: group the spa headers into doxygen modules Subdirectories buffer, control, debug, monitor, pod, support and utils, others are still missing. Headers are grouped either per subdirectory (e.g. buffer/ gets added to group spa_buffer) or per-file (e.g. spa_json is a separate group), whatever seemed like the most sensible approach.
2021-05-21 14:03:07 +10:00
* \{
*/
spa: add some more functions
2024-11-26 12:21:05 +01:00
#include <errno.h>
node: improve async handling Remove the done and error callbacks. The error callback is in an error message. The done callback is replace with spa_pending. Make enum_params take a callback and data for the results. This allows us to push the results one after another to the app and avoids ownership issues of the passed data. We can then extend this to handle the async case by doing a _wait call with a spa_pending+callback+data that will be called when the _enum_params returns and async result. Add a sync method. All methods can now return SPA_RESULT_IS_ASYNC return values and you can use spa_node_wait() to register a callback when they complete with optional extra parameters. This makes it easier to sync and handle the reply. Make helper methods to simulate the sync enum_params behaviour for sync nodes. Let the transport generate the sequence number for pw_resource_sync() and pw_proxy_sync(). That way we don't need to keep track of numbers ourselves and we can match the reply to the request easily.
2019-02-20 17:51:05 +01:00
#include <spa/utils/defs.h>
spa: add some more functions
2024-11-26 12:21:05 +01:00
#ifndef SPA_API_RESULT
#ifdef SPA_API_IMPL
#define SPA_API_RESULT SPA_API_IMPL
#else
#define SPA_API_RESULT static inline
#endif
#endif
node: improve async handling Remove the done and error callbacks. The error callback is in an error message. The done callback is replace with spa_pending. Make enum_params take a callback and data for the results. This allows us to push the results one after another to the app and avoids ownership issues of the passed data. We can then extend this to handle the async case by doing a _wait call with a spa_pending+callback+data that will be called when the _enum_params returns and async result. Add a sync method. All methods can now return SPA_RESULT_IS_ASYNC return values and you can use spa_node_wait() to register a callback when they complete with optional extra parameters. This makes it easier to sync and handle the reply. Make helper methods to simulate the sync enum_params behaviour for sync nodes. Let the transport generate the sequence number for pw_resource_sync() and pw_proxy_sync(). That way we don't need to keep track of numbers ourselves and we can match the reply to the request easily.
2019-02-20 17:51:05 +01:00
#define SPA_ASYNC_BIT (1 << 30)
#define SPA_ASYNC_SEQ_MASK (SPA_ASYNC_BIT - 1)
result: don't use undefined shift Use a different way to generate the upper bits of the ASYNC mask instead of undefined shift as warned by sanitizer Add some unit test for this See #497
2020-12-21 21:07:34 +01:00
#define SPA_ASYNC_MASK (~SPA_ASYNC_SEQ_MASK)
node: improve async handling Remove the done and error callbacks. The error callback is in an error message. The done callback is replace with spa_pending. Make enum_params take a callback and data for the results. This allows us to push the results one after another to the app and avoids ownership issues of the passed data. We can then extend this to handle the async case by doing a _wait call with a spa_pending+callback+data that will be called when the _enum_params returns and async result. Add a sync method. All methods can now return SPA_RESULT_IS_ASYNC return values and you can use spa_node_wait() to register a callback when they complete with optional extra parameters. This makes it easier to sync and handle the reply. Make helper methods to simulate the sync enum_params behaviour for sync nodes. Let the transport generate the sequence number for pw_resource_sync() and pw_proxy_sync(). That way we don't need to keep track of numbers ourselves and we can match the reply to the request easily.
2019-02-20 17:51:05 +01:00
#define SPA_RESULT_IS_OK(res) ((res) >= 0)
#define SPA_RESULT_IS_ERROR(res) ((res) < 0)
#define SPA_RESULT_IS_ASYNC(res) (((res) & SPA_ASYNC_MASK) == SPA_ASYNC_BIT)
#define SPA_RESULT_ASYNC_SEQ(res) ((res) & SPA_ASYNC_SEQ_MASK)
#define SPA_RESULT_RETURN_ASYNC(seq) (SPA_ASYNC_BIT | SPA_RESULT_ASYNC_SEQ(seq))
spa: add some more functions
2024-11-26 12:21:05 +01:00
SPA_API_RESULT const char *spa_strerror(int err)
{
int _err = -(err);
if (SPA_RESULT_IS_ASYNC(err))
_err = EINPROGRESS;
return strerror(_err);
}
fix includes
2019-10-25 15:01:02 +02:00
spa: group the spa headers into doxygen modules Subdirectories buffer, control, debug, monitor, pod, support and utils, others are still missing. Headers are grouped either per subdirectory (e.g. buffer/ gets added to group spa_buffer) or per-file (e.g. spa_json is a separate group), whatever seemed like the most sensible approach.
2021-05-21 14:03:07 +10:00
/**
* \}
*/
node: improve async handling Remove the done and error callbacks. The error callback is in an error message. The done callback is replace with spa_pending. Make enum_params take a callback and data for the results. This allows us to push the results one after another to the app and avoids ownership issues of the passed data. We can then extend this to handle the async case by doing a _wait call with a spa_pending+callback+data that will be called when the _enum_params returns and async result. Add a sync method. All methods can now return SPA_RESULT_IS_ASYNC return values and you can use spa_node_wait() to register a callback when they complete with optional extra parameters. This makes it easier to sync and handle the reply. Make helper methods to simulate the sync enum_params behaviour for sync nodes. Let the transport generate the sequence number for pw_resource_sync() and pw_proxy_sync(). That way we don't need to keep track of numbers ourselves and we can match the reply to the request easily.
2019-02-20 17:51:05 +01:00
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* SPA_UTILS_RESULT_H */
Reference in a new issue Copy permalink