system/pipewire
system/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire synced 2024-10-06 16:09:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: move the error reporting blurb to the library page

Browse source 
Let's keep the daemon page higher-level and leave API behaviors
elsewhere.
This commit is contained in:
Peter Hutterer 2021-08-04 14:34:36 +10:00 committed by Wim Taymans
parent 710caf9d75
commit 3370a56e3e
2 changed files with 18 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
doc/pipewire-daemon.dox
View file

@ -142,23 +142,4 @@ more debugging. The format is:
can be separated by commas. Current categories are:
+ `connection`: to log connection messages
\subsection sec_errors Error reporting
Functions return either NULL with errno set or a negative int error
code when an error occurs. Error codes are used from the SPA plugin
library on which PipeWire is built.
Some functions might return asynchronously. The error code for such
functions is positive and SPA_RESULT_IS_ASYNC() will return true.
SPA_RESULT_ASYNC_SEQ() can be used to get the unique sequence number
associated with the async operation.
The object returning the async result code will have some way to
signal the completion of the async operation (with, for example, a
callback). The sequence number can be used to see which operation
completed.
*/

18
doc/pipewire-library.dox
View file

@ -220,5 +220,23 @@ data unless they can see the objects and connect to them.
PipeWire also exposes an API to implement the server side objects in
a graph.
## Error reporting
Functions return either NULL with errno set or a negative int error
code when an error occurs. Error codes are used from the SPA plugin
library on which PipeWire is built.
Some functions might return asynchronously. The error code for such
functions is positive and SPA_RESULT_IS_ASYNC() will return true.
SPA_RESULT_ASYNC_SEQ() can be used to get the unique sequence number
associated with the async operation.
The object returning the async result code will have some way to
signal the completion of the async operation (with, for example, a
callback). The sequence number can be used to see which operation
completed.
*/