<title>Description</title>
<para><function>sd_journal_get_realtime_usec()</function>
- gets the realtime (wallclock) timestamp of the the
- current journal entry. It takes two arguments: the
- journal context object and a pointer to a 64 Bit
+ gets the realtime (wallclock) timestamp of the
+ current journal entry. It takes two arguments: the
+ journal context object and a pointer to a 64-bit
unsigned integer to store the timestamp in. The
timestamp is in microseconds since the epoch,
- i.e. CLOCK_REALTIME.</para>
-
- <para><function>sd_journal_get_realtime_usec()</function>
- gets the monotonic timestamp of the the current
- journal entry. It takes three arguments: the journal
- context object, a pointer to a 64 Bit unsigned integer
- to store the timestamp in as well as a 128 Bit ID
- buffer to store the boot ID of the monotonic timestamp
- in. The timestamp is in microseconds since boot-up of
- the specific boot, i.e. CLOCK_MONOTONIC. Since the
- monotonic clock begins new with every reboot it only
+ i.e. <constant>CLOCK_REALTIME</constant>.</para>
+
+ <para><function>sd_journal_get_monotonic_usec()</function>
+ gets the monotonic timestamp of the current journal
+ entry. It takes three arguments: the journal context
+ object, a pointer to a 64-bit unsigned integer to
+ store the timestamp in, as well as a 128-bit ID buffer
+ to store the boot ID of the monotonic timestamp.
+ The timestamp is in microseconds since boot-up of
+ the specific boot,
+ i.e. <constant>CLOCK_MONOTONIC</constant>. Since the
+ monotonic clock begins new with every reboot, it only
defines a well-defined point in time when used
- together with a identifier identifying the boot, see
+ together with an identifier identifying the boot. See
<citerefentry><refentrytitle>sd_id128_get_boot</refentrytitle><manvolnum>3</manvolnum></citerefentry>
for more information. If the boot ID parameter is
- passed NULL the function will fail if the monotonic
- timestamp of the current entry is not of the current
- system boot.</para>
+ passed <constant>NULL</constant>, the function will
+ fail if the monotonic timestamp of the current entry
+ is not of the current system boot.</para>
<para>Note that these functions will not work before
<citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>
(or related call) has been called at least
- once.</para>
+ once, in order to position the read pointer at a valid entry.</para>
</refsect1>
<refsect1>
and
<function>sd_journal_get_monotonic_usec()</function>
returns 0 on success or a negative errno-style error
- code. If the boot ID parameter was passed NULL and the
+ code. If the boot ID parameter was passed <constant>NULL</constant> and the
monotonic timestamp of the current journal entry is
not of the current system boot, -ESTALE is returned by <function>sd_journal_get_monotonic_usec()</function>.</para>
</refsect1>
<function>sd_journal_get_monotonic_usec()</function>
interfaces are available as shared library, which can
be compiled and linked to with the
- <literal>libsystemd-journal</literal>
- <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ <constant>libsystemd-journal</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
file.</para>
</refsect1>
<citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_id128_get_boot</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry>
+ <citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>sd_journal_get_cutoff_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>
</para>
</refsect1>