chiark / gitweb /
hashmap: return more information from resize_buckets()
[elogind.git] / man / sd_bus_message_get_monotonic_usec.xml
index b9437ff62ebc924d99bb9c90e0095603ecd328f7..290faf2a5b41ea62f5cfe77f6b8faed2eb14d16e 100644 (file)
@@ -21,7 +21,7 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="sd_bus_message_get_monotonic_usec">
+<refentry id="sd_bus_message_get_monotonic_usec" conditional="ENABLE_KDBUS">
 
         <refentryinfo>
                 <title>sd_bus_message_get_monotonic_usec</title>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_bus_message_get_monotonic_usec</function></funcdef>
-                                <paramdef>sd_bus_message<parameter>message</parameter></paramdef>
-                                <paramdef>uint64_t<parameter>usec</parameter></paramdef>
+                                <paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
+                                <paramdef>uint64_t *<parameter>usec</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_bus_message_get_realtime_usec</function></funcdef>
-                                <paramdef>sd_bus_message<parameter>message</parameter></paramdef>
-                                <paramdef>uint64_t<parameter>usec</parameter></paramdef>
+                                <paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
+                                <paramdef>uint64_t *<parameter>usec</parameter></paramdef>
                         </funcprototype>
 
                         <funcprototype>
                                 <funcdef>int <function>sd_bus_message_get_seqnum</function></funcdef>
-                                <paramdef>sd_bus_message<parameter>message</parameter></paramdef>
-                                <paramdef>uint64_t<parameter>seqnum</parameter></paramdef>
+                                <paramdef>sd_bus_message *<parameter>message</parameter></paramdef>
+                                <paramdef>uint64_t *<parameter>seqnum</parameter></paramdef>
                         </funcprototype>
                 </funcsynopsis>
         </refsynopsisdiv>
 
                 <para><function>sd_bus_message_get_seqnum()</function>
                 returns the kernel-assigned sequence number of the
-                message. The kernel assigns a global monotonically increasing
-                sequence number to all messages sent on the local
-                system. This sequence number is useful for determining
+                message. The kernel assigns a global, monotonically
+                increasing sequence number to all messages transmitted
+                on the local system, at the time the message was
+                sent. This sequence number is useful for determining
                 message send order, even across different busses of
                 the local system. The sequence number combined with
                 the boot ID of the system (as returned by
                 is a suitable globally unique identifier for bus
                 messages.</para>
 
+                <para>Note that the sending order and receiving order
+                of messages might differ, in particular for broadcast
+                messages. This means that the sequence number and the
+                timestamps of messages a client reads are not
+                necessarily monotonically increasing.</para>
+
                 <para>These timestamps and the sequence number are
                 attached to each message by the kernel and cannot be
                 manipulated by the sender.</para>
 
                 <variablelist>
                         <varlistentry>
-                                <term><varname>-EINVAL</varname></term>
+                                <term><constant>-EINVAL</constant></term>
 
                                 <listitem><para>A specified parameter
                                 is invalid.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
-                                <term><varname>-ENODATA</varname></term>
+                                <term><constant>-ENODATA</constant></term>
 
                                 <listitem><para>No timestamp or
                                 sequence number information is
                 and <function>sd_bus_message_get_seqnum()</function>
                 interfaces are available as a shared library, which
                 can be compiled and linked to with the
-                <constant>libsystemd</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+                <constant>libsystemd</constant> <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
                 file.</para>
         </refsect1>