2012-07-13 22:17:37 +04:00
<?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">
<!--
This file is part of systemd.
Copyright 2012 Lennart Poettering
systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http: / / w w w . g n u . o r g / l i c e n s e s /> .
-->
<refentry id= "sd_journal_get_cutoff_realtime_usec" >
<refentryinfo >
<title > sd_journal_get_cutoff_realtime_usec</title>
<productname > systemd</productname>
<authorgroup >
<author >
<contrib > Developer</contrib>
<firstname > Lennart</firstname>
<surname > Poettering</surname>
<email > lennart@poettering.net</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta >
<refentrytitle > sd_journal_get_cutoff_realtime_usec</refentrytitle>
<manvolnum > 3</manvolnum>
</refmeta>
<refnamediv >
<refname > sd_journal_get_cutoff_realtime_usec</refname>
<refname > sd_journal_get_cutoff_monotonic_usec</refname>
2012-07-13 22:39:05 +04:00
<refpurpose > Read cut-off timestamps from the current journal entry</refpurpose>
2012-07-13 22:17:37 +04:00
</refnamediv>
<refsynopsisdiv >
<funcsynopsis >
<funcsynopsisinfo > #include < systemd/sd-journal.h> </funcsynopsisinfo>
<funcprototype >
<funcdef > int <function > sd_journal_get_cutoff_realtime_usec</function> </funcdef>
<paramdef > sd_journal* <parameter > j</parameter> </paramdef>
<paramdef > uint64_t* <parameter > from</parameter> </paramdef>
<paramdef > uint64_t* <parameter > to</parameter> </paramdef>
</funcprototype>
<funcprototype >
<funcdef > int <function > sd_journal_get_cutoff_monotonic_usec</function> </funcdef>
<paramdef > sd_journal* <parameter > j</parameter> </paramdef>
<paramdef > sd_id128_t <parameter > boot_id</parameter> </paramdef>
<paramdef > uint64_t* <parameter > from</parameter> </paramdef>
<paramdef > uint64_t* <parameter > to</parameter> </paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 >
<title > Description</title>
<para > <function > sd_journal_get_cutoff_realtime_usec()</function>
gets the realtime (wallclock) timestamps of the first
and last entries accessible in the journal. It takes
three arguments: the journal context object and two
2013-06-27 23:51:44 +04:00
pointers to 64-bit unsigned integers to store the
2012-07-13 22:17:37 +04:00
timestamps in. The timestamps are in microseconds
2013-06-27 03:47:34 +04:00
since the epoch,
i.e. <constant > CLOCK_REALTIME</constant> . Either one
of the two timestamp arguments may be passed as
<constant > NULL</constant> in case the timestamp is not
needed, but not both.</para>
2012-07-13 22:17:37 +04:00
<para > <function > sd_journal_get_cutoff_monotonic_usec()</function>
gets the monotonic timestamps of the first and last
entries accessible in the journal. It takes three
2013-06-27 23:51:44 +04:00
arguments: the journal context object, a 128-bit
identifier for the boot, and two pointers to 64-bit
2012-07-13 22:17:37 +04:00
unsigned integers to store the timestamps. The
timestamps are in microseconds since boot-up of the
2013-06-27 03:47:34 +04:00
specific boot,
i.e. <constant > CLOCK_MONOTONIC</constant> . Since the
2012-07-13 22:17:37 +04:00
monotonic clock begins new with every reboot it only
defines a well-defined point in time when used
together with an identifier identifying the boot, see
<citerefentry > <refentrytitle > sd_id128_get_boot</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry>
for more information. The function will return the
timestamps for the boot identified by the passed boot
ID. Either one of the two timestamp arguments may be
2013-06-27 03:47:34 +04:00
passed as <constant > NULL</constant> in case the
timestamp is not needed, but not both.</para>
2012-07-13 22:17:37 +04:00
</refsect1>
<refsect1 >
<title > Return Value</title>
<para > <function > sd_journal_get_cutoff_realtime_usec()</function>
and
<function > sd_journal_get_cutoff_monotonic_usec()</function>
return 1 on success, 0 if not suitable entries are in
the journal or a negative errno-style error code.</para>
</refsect1>
<refsect1 >
<title > Notes</title>
<para > The
<function > sd_journal_get_cutoff_realtime_usec()</function>
and
<function > sd_journal_get_cutoff_monotonic_usec()</function>
2013-12-26 05:47:43 +04:00
interfaces are available as a shared library, which can
2012-07-13 22:17:37 +04:00
be compiled and linked to with the
2014-02-19 21:30:41 +04:00
<constant > libsystemd</constant> <citerefentry > <refentrytitle > pkg-config</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry>
2012-07-13 22:17:37 +04:00
file.</para>
</refsect1>
<refsect1 >
<title > See Also</title>
<para >
<citerefentry > <refentrytitle > systemd</refentrytitle> <manvolnum > 1</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > sd-journal</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > sd_journal_open</refentrytitle> <manvolnum > 3</manvolnum> </citerefentry> ,
<citerefentry > <refentrytitle > sd_journal_get_realtime_usec</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>
</para>
</refsect1>
</refentry>
