summaryrefslogtreecommitdiff
path: root/man/sd_journal_get_cutoff_realtime_usec.xml
blob: ed014cb509394b90b97eef534832c46f2a1124fa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
<?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://www.gnu.org/licenses/>.
-->

<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>
                <refpurpose>Read cut-off timestamps from the current journal entry</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <funcsynopsis>
                        <funcsynopsisinfo>#include &lt;systemd/sd-journal.h&gt;</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
                pointers to 64 Bit unsigned integers to store the
                timestamps in. The timestamps are in microseconds
                since the epoch, i.e. CLOCK_REALTIME. Either one of
                the two timestamp arguments may be passed as NULL in
                case the timestamp is not needed, but not both.</para>

                <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
                arguments: the journal context object, a 128 Bit
                identifier for the boot, and two pointers to 64 Bit
                unsigned integers to store the timestamps. The
                timestamps are in microseconds since boot-up of the
                specific boot, i.e. CLOCK_MONOTONIC. Since the
                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
                passed as NULL in case the timestamp is not needed,
                but not both.</para>
        </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>
                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>
                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>