summaryrefslogtreecommitdiff
path: root/man/org.freedesktop.systemd1.xml
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2022-10-17 14:23:04 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2022-10-17 15:00:53 +0200
commitf6cce15bb30af0d28670e443ced9db7f402f1404 (patch)
tree8f9533ff614783bc6690793a89c40dcfec85d38e /man/org.freedesktop.systemd1.xml
parent293b9aa3eb21d3eca4e34d9c6c42c7b6ab716bd9 (diff)
downloadsystemd-f6cce15bb30af0d28670e443ced9db7f402f1404.tar.gz
manager: add DumpUnitsMatchingPatternsByFileDescriptor()
Diffstat (limited to 'man/org.freedesktop.systemd1.xml')
-rw-r--r--man/org.freedesktop.systemd1.xml25
1 files changed, 16 insertions, 9 deletions
diff --git a/man/org.freedesktop.systemd1.xml b/man/org.freedesktop.systemd1.xml
index 6986ee8b03..2c9fa81e18 100644
--- a/man/org.freedesktop.systemd1.xml
+++ b/man/org.freedesktop.systemd1.xml
@@ -165,6 +165,8 @@ node /org/freedesktop/systemd1 {
DumpUnitsMatchingPatterns(in as patterns,
out s output);
DumpByFileDescriptor(out h fd);
+ DumpUnitsMatchingPatternsByFileDescriptor(in as patterns,
+ out h fd);
Reload();
@org.freedesktop.DBus.Method.NoReply("true")
Reexecute();
@@ -874,6 +876,8 @@ node /org/freedesktop/systemd1 {
<variablelist class="dbus-method" generated="True" extra-ref="DumpByFileDescriptor()"/>
+ <variablelist class="dbus-method" generated="True" extra-ref="DumpUnitsMatchingPatternsByFileDescriptor()"/>
+
<variablelist class="dbus-method" generated="True" extra-ref="Reload()"/>
<variablelist class="dbus-method" generated="True" extra-ref="Reexecute()"/>
@@ -1342,15 +1346,18 @@ node /org/freedesktop/systemd1 {
string guaranteed, and new fields may be added any time, and old fields removed. The general structure
may be rearranged drastically between releases. This is exposed by
<citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
- <command>dump</command> command. Similarly, <function>DumpUnitsMatchingPatterns()</function> returns the internal
- state of units whose names match the glob expressions specified in the <varname>patterns</varname>
- argument. The <function>DumpByFileDescriptor()</function> method is identical to
- <function>Dump()</function> but returns the data serialized into a file descriptor (the client should
- read the text data from it until hitting EOF). Given the size limits on D-Bus messages and the possibly
- large size of the returned string, <function>DumpByFileDescriptor()</function> is usually the
- preferable interface, since it ensures the data can be passed reliably from the service manager to the
- client. (Note though that <function>DumpByFileDescriptor()</function> cannot work when communicating
- with the service manager remotely, as file descriptors are strictly local to a system.)</para>
+ <command>dump</command> command. Similarly, <function>DumpUnitsMatchingPatterns()</function> returns
+ the internal state of units whose names match the glob expressions specified in the
+ <varname>patterns</varname> argument. The
+ <function>DumpByFileDescriptor()</function>/<function>DumpUnitsMatchingPatternsByFileDescriptor()</function>
+ methods are identical to <function>Dump()</function>/<function>DumpUnitsMatchingPatterns()</function>,
+ but return data serialized into a file descriptor (the client should read the text data from it until
+ hitting EOF). Given the size limits on D-Bus messages and the possibly large size of the returned
+ strings,
+ <function>DumpByFileDescriptor()</function>/<function>DumpUnitsMatchingPatternsByFileDescriptor()</function>
+ are usually the preferred interface, since it ensures the data can be passed reliably from the service
+ manager to the client. Note though that they cannot work when communicating with the service manager
+ remotely, as file descriptors are strictly local to a system.</para>
<para><function>Reload()</function> may be invoked to reload all unit files.</para>