projects / systemd.git / blame
| Commit | Line | Data |
|---|---|---|
| 663996b3 MS |
1 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>sd_journal_get_cutoff_realtime_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>· | |
| e735f4d4 MP |
22 | <a href="../libudev/index.html">gudev </a><span style="float:right">systemd 219</span><hr><div class="refentry"><a name="sd_journal_get_cutoff_realtime_usec"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>sd_journal_get_cutoff_realtime_usec, sd_journal_get_cutoff_monotonic_usec — Read cut-off timestamps from the current journal entry</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="funcsynopsis"><pre class="funcsynopsisinfo">#include <systemd/sd-journal.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_journal_get_cutoff_realtime_usec</b>(</code></td><td>sd_journal *<var class="pdparam">j</var>, </td></tr><tr><td> </td><td>uint64_t *<var class="pdparam">from</var>, </td></tr><tr><td> </td><td>uint64_t *<var class="pdparam">to</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_journal_get_cutoff_monotonic_usec</b>(</code></td><td>sd_journal *<var class="pdparam">j</var>, </td></tr><tr><td> </td><td>sd_id128_t <var class="pdparam">boot_id</var>, </td></tr><tr><td> </td><td>uint64_t *<var class="pdparam">from</var>, </td></tr><tr><td> </td><td>uint64_t *<var class="pdparam">to</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a name="idm139661284739216"></a><h2 id="Description">Description<a class="headerlink" title="Permalink to this headline" href="#Description">¶</a></h2><p><code class="function">sd_journal_get_cutoff_realtime_usec()</code> |
| 23 | retrieves the realtime (wallclock) timestamps of the first and | |
| 24 | last entries accessible in the journal. It takes three arguments: | |
| 25 | the journal context object <em class="parameter"><code>j</code></em> and two | |
| 26 | pointers <em class="parameter"><code>from</code></em> and <em class="parameter"><code>to</code></em> | |
| 27 | pointing at 64-bit unsigned integers to store the timestamps in. | |
| 28 | The timestamps are in microseconds since the epoch, i.e. | |
| 29 | <code class="constant">CLOCK_REALTIME</code>. Either one of the two | |
| 30 | timestamp arguments may be passed as <code class="constant">NULL</code> in | |
| 31 | case the timestamp is not needed, but not both.</p><p><code class="function">sd_journal_get_cutoff_monotonic_usec()</code> | |
| 32 | retrieves the monotonic timestamps of the first and last entries | |
| 33 | accessible in the journal. It takes three arguments: the journal | |
| 34 | context object <em class="parameter"><code>j</code></em>, a 128-bit identifier for | |
| 35 | the boot <em class="parameter"><code>boot_id</code></em>, and two pointers to | |
| 36 | 64-bit unsigned integers to store the timestamps, | |
| 37 | <em class="parameter"><code>from</code></em> and <em class="parameter"><code>to</code></em>. The | |
| 38 | timestamps are in microseconds since boot-up of the specific boot, | |
| 39 | i.e. <code class="constant">CLOCK_MONOTONIC</code>. Since the monotonic | |
| 40 | clock begins new with every reboot it only defines a well-defined | |
| 41 | point in time when used together with an identifier identifying | |
| 42 | the boot, see | |
| 43 | <a href="sd_id128_get_boot.html"><span class="citerefentry"><span class="refentrytitle">sd_id128_get_boot</span>(3)</span></a> | |
| 44 | for more information. The function will return the timestamps for | |
| 45 | the boot identified by the passed boot ID. Either one of the two | |
| 46 | timestamp arguments may be passed as <code class="constant">NULL</code> in | |
| 47 | case the timestamp is not needed, but not both.</p></div><div class="refsect1"><a name="idm139661288682112"></a><h2 id="Return Value">Return Value<a class="headerlink" title="Permalink to this headline" href="#Return%20Value">¶</a></h2><p><code class="function">sd_journal_get_cutoff_realtime_usec()</code> | |
| 48 | and <code class="function">sd_journal_get_cutoff_monotonic_usec()</code> | |
| 49 | return 1 on success, 0 if not suitable entries are in the journal | |
| 50 | or a negative errno-style error code.</p><p>Locations pointed to by parameters | |
| 51 | <em class="parameter"><code>from</code></em> and <em class="parameter"><code>to</code></em> will be | |
| 52 | set only if the return value is positive, and obviously, the | |
| 53 | parameters are non-null.</p></div><div class="refsect1"><a name="idm139661288677568"></a><h2 id="Notes">Notes<a class="headerlink" title="Permalink to this headline" href="#Notes">¶</a></h2><p>The | |
| 54 | <code class="function">sd_journal_get_cutoff_realtime_usec()</code> and | |
| 55 | <code class="function">sd_journal_get_cutoff_monotonic_usec()</code> | |
| 56 | interfaces are available as a shared library, which can be | |
| 57 | compiled and linked to with the | |
| 58 | <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> | |
| 59 | file.</p></div><div class="refsect1"><a name="idm139661288673184"></a><h2 id="See Also">See Also<a class="headerlink" title="Permalink to this headline" href="#See%20Also">¶</a></h2><p> | |
| 60 | <a href="systemd.html"><span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span></a>, | |
| 61 | <a href="sd-journal.html"><span class="citerefentry"><span class="refentrytitle">sd-journal</span>(3)</span></a>, | |
| 62 | <a href="sd_journal_open.html"><span class="citerefentry"><span class="refentrytitle">sd_journal_open</span>(3)</span></a>, | |
| 63 | <a href="sd_journal_get_realtime_usec.html"><span class="citerefentry"><span class="refentrytitle">sd_journal_get_realtime_usec</span>(3)</span></a>, | |
| 64 | <a href="sd_id128_get_boot.html"><span class="citerefentry"><span class="refentrytitle">sd_id128_get_boot</span>(3)</span></a>, | |
| 65 | <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> | |
| 66 | </p></div></div></body></html> |