1
0
mirror of https://github.com/systemd/systemd.git synced 2024-12-22 17:35:35 +03:00

sd-bus: Add sd_bus_slot_get_current_* docs

This commit is contained in:
Daan De Meyer 2020-03-28 23:19:58 +01:00 committed by Zbigniew Jędrzejewski-Szmek
parent a6c9f8fa6d
commit 45069c67ce
4 changed files with 98 additions and 16 deletions

View File

@ -352,10 +352,13 @@ manpages = [
''],
['sd_bus_set_sender', '3', ['sd_bus_get_sender'], ''],
['sd_bus_set_watch_bind', '3', ['sd_bus_get_watch_bind'], ''],
['sd_bus_slot_ref',
['sd_bus_slot_get_bus',
'3',
['sd_bus_slot_get_bus', 'sd_bus_slot_unref', 'sd_bus_slot_unrefp'],
['sd_bus_slot_get_current_handler',
'sd_bus_slot_get_current_message',
'sd_bus_slot_get_current_userdata'],
''],
['sd_bus_slot_ref', '3', ['sd_bus_slot_unref', 'sd_bus_slot_unrefp'], ''],
['sd_bus_slot_set_description', '3', ['sd_bus_slot_get_description'], ''],
['sd_bus_slot_set_destroy_callback',
'3',

View File

@ -96,7 +96,10 @@
<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>
<citerefentry><refentrytitle>sd_bus_set_close_on_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_slot_get_current_handler</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_slot_get_current_message</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_slot_get_current_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_slot_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_slot_set_destroy_callback</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_slot_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

View File

@ -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.2/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1+ -->
<refentry id="sd_bus_slot_get_bus" xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>sd_bus_slot_get_bus</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>sd_bus_slot_get_bus</refentrytitle>
<manvolnum>3</manvolnum>
</refmeta>
<refnamediv>
<refname>sd_bus_slot_get_bus</refname>
<refname>sd_bus_slot_get_current_handler</refname>
<refname>sd_bus_slot_get_current_message</refname>
<refname>sd_bus_slot_get_current_userdata</refname>
<refpurpose>Query information attached to a bus slot object</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>
<funcprototype>
<funcdef>sd_bus *<function>sd_bus_slot_get_bus</function></funcdef>
<paramdef>sd_bus_slot *<parameter>slot</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>sd_bus_message_handler_t <function>sd_bus_slot_get_current_handler</function>
</funcdef>
<paramdef>sd_bus_slot *<parameter>slot</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>sd_bus_message *<function>sd_bus_slot_get_current_message</function></funcdef>
<paramdef>sd_bus_slot *<parameter>slot</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>void *<function>sd_bus_slot_get_current_userdata</function></funcdef>
<paramdef>sd_bus_slot *<parameter>slot</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><function>sd_bus_slot_get_bus()</function> returns the bus object that message
<parameter>slot</parameter> is attached to.</para>
<para><function>sd_bus_slot_get_current_handler()</function>,
<function>sd_bus_slot_get_current_message()</function> and
<function>sd_bus_slot_get_current_userdata()</function> return the current handler, message and
userdata respectively of the bus <parameter>slot</parameter> is attached to if we're currently
executing the callback associated with <parameter>slot</parameter>.</para>
</refsect1>
<refsect1>
<title>Return Value</title>
<para><function>sd_bus_slot_get_bus()</function> always returns the bus object.</para>
<para>On success, <function>sd_bus_slot_get_current_handler()</function>,
<function>sd_bus_slot_get_current_message()</function> and
<function>sd_bus_slot_get_current_userdata()</function> return the requested object. On failure,
they return <constant>NULL</constant>.</para>
</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>,
</para>
</refsect1>
</refentry>

View File

@ -18,7 +18,6 @@
<refname>sd_bus_slot_ref</refname>
<refname>sd_bus_slot_unref</refname>
<refname>sd_bus_slot_unrefp</refname>
<refname>sd_bus_slot_get_bus</refname>
<refpurpose>Create and destroy references to a bus slot object</refpurpose>
</refnamediv>
@ -41,11 +40,6 @@
<funcdef>void <function>sd_bus_slot_unrefp</function></funcdef>
<paramdef>sd_bus_slot **<parameter>slotp</parameter></paramdef>
</funcprototype>
<funcprototype>
<funcdef>sd_bus *<function>sd_bus_slot_get_bus</function></funcdef>
<paramdef>sd_bus_slot *<parameter>m</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
@ -72,11 +66,7 @@
execute no operation if the passed in bus object address is
<constant>NULL</constant>. <function>sd_bus_slot_unrefp()</function> will first 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_slot_get_bus()</function> returns the bus object that message
<parameter>slot</parameter> is attached to.</para>
<emphasis>that</emphasis> is <constant>NULL</constant>.</para>
</refsect1>
<refsect1>
@ -85,8 +75,6 @@
<para><function>sd_bus_slot_ref()</function> always returns the argument.</para>
<para><function>sd_bus_slot_unref()</function> always returns <constant>NULL</constant>.</para>
<para><function>sd_bus_slot_get_bus()</function> always returns the bus object.</para>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />