mirror of
https://github.com/systemd/systemd
synced 2024-09-06 16:56:43 +00:00
man: document sd_bus_flush_close_unref()
This commit is contained in:
parent
576af73f4a
commit
eda0d9a13b
|
@ -272,7 +272,14 @@ manpages = [
|
|||
'3',
|
||||
['sd_bus_negotiate_creds', 'sd_bus_negotiate_timestamp'],
|
||||
''],
|
||||
['sd_bus_new', '3', ['sd_bus_ref', 'sd_bus_unref', 'sd_bus_unrefp'], ''],
|
||||
['sd_bus_new',
|
||||
'3',
|
||||
['sd_bus_flush_close_unref',
|
||||
'sd_bus_flush_close_unrefp',
|
||||
'sd_bus_ref',
|
||||
'sd_bus_unref',
|
||||
'sd_bus_unrefp'],
|
||||
''],
|
||||
['sd_bus_path_encode',
|
||||
'3',
|
||||
['sd_bus_path_decode', 'sd_bus_path_decode_many', 'sd_bus_path_encode_many'],
|
||||
|
|
|
@ -23,6 +23,8 @@
|
|||
<refname>sd_bus_ref</refname>
|
||||
<refname>sd_bus_unref</refname>
|
||||
<refname>sd_bus_unrefp</refname>
|
||||
<refname>sd_bus_flush_close_unref</refname>
|
||||
<refname>sd_bus_flush_close_unrefp</refname>
|
||||
|
||||
<refpurpose>Create a new bus object and create or destroy references to it</refpurpose>
|
||||
</refnamediv>
|
||||
|
@ -50,6 +52,16 @@
|
|||
<funcdef>void <function>sd_bus_unrefp</function></funcdef>
|
||||
<paramdef>sd_bus **<parameter>busp</parameter></paramdef>
|
||||
</funcprototype>
|
||||
|
||||
<funcprototype>
|
||||
<funcdef>sd_bus *<function>sd_bus_flush_close_unref</function></funcdef>
|
||||
<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
|
||||
</funcprototype>
|
||||
|
||||
<funcprototype>
|
||||
<funcdef>void <function>sd_bus_flush_close_unrefp</function></funcdef>
|
||||
<paramdef>sd_bus **<parameter>busp</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
@ -111,6 +123,18 @@
|
|||
dereference its argument, which must not be <constant>NULL</constant>, and will
|
||||
execute no operation if <emphasis>that</emphasis> is <constant>NULL</constant>.
|
||||
</para>
|
||||
|
||||
<para><function>sd_bus_flush_close_unref()</function> is similar to <function>sd_bus_unref()</function>, but first
|
||||
executes <citerefentry><refentrytitle>sd_bus_flush</refentrytitle><manvolnum>3</manvolnum></citerefentry> as well
|
||||
as <citerefentry><refentrytitle>sd_bus_close</refentrytitle><manvolnum>3</manvolnum></citerefentry>, ensuring that
|
||||
any pending messages are properly flushed out before the reference to the connection is dropped and possibly the
|
||||
object freed. This call is particularly useful immediately before exiting from a program as it ensures that any
|
||||
pending outgoing messages are written out, and unprocessed but queued incoming messages released before the
|
||||
connection is terminated and released.</para>
|
||||
|
||||
<para><function>sd_bus_flush_close_unrefp()</function> is similar to
|
||||
<function>sd_bus_flush_close_unref()</function>, but may be used in GCC's and LLVM's Clean-up Variable Attribute,
|
||||
see above.</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
|
@ -123,7 +147,7 @@
|
|||
<para><function>sd_bus_ref()</function> always returns the argument.
|
||||
</para>
|
||||
|
||||
<para><function>sd_bus_unref()</function> always returns
|
||||
<para><function>sd_bus_unref()</function> and <function>sd_bus_flush_close_unref()</function> always return
|
||||
<constant>NULL</constant>.</para>
|
||||
</refsect1>
|
||||
|
||||
|
@ -152,7 +176,8 @@
|
|||
<citerefentry><refentrytitle>sd_bus_default_user</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_default_system</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_open_user</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_open_system</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
<citerefentry><refentrytitle>sd_bus_open_system</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
||||
<citerefentry><refentrytitle>sd_bus_close</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
Loading…
Reference in a new issue