From: Daan De Meyer <daan.j.demeyer@gmail.com>
Date: Sun, 19 Apr 2020 20:06:38 +0000 (+0200)
Subject: sd-bus: Add sd_bus_get_current_* docs
X-Git-Tag: v246-rc1~560
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=db5328e93174b91cbd753eee4e40acfa00624336;p=thirdparty%2Fsystemd.git

sd-bus: Add sd_bus_get_current_* docs
---

diff --git a/man/rules/meson.build b/man/rules/meson.build
index a18d83bc1ce..601a0a0ff83 100644
--- a/man/rules/meson.build
+++ b/man/rules/meson.build
@@ -249,6 +249,12 @@ manpages = [
   '3',
   ['SD_BUS_ERROR_END', 'SD_BUS_ERROR_MAP', 'sd_bus_error_map'],
   ''],
+ ['sd_bus_get_current_handler',
+  '3',
+  ['sd_bus_get_current_message',
+   'sd_bus_get_current_slot',
+   'sd_bus_get_current_userdata'],
+  ''],
  ['sd_bus_get_fd',
   '3',
   ['sd_bus_get_events', 'sd_bus_get_timeout', 'sd_bus_set_fd'],
diff --git a/man/sd-bus.xml b/man/sd-bus.xml
index 052bf2fbde3..55772dd8564 100644
--- a/man/sd-bus.xml
+++ b/man/sd-bus.xml
@@ -72,6 +72,10 @@
 <citerefentry><refentrytitle>sd_bus_error_add_map</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_get_address</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_get_bus_id</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>sd_bus_get_current_handler</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>sd_bus_get_current_message</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>sd_bus_get_current_slot</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>sd_bus_get_current_userdata</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>,
diff --git a/man/sd_bus_get_current_handler.xml b/man/sd_bus_get_current_handler.xml
new file mode 100644
index 00000000000..496116d5cbc
--- /dev/null
+++ b/man/sd_bus_get_current_handler.xml
@@ -0,0 +1,85 @@
+<?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_get_current_handler" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+  <refentryinfo>
+    <title>sd_bus_get_current_handler</title>
+    <productname>systemd</productname>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>sd_bus_get_current_handler</refentrytitle>
+    <manvolnum>3</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>sd_bus_get_current_handler</refname>
+    <refname>sd_bus_get_current_message</refname>
+    <refname>sd_bus_get_current_slot</refname>
+    <refname>sd_bus_get_current_userdata</refname>
+
+    <refpurpose>Query information of the callback a bus object is currently running</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <funcsynopsis>
+      <funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>
+
+      <funcprototype>
+        <funcdef>sd_bus_message_handler_t <function>sd_bus_get_current_handler</function></funcdef>
+        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
+      </funcprototype>
+
+      <funcprototype>
+        <funcdef>sd_bus_message* <function>sd_bus_get_current_message</function></funcdef>
+        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
+      </funcprototype>
+
+      <funcprototype>
+        <funcdef>sd_bus_slot* <function>sd_bus_get_current_slot</function></funcdef>
+        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
+      </funcprototype>
+
+      <funcprototype>
+        <funcdef>void* <function>sd_bus_get_current_userdata</function></funcdef>
+        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
+      </funcprototype>
+    </funcsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para>Whenever sd-bus is about to invoke a user-supplied callback function, it stores the
+    current callback, D-Bus message, slot and userdata pointer and allows these to be queried via
+    these <function>sd_bus_get_current_handler()</function>,
+    <function>sd_bus_get_current_message()</function>,
+    <function>sd_bus_get_current_slot()</function> and
+    <function>sd_bus_get_current_userdata()</function>, respectively. If <parameter>bus</parameter>
+    cannot be resolved or if execution does not reside in a user-supplied callback of
+    <parameter>bus</parameter> when calling any of these functions, they return
+    <constant>NULL</constant>.</para>
+  </refsect1>
+
+  <refsect1>
+    <title>Return Value</title>
+
+    <para>On success, these functions 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>