man: add sd_bus_message_get_signature(3)

diff --git a/man/rules/meson.build b/man/rules/meson.build
index 548499d7496e70607f522b87aee20f7fd666da88..99915c5e9f73c4e0382abd3ab2f9076aa4ec90be 100644 (file)
--- a/man/rules/meson.build
+++ b/man/rules/meson.build
@@ -213,6 +213,10 @@ manpages = [
   '3',
   ['sd_bus_message_get_realtime_usec', 'sd_bus_message_get_seqnum'],
   ''],
+ ['sd_bus_message_get_signature',
+  '3',
+  ['sd_bus_message_has_signature', 'sd_bus_message_is_empty'],
+  ''],
  ['sd_bus_message_get_type',
   '3',
   ['sd_bus_message_is_method_call',

diff --git a/man/sd-bus.xml b/man/sd-bus.xml
index fbbd491ccb8bf365482e9eb17674d6069bbaec9f..bf2f37a86d9e628e3bb6bf1a2ff73c3603bce9ca 100644 (file)
--- a/man/sd-bus.xml
+++ b/man/sd-bus.xml
@@ -60,6 +60,7 @@
 <citerefentry><refentrytitle>sd_bus_message_copy</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_message_get_cookie</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_message_get_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>sd_bus_message_get_signature</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_message_get_type</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_message_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>,

diff --git a/man/sd_bus_message_get_signature.xml b/man/sd_bus_message_get_signature.xml
new file mode 100644 (file)
index 0000000..bee6778
--- /dev/null
+++ b/man/sd_bus_message_get_signature.xml
@@ -0,0 +1,111 @@
+<?xml version='1.0'?> <!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!-- SPDX-License-Identifier: LGPL-2.1+ -->
+
+<refentry id="sd_bus_message_get_signature" xmlns:xi="http://www.w3.org/2001/XInclude">
+  <refentryinfo>
+    <title>sd_bus_message_get_signature</title>
+    <productname>systemd</productname>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle>sd_bus_message_get_signature</refentrytitle>
+    <manvolnum>3</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>sd_bus_message_get_signature</refname>
+    <refname>sd_bus_message_is_empty</refname>
+    <refname>sd_bus_message_has_signature</refname>
+
+    <refpurpose>Query bus message signature</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <funcsynopsis>
+      <funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>
+
+      <funcprototype>
+        <funcdef>const char* <function>sd_bus_message_get_signature</function></funcdef>
+        <paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
+        <paramdef>int <parameter>complete</parameter></paramdef>
+      </funcprototype>
+
+      <funcprototype>
+        <funcdef>int <function>sd_bus_message_is_empty</function></funcdef>
+        <paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
+      </funcprototype>
+
+      <funcprototype>
+        <funcdef>int <function>sd_bus_message_has_signature</function></funcdef>
+        <paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
+        <paramdef>const char *<parameter>signature</parameter></paramdef>
+      </funcprototype>
+    </funcsynopsis>
+
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>Description</title>
+
+    <para><function>sd_bus_message_get_signature()</function> returns the signature of message
+    <parameter>message</parameter>. If <parameter>complete</parameter> is true, the signature of the
+    whole message is returned, and just the signature of the currently open container otherwise.
+    </para>
+
+    <para><function>sd_bus_message_is_empty()</function> returns true if the message is empty,
+    i.e. when its signature is empty.</para>
+
+    <para><function>sd_bus_message_has_signature()</function> returns true if the signature of the
+    message <parameter>message</parameter> matches given <parameter>signature</parameter>. Parameter
+    <parameter>signature</parameter> may be <constant>NULL</constant>, this is treated the same as
+    an empty string, which is equivalent to calling <function>sd_bus_message_is_empty()</function>.
+    </para>
+</refsect1>
+
+  <refsect1>
+    <title>Return Value</title>
+
+    <para>On success, <function>sd_bus_message_get_signature()</function> returns
+    the signature, and <constant>NULL</constant> on error.</para>
+
+    <para>The other functions return 0 or a positive integer on success. On failure, they return a
+    negative errno-style error code.</para>
+  </refsect1>
+
+  <refsect1>
+    <title>Errors</title>
+
+    <para>Returned errors may indicate the following problems:</para>
+
+    <variablelist>
+      <varlistentry>
+        <term><constant>-EINVAL</constant></term>
+
+        <listitem><para>The <parameter>message</parameter> parameter is <constant>NULL</constant>.
+        </para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><constant>NULL</constant></term>
+
+        <listitem><para>The <parameter>message</parameter> parameter is <constant>NULL</constant>.
+        </para></listitem>
+      </varlistentry>
+    </variablelist>
+  </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_message_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+    </para>
+  </refsect1>
+
+</refentry>