diff options
author | Yu Watanabe <watanabe.yu+github@gmail.com> | 2024-06-12 11:25:24 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-06-12 11:25:24 +0200 |
commit | f7da67db588e476443b00b16481ebcc2d50fbb6a (patch) | |
tree | 4ace9cdaa02366e3247b263b359b35dc8d7a1479 /man | |
parent | Merge pull request #32603 from YHNdnzj/install-basename (diff) | |
parent | bus-util: check sd_bus_pending_method_calls() when determining whether a serv... (diff) | |
download | systemd-f7da67db588e476443b00b16481ebcc2d50fbb6a.tar.xz systemd-f7da67db588e476443b00b16481ebcc2d50fbb6a.zip |
Merge pull request #32720 from poettering/hostnamed-no-varlink-exit-on-idle
hostnamed: exit-on-idle tweaks
Diffstat (limited to 'man')
-rw-r--r-- | man/rules/meson.build | 1 | ||||
-rw-r--r-- | man/sd_bus_pending_method_calls.xml | 88 |
2 files changed, 89 insertions, 0 deletions
diff --git a/man/rules/meson.build b/man/rules/meson.build index a9a2a25c0d..c3e1eefd8a 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -418,6 +418,7 @@ manpages = [ '3', ['sd_bus_path_decode', 'sd_bus_path_decode_many', 'sd_bus_path_encode_many'], ''], + ['sd_bus_pending_method_calls', '3', [], ''], ['sd_bus_process', '3', [], ''], ['sd_bus_query_sender_creds', '3', ['sd_bus_query_sender_privilege'], ''], ['sd_bus_reply_method_error', diff --git a/man/sd_bus_pending_method_calls.xml b/man/sd_bus_pending_method_calls.xml new file mode 100644 index 0000000000..063009cf94 --- /dev/null +++ b/man/sd_bus_pending_method_calls.xml @@ -0,0 +1,88 @@ +<?xml version='1.0'?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<!-- SPDX-License-Identifier: LGPL-2.1-or-later --> + +<refentry id="sd_bus_pending_method_calls" + xmlns:xi="http://www.w3.org/2001/XInclude"> + + <refentryinfo> + <title>sd_bus_pending_method_calls</title> + <productname>systemd</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>sd_bus_pending_method_calls</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + + <refnamediv> + <refname>sd_bus_pending_method_calls</refname> + + <refpurpose>Return the number of currently pending, outgoing method calls</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo> + + <funcprototype> + <funcdef>int <function>sd_bus_pending_method_calls</function></funcdef> + <paramdef>sd_bus *<parameter>bus</parameter></paramdef> + </funcprototype> + + </funcsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><function>sd_bus_pending_method_calls()</function> returns the number of currently pending outgoing + method calls, i.e. method calls enqueued with + <citerefentry><refentrytitle>sd_bus_call_async</refentrytitle><manvolnum>3</manvolnum></citerefentry> for + which no reply has been received yet, and which have not reached a time-out yet.</para> + + <para>The <parameter>bus</parameter> argument may be <constant>NULL</constant>, in which case zero is + returned.</para> + + </refsect1> + + <refsect1> + <title>Return Value</title> + + <para>This function returns 0 if there are no pending method calls, or a <constant>NULL</constant> bus + object was specified. On failure, a negative errno-style error code is returned.</para> + + <refsect2> + <title>Errors</title> + + <para>Returned errors may indicate the following problems:</para> + + <variablelist> + <varlistentry> + <term><constant>-ECHILD</constant></term> + + <listitem><para>The bus connection has been created in a different process, library or module instance.</para></listitem> + </varlistentry> + </variablelist> + </refsect2> + </refsect1> + + <xi:include href="libsystemd-pkgconfig.xml" /> + + <refsect1> + <title>History</title> + <para><function>sd_bus_pending_method_calls()</function> was added in version 257.</para> + </refsect1> + + <refsect1> + <title>See Also</title> + + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_call_async</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> + +</refentry> |