shaba/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-10-30 06:25:37 +03:00
Code
7b52dc7f4d
systemd/man/vtable-example.xml

56 lines
2.0 KiB
XML
Raw Normal View History

man: document sd_bus_add_{object,fallback}_vtable The interface provided by those two functions is huge, so this text could probably be made two or three times as long if all details were described. But I think it's a good start.
2019-04-21 23:39:30 +03:00
<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
Use https for freedesktop.org grep -l -r http:// | xargs sed -E -i s'#http://(.*).freedesktop.org#https://\1.freedesktop.org#'
2022-06-28 13:00:47 +03:00
"https://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
man: add licenses to all files that lack one Documentation is licensed under LGPL-2.1-or-later. Scripts are MIT to facilitate reuse. Examples are relicensed to CC0-1.0 to maximise copy-and-paste for users, with permission from authors.
2021-10-01 13:44:33 +03:00
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
man: document sd_bus_add_{object,fallback}_vtable The interface provided by those two functions is huge, so this text could probably be made two or three times as long if all details were described. But I think it's a good start.
2019-04-21 23:39:30 +03:00
<node>
<interface name="org.freedesktop.DBus.Peer">
<method name="Ping"/>
<method name="GetMachineId">
<arg type="s" name="machine_uuid" direction="out"/>
</method>
</interface>
<interface name="org.freedesktop.DBus.Introspectable">
<method name="Introspect">
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
2021-11-23 18:23:01 +03:00
<arg name="xml_data" type="s" direction="out"/>
man: document sd_bus_add_{object,fallback}_vtable The interface provided by those two functions is huge, so this text could probably be made two or three times as long if all details were described. But I think it's a good start.
2019-04-21 23:39:30 +03:00
</method>
</interface>
<interface name="org.freedesktop.DBus.Properties">
<method name="Get">
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
2021-11-23 18:23:01 +03:00
<arg name="interface_name" direction="in" type="s"/>
<arg name="property_name" direction="in" type="s"/>
man: document sd_bus_add_{object,fallback}_vtable The interface provided by those two functions is huge, so this text could probably be made two or three times as long if all details were described. But I think it's a good start.
2019-04-21 23:39:30 +03:00
<arg name="value" direction="out" type="v"/>
</method>
<method name="GetAll">
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
2021-11-23 18:23:01 +03:00
<arg name="interface_name" direction="in" type="s"/>
<arg name="props" direction="out" type="a{sv}"/>
man: document sd_bus_add_{object,fallback}_vtable The interface provided by those two functions is huge, so this text could probably be made two or three times as long if all details were described. But I think it's a good start.
2019-04-21 23:39:30 +03:00
</method>
<method name="Set">
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
2021-11-23 18:23:01 +03:00
<arg name="interface_name" direction="in" type="s"/>
<arg name="property_name" direction="in" type="s"/>
man: document sd_bus_add_{object,fallback}_vtable The interface provided by those two functions is huge, so this text could probably be made two or three times as long if all details were described. But I think it's a good start.
2019-04-21 23:39:30 +03:00
<arg name="value" direction="in" type="v"/>
</method>
<signal name="PropertiesChanged">
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
2021-11-23 18:23:01 +03:00
<arg type="s" name="interface_name"/>
man: document sd_bus_add_{object,fallback}_vtable The interface provided by those two functions is huge, so this text could probably be made two or three times as long if all details were described. But I think it's a good start.
2019-04-21 23:39:30 +03:00
<arg type="a{sv}" name="changed_properties"/>
<arg type="as" name="invalidated_properties"/>
</signal>
</interface>
<interface name="org.freedesktop.systemd.VtableExample">
<method name="Method1">
<arg type="s" direction="in"/>
<arg type="s" direction="out"/>
</method>
<method name="Method2">
<arg type="s" name="string" direction="in"/>
<arg type="o" name="path" direction="in"/>
<arg type="s" name="returnstring" direction="out"/>
<annotation name="org.freedesktop.DBus.Deprecated" value="true"/>
</method>
<property name="AutomaticStringProperty" type="s" access="readwrite">
</property>
<property name="AutomaticIntegerProperty" type="u" access="readwrite">
<annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal" value="invalidates"/>
</property>
</interface>
</node>
Copy Permalink