mirror of
https://github.com/systemd/systemd
synced 2024-07-22 02:34:54 +00:00
sd-bus: sd_bus_set/get_method_call_timeout docs + cleanups.
This commit is contained in:
parent
b1d6fe7055
commit
cc46b9d913
|
@ -340,6 +340,10 @@ manpages = [
|
|||
'sd_bus_set_anonymous',
|
||||
'sd_bus_set_trusted'],
|
||||
''],
|
||||
['sd_bus_set_method_call_timeout',
|
||||
'3',
|
||||
['sd_bus_get_method_call_timeout'],
|
||||
''],
|
||||
['sd_bus_set_sender', '3', ['sd_bus_get_sender'], ''],
|
||||
['sd_bus_set_watch_bind', '3', ['sd_bus_get_watch_bind'], ''],
|
||||
['sd_bus_slot_ref',
|
||||
|
|
|
@ -55,6 +55,7 @@
|
|||
<citerefentry><refentrytitle>sd_bus_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_error_add_map</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_get_method_call_timeout</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_get_n_queued_read</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_message_append_array</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
|
@ -87,6 +88,7 @@
|
|||
<citerefentry><refentrytitle>sd_bus_request_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_set_connected_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_set_method_call_timeout</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_set_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_set_watch_bind</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
<citerefentry><refentrytitle>sd_bus_set_close_on_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
|
|
|
@ -81,15 +81,8 @@
|
|||
on the reply object returned by <function>sd_bus_call()</function> or passed to the callback of
|
||||
<function>sd_bus_call_async()</function>.</para>
|
||||
|
||||
<para>If <parameter>usec</parameter> is zero, the timeout set using
|
||||
<citerefentry><refentrytitle>sd_bus_set_method_call_timeout</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
is used. If no method call timeout was set, the timeout is read from the
|
||||
<varname>$SYSTEMD_BUS_TIMEOUT</varname> environment variable. If this environment variable is
|
||||
unset or does not contain a valid timeout, the implementation falls back to a predefined method
|
||||
call timeout of 25 seconds. Note that <varname>$SYSTEMD_BUS_TIMEOUT</varname> is read once and
|
||||
cached so callers should not rely on being able to change the default method call timeout at
|
||||
runtime by changing the value of <varname>$SYSTEMD_BUS_TIMEOUT</varname>. Instead, call
|
||||
<function>sd_bus_set_method_call_timeout()</function> to change the default method call timeout.
|
||||
<para>If <parameter>usec</parameter> is zero, the default D-Bus method call timeout is used. See
|
||||
<citerefentry><refentrytitle>sd_bus_get_method_call_timeout</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
|
||||
</para>
|
||||
|
||||
</refsect1>
|
||||
|
|
|
@ -116,8 +116,8 @@
|
|||
<refsect1>
|
||||
<title>Return Value</title>
|
||||
|
||||
<para>On success, these functions return 0 or a positive integer. On failure, they return a negative
|
||||
errno-style error code.</para>
|
||||
<para>On success, these functions return a non-negative integer. On failure, they return a
|
||||
negative errno-style error code.</para>
|
||||
|
||||
<refsect2>
|
||||
<title>Errors</title>
|
||||
|
|
104
man/sd_bus_set_method_call_timeout.xml
Normal file
104
man/sd_bus_set_method_call_timeout.xml
Normal file
|
@ -0,0 +1,104 @@
|
|||
<?xml version='1.0'?>
|
||||
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
||||
<!-- SPDX-License-Identifier: LGPL-2.1+ -->
|
||||
|
||||
<refentry id="sd_bus_set_method_call_timeout" xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
|
||||
<refentryinfo>
|
||||
<title>sd_bus_set_method_call_timeout</title>
|
||||
<productname>systemd</productname>
|
||||
</refentryinfo>
|
||||
|
||||
<refmeta>
|
||||
<refentrytitle>sd_bus_set_method_call_timeout</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>sd_bus_set_method_call_timeout</refname>
|
||||
<refname>sd_bus_get_method_call_timeout</refname>
|
||||
|
||||
<refpurpose>Set or query the default D-Bus method call timeout of a bus object</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv>
|
||||
<funcsynopsis>
|
||||
<funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo>
|
||||
|
||||
<funcprototype>
|
||||
<funcdef>int <function>sd_bus_set_method_call_timeout</function></funcdef>
|
||||
<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
|
||||
<paramdef>uint64_t <parameter>usec</parameter></paramdef>
|
||||
</funcprototype>
|
||||
|
||||
<funcprototype>
|
||||
<funcdef>int <function>sd_bus_get_method_call_timeout</function></funcdef>
|
||||
<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
|
||||
<paramdef>uint64_t *<parameter>ret</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
|
||||
<para><function>sd_bus_set_method_call_timeout()</function> sets the default D-Bus method call
|
||||
timeout of <parameter>bus</parameter> to <parameter>usec</parameter> microseconds.</para>
|
||||
|
||||
<para><function>sd_bus_get_method_call_timeout()</function> queries the default D-Bus method
|
||||
call timeout of <parameter>bus</parameter>. If no method call timeout was set using
|
||||
<function>sd_bus_set_method_call_timeout()</function>, the timeout is read from the
|
||||
<varname>$SYSTEMD_BUS_TIMEOUT</varname> environment variable. If this environment variable is
|
||||
unset or does not contain a valid timeout, the implementation falls back to a predefined method
|
||||
call timeout of 25 seconds. Note that <varname>$SYSTEMD_BUS_TIMEOUT</varname> is read once and
|
||||
cached so callers should not rely on being able to change the default method call timeout at
|
||||
runtime by changing the value of <varname>$SYSTEMD_BUS_TIMEOUT</varname>. Instead, call
|
||||
<function>sd_bus_set_method_call_timeout()</function> to change the default method call timeout.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Return Value</title>
|
||||
|
||||
<para>On success, these functions return a non-negative integer. On failure, they return a
|
||||
negative errno-style error code.</para>
|
||||
|
||||
<refsect2>
|
||||
<title>Errors</title>
|
||||
|
||||
<para>Returned errors may indicate the following problems:</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><constant>-EINVAL</constant></term>
|
||||
|
||||
<listitem><para>The parameters <parameter>bus</parameter> or <parameter>ret</parameter>
|
||||
are <constant>NULL</constant>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><constant>-ENOPKG</constant></term>
|
||||
|
||||
<listitem><para>Bus object <parameter>bus</parameter> could not be resolved.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
</refsect2>
|
||||
</refsect1>
|
||||
|
||||
<xi:include href="libsystemd-pkgconfig.xml" />
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
|
||||
<para>
|
||||
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_message_seal</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
Loading…
Reference in a new issue