projects / systemd.git / blame
| Commit | Line | Data |
|---|---|---|
| 60f067b4 JS |
1 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>sd_bus_message_get_monotonic_usec</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><style> |
| 2 | a.headerlink { | |
| 3 | color: #c60f0f; | |
| 4 | font-size: 0.8em; | |
| 5 | padding: 0 4px 0 4px; | |
| 6 | text-decoration: none; | |
| 7 | visibility: hidden; | |
| 8 | } | |
| 9 | ||
| 10 | a.headerlink:hover { | |
| 11 | background-color: #c60f0f; | |
| 12 | color: white; | |
| 13 | } | |
| 14 | ||
| 15 | h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, dt:hover > a.headerlink { | |
| 16 | visibility: visible; | |
| 17 | } | |
| 18 | </style><a href="index.html">Index </a>· | |
| 19 | <a href="systemd.directives.html">Directives </a>· | |
| 20 | <a href="../python-systemd/index.html">Python </a>· | |
| 21 | <a href="../libudev/index.html">libudev </a>· | |
| e3bff60a | 22 | <a href="../libudev/index.html">gudev </a><span style="float:right">systemd 220</span><hr><div class="refentry"><a name="sd_bus_message_get_monotonic_usec"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>sd_bus_message_get_monotonic_usec, sd_bus_message_get_realtime_usec, sd_bus_message_get_seqnum — Retrieve the sender timestamps and sequence number of a message</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><pre class="funcsynopsisinfo">#include <systemd/sd-bus.h></pre><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">int <b class="fsfunc">sd_bus_message_get_monotonic_usec</b>(</code></td><td>sd_bus_message *<var class="pdparam">message</var>, </td></tr><tr><td> </td><td>uint64_t *<var class="pdparam">usec</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">int <b class="fsfunc">sd_bus_message_get_realtime_usec</b>(</code></td><td>sd_bus_message *<var class="pdparam">message</var>, </td></tr><tr><td> </td><td>uint64_t *<var class="pdparam">usec</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">int <b class="fsfunc">sd_bus_message_get_seqnum</b>(</code></td><td>sd_bus_message *<var class="pdparam">message</var>, </td></tr><tr><td> </td><td>uint64_t *<var class="pdparam">seqnum</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a name="idm140718198284608"></a><h2 id="Description">Description<a class="headerlink" title="Permalink to this headline" href="#Description">¶</a></h2><p><code class="function">sd_bus_message_get_monotonic_usec()</code> |
| e735f4d4 MP |
23 | returns the monotonic timestamp of the time the message was sent. |
| 24 | This value is in microseconds since the | |
| 25 | <code class="constant">CLOCK_MONOTONIC</code> epoch, see | |
| 26 | <a href="http://man7.org/linux/man-pages/man2/clock_gettime.2.html"><span class="citerefentry"><span class="refentrytitle">clock_gettime</span>(2)</span></a> | |
| 27 | for details.</p><p>Similar, | |
| 28 | <code class="function">sd_bus_message_get_realtime_usec()</code> returns | |
| 29 | the realtime (wallclock) timestamp of the time the message was | |
| 30 | sent. This value is in microseconds since Jan 1st, 1970, i.e. in | |
| 31 | the <code class="constant">CLOCK_REALTIME</code> clock.</p><p><code class="function">sd_bus_message_get_seqnum()</code> returns the | |
| 32 | kernel-assigned sequence number of the message. The kernel assigns | |
| 33 | a global, monotonically increasing sequence number to all messages | |
| 34 | transmitted on the local system, at the time the message was sent. | |
| 35 | This sequence number is useful for determining message send order, | |
| e3bff60a | 36 | even across different buses of the local system. The sequence |
| e735f4d4 MP |
37 | number combined with the boot ID of the system (as returned by |
| 38 | <a href="sd_id128_get_boot.html"><span class="citerefentry"><span class="refentrytitle">sd_id128_get_boot</span>(3)</span></a>) | |
| 39 | is a suitable globally unique identifier for bus messages.</p><p>Note that the sending order and receiving order of messages | |
| 40 | might differ, in particular for broadcast messages. This means | |
| 41 | that the sequence number and the timestamps of messages a client | |
| 42 | reads are not necessarily monotonically increasing.</p><p>These timestamps and the sequence number are attached to | |
| 43 | each message by the kernel and cannot be manipulated by the | |
| 44 | sender.</p><p>Note that these timestamps are only available on some bus | |
| 45 | transports, and only after support for them has been negotiated | |
| 46 | with the | |
| 47 | <a href="sd_bus_negotiate_timestamp.html"><span class="citerefentry"><span class="refentrytitle">sd_bus_negotiate_timestamp</span>(3)</span></a> | |
| e3bff60a | 48 | call.</p></div><div class="refsect1"><a name="idm140718198275520"></a><h2 id="Return Value">Return Value<a class="headerlink" title="Permalink to this headline" href="#Return%20Value">¶</a></h2><p>On success, these calls return 0 or a positive integer. On |
| e735f4d4 MP |
49 | failure, these calls return a negative errno-style error |
| 50 | code.</p><p>On success, the timestamp or sequence number is returned in | |
| e3bff60a | 51 | the specified 64-bit unsigned integer variable.</p></div><div class="refsect1"><a name="idm140718198273712"></a><h2 id="Errors">Errors<a class="headerlink" title="Permalink to this headline" href="#Errors">¶</a></h2><p>Returned errors may indicate the following problems:</p><div class="variablelist"><dl class="variablelist"><dt id="-EINVAL"><span class="term"><code class="constant">-EINVAL</code></span><a class="headerlink" title="Permalink to this term" href="#-EINVAL">¶</a></dt><dd><p>A specified parameter is |
| e735f4d4 MP |
52 | invalid.</p></dd><dt id="-ENODATA"><span class="term"><code class="constant">-ENODATA</code></span><a class="headerlink" title="Permalink to this term" href="#-ENODATA">¶</a></dt><dd><p>No timestamp or sequence number information is |
| 53 | attached to the passed message. This error is returned if the | |
| 54 | underlying transport does not support timestamping or | |
| 55 | assigning of sequence numbers, or if this feature has not been | |
| 56 | negotiated with | |
| e3bff60a | 57 | <a href="sd_bus_negotiate_timestamp.html"><span class="citerefentry"><span class="refentrytitle">sd_bus_negotiate_timestamp</span>(3)</span></a>.</p></dd></dl></div></div><div class="refsect1"><a name="idm140718198268288"></a><h2 id="Notes">Notes<a class="headerlink" title="Permalink to this headline" href="#Notes">¶</a></h2><p>The |
| e735f4d4 MP |
58 | <code class="function">sd_bus_message_get_monotonic_usec()</code>, |
| 59 | <code class="function">sd_bus_message_get_realtime_usec()</code>, and | |
| 60 | <code class="function">sd_bus_message_get_seqnum()</code> interfaces are | |
| 61 | available as a shared library, which can be compiled and linked to | |
| 62 | with the | |
| 63 | <code class="constant">libsystemd</code> <a href="http://linux.die.net/man/1/pkg-config"><span class="citerefentry"><span class="refentrytitle">pkg-config</span>(1)</span></a> | |
| e3bff60a | 64 | file.</p></div><div class="refsect1"><a name="idm140718198263744"></a><h2 id="See Also">See Also<a class="headerlink" title="Permalink to this headline" href="#See%20Also">¶</a></h2><p> |
| e735f4d4 MP |
65 | <a href="systemd.html"><span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span></a>, |
| 66 | <a href="sd-bus.html"><span class="citerefentry"><span class="refentrytitle">sd-bus</span>(3)</span></a>, | |
| 67 | <a href="sd_bus_new.html"><span class="citerefentry"><span class="refentrytitle">sd_bus_new</span>(3)</span></a>, | |
| 68 | <a href="sd_bus_negotiate_timestamp.html"><span class="citerefentry"><span class="refentrytitle">sd_bus_negotiate_timestamp</span>(3)</span></a>, | |
| 69 | <a href="http://man7.org/linux/man-pages/man2/clock_gettime.2.html"><span class="citerefentry"><span class="refentrytitle">clock_gettime</span>(2)</span></a>, | |
| 70 | <a href="sd_id128_get_boot.html"><span class="citerefentry"><span class="refentrytitle">sd_id128_get_boot</span>(3)</span></a> | |
| 71 | </p></div></div></body></html> |