From 78e9bb837c258ac0ec7712b3d612cc2f407e731e Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 12 Jun 2024 05:50:42 +0200 Subject: Merging upstream version 256. Signed-off-by: Daniel Baumann --- man/sd_bus_add_object.xml | 337 ++++++++++++++++++++-------------------------- 1 file changed, 145 insertions(+), 192 deletions(-) (limited to 'man/sd_bus_add_object.xml') diff --git a/man/sd_bus_add_object.xml b/man/sd_bus_add_object.xml index db667e3..4d14a7e 100644 --- a/man/sd_bus_add_object.xml +++ b/man/sd_bus_add_object.xml @@ -1,6 +1,6 @@ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> sd_bus_message_handler_t callback void *userdata + - - SD_BUS_VTABLE_CAPABILITY(capability) - + + SD_BUS_VTABLE_CAPABILITY(capability) + - - SD_BUS_VTABLE_START(flags) - - - SD_BUS_VTABLE_END - - - SD_BUS_METHOD_WITH_ARGS_OFFSET(member, - args, - result, - handler, - offset, - flags) - - - - SD_BUS_METHOD_WITH_ARGS(member, - args, - result, - handler, - flags) - - - - SD_BUS_METHOD_WITH_NAMES_OFFSET(member, - signature, - in_names, - result, - out_names, - handler, - offset, - flags) - - - - SD_BUS_METHOD_WITH_NAMES(member, - signature, - in_names, - result, - out_names, - handler, - flags) - - - - SD_BUS_METHOD_WITH_OFFSET(member, - signature, - result, - handler, - offset, - flags) - - - - SD_BUS_METHOD(member, - signature, - result, - handler, - flags) - - - - SD_BUS_SIGNAL_WITH_ARGS(member, - args, - flags) - - - - SD_BUS_SIGNAL_WITH_NAMES(member, - signature, - names, - flags) - - - - SD_BUS_SIGNAL(member, - signature, - flags) - - - - SD_BUS_WRITABLE_PROPERTY(member, - signature, - get, - set, - offset, - flags) - - - - SD_BUS_PROPERTY(member, - signature, - get, - offset, - flags) - - - - SD_BUS_PARAM(name) - - - SD_BUS_ARGS(...) - - - SD_BUS_RESULT(...) - - - SD_BUS_NO_ARGS - - - SD_BUS_NO_RESULT - - + + SD_BUS_VTABLE_START(flags) + + + SD_BUS_VTABLE_END + + + SD_BUS_METHOD_WITH_ARGS_OFFSET(member, + args, + result, + handler, + offset, + flags) + + + + SD_BUS_METHOD_WITH_ARGS(member, + args, + result, + handler, + flags) + + + + SD_BUS_METHOD_WITH_NAMES_OFFSET(member, + signature, + in_names, + result, + out_names, + handler, + offset, + flags) + + + + SD_BUS_METHOD_WITH_NAMES(member, + signature, + in_names, + result, + out_names, + handler, + flags) + + + + SD_BUS_METHOD_WITH_OFFSET(member, + signature, + result, + handler, + offset, + flags) + + + + SD_BUS_METHOD(member, + signature, + result, + handler, + flags) + + + + SD_BUS_SIGNAL_WITH_ARGS(member, + args, + flags) + + + + SD_BUS_SIGNAL_WITH_NAMES(member, + signature, + names, + flags) + + + + SD_BUS_SIGNAL(member, + signature, + flags) + + + + SD_BUS_WRITABLE_PROPERTY(member, + signature, + get, + set, + offset, + flags) + + + + SD_BUS_PROPERTY(member, + signature, + get, + offset, + flags) + + + + SD_BUS_PARAM(name) + + + SD_BUS_ARGS(...) + + + SD_BUS_RESULT(...) + + + SD_BUS_NO_ARGS + + + SD_BUS_NO_RESULT + @@ -377,10 +377,7 @@ combination of flags, see below. SD_BUS_METHOD_WITH_ARGS() is a shorthand for calling - SD_BUS_METHOD_WITH_ARGS_OFFSET() with an offset of zero. - - - + SD_BUS_METHOD_WITH_ARGS_OFFSET() with an offset of zero. @@ -406,10 +403,7 @@ Prefer using SD_BUS_METHOD_WITH_ARGS_OFFSET() and SD_BUS_METHOD_WITH_ARGS() over these macros as they allow specifying argument types and names next to each other which is less error-prone than first specifying all argument - types followed by specifying all argument names. - - - + types followed by specifying all argument names. @@ -423,9 +417,7 @@ args. If a signal has no parameters, pass SD_BUS_NO_ARGS to args. The elements at uneven indices describe the names of the signal's arguments. Parameter flags is - a combination of flags. See below for a complete example. - - + a combination of flags. See below for a complete example. @@ -445,10 +437,7 @@ Prefer using SD_BUS_SIGNAL_WITH_ARGS() over these macros as it allows specifying argument types and names next to each other which is less error-prone than first - specifying all argument types followed by specifying all argument names. - - - + specifying all argument types followed by specifying all argument names. @@ -473,17 +462,13 @@ SD_BUS_PROPERTY() is used to define a read-only property. - - - + SD_BUS_PARAM() Parameter names should be wrapped in this macro, see the example below. - - - + @@ -502,9 +487,7 @@ Mark this vtable entry as deprecated using the org.freedesktop.DBus.Deprecated annotation in introspection data. If specified for SD_BUS_VTABLE_START(), the annotation is applied to the - enclosing interface. - - + enclosing interface. @@ -512,9 +495,7 @@ Make this vtable entry hidden. It will not be shown in introspection data. If specified for SD_BUS_VTABLE_START(), all entries in the array are - hidden. - - + hidden. @@ -522,9 +503,7 @@ Mark this vtable entry as a method that will not return a reply using the org.freedesktop.DBus.Method.NoReply annotation in introspection data. - - - + @@ -543,9 +522,7 @@ true and means that the signal is emitted. SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION corresponds to invalidates and means that the signal is emitted, but the value is - not included in the signal. - - + not included in the signal. @@ -556,9 +533,7 @@ cannot be combined with SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE, and will not be shown in property listings by default (e.g. busctl introspect). This corresponds to the org.freedesktop.systemd1.Explicit annotation - in introspection data. - - + in introspection data. @@ -567,9 +542,7 @@ Mark this vtable method entry as processing sensitive data. When set, incoming method call messages and their outgoing reply messages are marked as sensitive using sd_bus_message_sensitive3, - so that they are erased from memory when freed. - - + so that they are erased from memory when freed. @@ -579,9 +552,7 @@ its associated handler functions is determined slightly differently: instead of adding the offset parameter of the entry to the user data pointer specified during vtable registration, the offset is passed directly, converted to a pointer, without taking the user data pointer specified during - vtable registration into account. - - + vtable registration into account. @@ -597,10 +568,7 @@ for information about capabilities. Note that vtable entries may be marked as unprivileged and the whole bus may be marked as - trusted, see the discussion of SD_BUS_VTABLE_UNPRIVILEGED below. - - - + trusted, see the discussion of SD_BUS_VTABLE_UNPRIVILEGED below. @@ -625,9 +593,7 @@ additional policy that may permit or deny connections, see "CONFIGURATION FILE" in dbus-daemon1. - - - + @@ -667,33 +633,25 @@ One of the required parameters is NULL or invalid. A reserved D-Bus interface was passed as the interface parameter. - - - + -ENOPKG - The bus cannot be resolved. - - + The bus cannot be resolved. -ECHILD - The bus was created in a different process, library or module instance. - - + The bus was created in a different process, library or module instance. -ENOMEM - Memory allocation failed. - - + Memory allocation failed. @@ -701,19 +659,14 @@ sd_bus_add_object_vtable() and sd_bus_add_fallback_vtable() have been both called for the same bus - object path, which is not allowed. - - + object path, which is not allowed. -EEXIST This vtable has already been registered for this - interface and path. - - - + interface and path. @@ -730,17 +683,17 @@ sd_bus_add_fallback(), sd_bus_add_object_vtable(), sd_bus_add_fallback_vtable(), and - sd_bus_add_filter() were added in version 246. + sd_bus_add_filter() were added in version 221. See Also - - sd-bus3, - busctl1, - sd_bus_emit_properties_changed3, - sd_bus_emit_object_added3 - + + sd-bus3 + busctl1 + sd_bus_emit_properties_changed3 + sd_bus_emit_object_added3 + -- cgit v1.2.3