sd-bus: Add sd_bus_set/is_monitor docs

diff --git a/man/rules/meson.build b/man/rules/meson.build
index 222c0d2919befbcef1c0caffebc42e2ed29bfadb..656caece7601d94d917364b88e8523f558106322 100644 (file)
--- a/man/rules/meson.build
+++ b/man/rules/meson.build
@@ -407,8 +407,10 @@ manpages = [
   '3',
   ['sd_bus_get_bus_id',
    'sd_bus_is_bus_client',
+   'sd_bus_is_monitor',
    'sd_bus_is_server',
-   'sd_bus_set_bus_client'],
+   'sd_bus_set_bus_client',
+   'sd_bus_set_monitor'],
   ''],
  ['sd_bus_set_watch_bind', '3', ['sd_bus_get_watch_bind'], ''],
  ['sd_bus_slot_get_bus',

diff --git a/man/sd-bus.xml b/man/sd-bus.xml
index 9918e0c737b537f2c6617d0975f80796a3ac31bd..c576578cf2d06d74e62f43de42d2043ca7e685fc 100644 (file)
--- a/man/sd-bus.xml
+++ b/man/sd-bus.xml
@@ -84,6 +84,7 @@
 <citerefentry><refentrytitle>sd_bus_get_scope</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_get_tid</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_get_unique_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>sd_bus_is_monitor</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_is_bus_client</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_is_server</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
@@ -131,6 +132,7 @@
 <citerefentry><refentrytitle>sd_bus_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_set_exit_on_disconnect</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_set_method_call_timeout</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>sd_bus_set_monitor</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_set_property</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_set_propertyv</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_set_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

diff --git a/man/sd_bus_set_server.xml b/man/sd_bus_set_server.xml
index 309a535f5163ec3e468a47b25ba1582e737bfe99..625dfd44687b40a7677b9d8c62ffa6bee581baf4 100644 (file)
--- a/man/sd_bus_set_server.xml
+++ b/man/sd_bus_set_server.xml
@@ -22,8 +22,10 @@
     <refname>sd_bus_get_bus_id</refname>
     <refname>sd_bus_set_bus_client</refname>
     <refname>sd_bus_is_bus_client</refname>
+    <refname>sd_bus_set_monitor</refname>
+    <refname>sd_bus_is_monitor</refname>
 
-    <refpurpose>Configure direct connection mode for a bus object</refpurpose>
+    <refpurpose>Configure connection mode for a bus object</refpurpose>
   </refnamediv>
 
   <refsynopsisdiv>
@@ -58,6 +60,17 @@
         <funcdef>int <function>sd_bus_is_bus_client</function></funcdef>
         <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
       </funcprototype>
+
+      <funcprototype>
+        <funcdef>int <function>sd_bus_set_monitor</function></funcdef>
+        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
+        <paramdef>int <parameter>b</parameter></paramdef>
+      </funcprototype>
+
+      <funcprototype>
+        <funcdef>int <function>sd_bus_is_monitor</function></funcdef>
+        <paramdef>sd_bus *<parameter>bus</parameter></paramdef>
+      </funcprototype>
     </funcsynopsis>
   </refsynopsisdiv>
 
@@ -98,18 +111,32 @@
 
     <para><function>sd_bus_is_bus_client()</function> returns whether the client mode is enabled/disabled for
     the given bus object.</para>
+
+    <para><function>sd_bus_set_monitor()</function> configures the bus object as a D-Bus monitor object.
+    <parameter>b</parameter> enables/disables the monitor mode. If zero, the monitor mode is disabled. If
+    non-zero, the monitor mode is enabled. When the monitor mode is enabled, no messages may be sent via the
+    bus object and it may not expose any objects on the bus. To start monitoring messages, call the
+    <function>org.freedesktop.DBus.Monitoring.BecomeMonitor</function> method of the D-Bus daemon and pass
+    a list of matches indicating which messages to intercept. See
+    <ulink url="https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-become-monitor">
+    The D-Bus specification</ulink> for more information.</para>
+
+    <para><function>sd_bus_is_monitor()</function> returns whether the monitor mode is enabled/disabled for
+    the given bus object.</para>
+
   </refsect1>
 
   <refsect1>
     <title>Return Value</title>
 
     <para>On success, <function>sd_bus_set_server()</function>,
-    <function>sd_bus_get_bus_id()</function> and <function>sd_bus_set_bus_client()</function> return a
-    non-negative integer. On failure, they return a negative errno-style error code.</para>
+    <function>sd_bus_get_bus_id()</function>, <function>sd_bus_set_bus_client()</function> and
+    <function>sd_bus_set_monitor()</function> return a non-negative integer. On failure, they return a
+    negative errno-style error code.</para>
 
-    <para><function>sd_bus_is_server()</function> and <function>sd_bus_is_bus_client()</function> return a
-    positive integer when the server or client mode is enabled, respectively. Otherwise, they return zero.
-    </para>
+    <para><function>sd_bus_is_server()</function>, <function>sd_bus_is_bus_client()</function> and
+    <function>sd_bus_is_monitor()</function> return a positive integer when the server or client mode is
+    enabled, respectively. Otherwise, they return zero.</para>
 
     <refsect2>
       <title>Errors</title>