man/sd_bus_pending_method_calls.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   5
   6 <refentry id="sd_bus_pending_method_calls"
   7           xmlns:xi="http://www.w3.org/2001/XInclude">
   8
   9   <refentryinfo>
  10     <title>sd_bus_pending_method_calls</title>
  11     <productname>systemd</productname>
  12   </refentryinfo>
  13
  14   <refmeta>
  15     <refentrytitle>sd_bus_pending_method_calls</refentrytitle>
  16     <manvolnum>3</manvolnum>
  17   </refmeta>
  18
  19   <refnamediv>
  20     <refname>sd_bus_pending_method_calls</refname>
  21
  22     <refpurpose>Return the number of currently pending, outgoing method calls</refpurpose>
  23   </refnamediv>
  24
  25   <refsynopsisdiv>
  26     <funcsynopsis>
  27       <funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>
  28
  29       <funcprototype>
  30         <funcdef>int <function>sd_bus_pending_method_calls</function></funcdef>
  31         <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
  32       </funcprototype>
  33
  34     </funcsynopsis>
  35   </refsynopsisdiv>
  36
  37   <refsect1>
  38     <title>Description</title>
  39
  40     <para><function>sd_bus_pending_method_calls()</function> returns the number of currently pending outgoing
  41     method calls, i.e. method calls enqueued with
  42     <citerefentry><refentrytitle>sd_bus_call_async</refentrytitle><manvolnum>3</manvolnum></citerefentry> for
  43     which no reply has been received yet, and which have not reached a timeout yet.</para>
  44
  45     <para>The <parameter>bus</parameter> argument may be <constant>NULL</constant>, in which case zero is
  46     returned.</para>
  47
  48   </refsect1>
  49
  50   <refsect1>
  51     <title>Return Value</title>
  52
  53     <para>This function returns 0 if there are no pending method calls, or a <constant>NULL</constant> bus
  54     object was specified. On failure, a negative errno-style error code is returned.</para>
  55
  56     <refsect2>
  57       <title>Errors</title>
  58
  59       <para>Returned errors may indicate the following problems:</para>
  60
  61       <variablelist>
  62         <varlistentry>
  63           <term><constant>-ECHILD</constant></term>
  64
  65           <listitem><para>The bus connection has been created in a different process, library or module instance.</para></listitem>
  66         </varlistentry>
  67       </variablelist>
  68     </refsect2>
  69   </refsect1>
  70
  71   <xi:include href="libsystemd-pkgconfig.xml" />
  72
  73   <refsect1>
  74     <title>History</title>
  75     <para><function>sd_bus_pending_method_calls()</function> was added in version 257.</para>
  76   </refsect1>
  77
  78   <refsect1>
  79     <title>See Also</title>
  80
  81     <para><simplelist type="inline">
  82       <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
  83       <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
  84       <member><citerefentry><refentrytitle>sd_bus_call_async</refentrytitle><manvolnum>3</manvolnum></citerefentry></member>
  85     </simplelist></para>
  86   </refsect1>
  87
  88 </refentry>