diff options
| author | Miika Karanki <miika.karanki@vaisala.com> | 2021-11-23 16:23:01 +0100 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2021-11-23 19:46:56 +0100 |
| commit | 98503c6d0cae795be89efd74ccab821729c2143a (patch) | |
| tree | b18371ceabdc0beef3cfa8b52ada980a38f78ce4 /man/vtable-example.xml | |
| parent | docs: remove comment that makes githubs renderer very angry (diff) | |
| download | systemd-98503c6d0cae795be89efd74ccab821729c2143a.tar.xz systemd-98503c6d0cae795be89efd74ccab821729c2143a.zip | |
sd-bus: Fix standard method argument names
The argument names of methods under org.freedesktop.DBus.Properties and
org.freedesktop.DBus.Introspectable interfaces are specifies in D-Bus
specification[1]. They are:
org.freedesktop.DBus.Introspectable.Introspect (out STRING xml_data)
org.freedesktop.DBus.Properties.Get (in STRING interface_name,
in STRING property_name,
out VARIANT value);
org.freedesktop.DBus.Properties.Set (in STRING interface_name,
in STRING property_name,
in VARIANT value);
org.freedesktop.DBus.Properties.GetAll (in STRING interface_name,
out DICT<STRING,VARIANT> props);
sd-bus is using different argument names in the introspection document.
Usually this is not a problem but in case something tries to map the
argument names based on the introspection document to the position of
the arguments in the method call, then using names different than the
ones specified in the D-Bus specification is confusing.
So fix the names to match the D-Bus specification.
[1] https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-introspectable
Diffstat (limited to 'man/vtable-example.xml')
| -rw-r--r-- | man/vtable-example.xml | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/man/vtable-example.xml b/man/vtable-example.xml index dc5fac4f26..891b375a4b 100644 --- a/man/vtable-example.xml +++ b/man/vtable-example.xml @@ -10,26 +10,26 @@ </interface> <interface name="org.freedesktop.DBus.Introspectable"> <method name="Introspect"> - <arg name="data" type="s" direction="out"/> + <arg name="xml_data" type="s" direction="out"/> </method> </interface> <interface name="org.freedesktop.DBus.Properties"> <method name="Get"> - <arg name="interface" direction="in" type="s"/> - <arg name="property" direction="in" type="s"/> + <arg name="interface_name" direction="in" type="s"/> + <arg name="property_name" direction="in" type="s"/> <arg name="value" direction="out" type="v"/> </method> <method name="GetAll"> - <arg name="interface" direction="in" type="s"/> - <arg name="properties" direction="out" type="a{sv}"/> + <arg name="interface_name" direction="in" type="s"/> + <arg name="props" direction="out" type="a{sv}"/> </method> <method name="Set"> - <arg name="interface" direction="in" type="s"/> - <arg name="property" direction="in" type="s"/> + <arg name="interface_name" direction="in" type="s"/> + <arg name="property_name" direction="in" type="s"/> <arg name="value" direction="in" type="v"/> </method> <signal name="PropertiesChanged"> - <arg type="s" name="interface"/> + <arg type="s" name="interface_name"/> <arg type="a{sv}" name="changed_properties"/> <arg type="as" name="invalidated_properties"/> </signal> |