1SD_JOURNAL_SEEK_HEAD(3)      sd_journal_seek_head      SD_JOURNAL_SEEK_HEAD(3)
2
3
4

NAME

6       sd_journal_seek_head, sd_journal_seek_tail,
7       sd_journal_seek_monotonic_usec, sd_journal_seek_realtime_usec,
8       sd_journal_seek_cursor - Seek to a position in the journal
9

SYNOPSIS

11       #include <systemd/sd-journal.h>
12
13       int sd_journal_seek_head(sd_journal *j);
14
15       int sd_journal_seek_tail(sd_journal *j);
16
17       int sd_journal_seek_monotonic_usec(sd_journal *j, sd_id128_t boot_id,
18                                          uint64_t usec);
19
20       int sd_journal_seek_realtime_usec(sd_journal *j, uint64_t usec);
21
22       int sd_journal_seek_cursor(sd_journal *j, const char *cursor);
23

DESCRIPTION

25       sd_journal_seek_head() seeks to the beginning of the journal, i.e. the
26       oldest available entry.
27
28       Similarly, sd_journal_seek_tail() may be used to seek to the end of the
29       journal, i.e. the most recent available entry.
30
31       sd_journal_seek_monotonic_usec() seeks to the entry with the specified
32       monotonic timestamp, i.e.  CLOCK_MONOTONIC. Since monotonic time
33       restarts on every reboot a boot ID needs to be specified as well.
34
35       sd_journal_seek_realtime_usec() seeks to the entry with the specified
36       realtime (wallclock) timestamp, i.e.  CLOCK_REALTIME. Note that the
37       realtime clock is not necessarily monotonic. If a realtime timestamp is
38       ambiguous, it is not defined which position is sought to.
39
40       sd_journal_seek_cursor() seeks to the entry located at the specified
41       cursor string. For details on cursors, see sd_journal_get_cursor(3). If
42       no entry matching the specified cursor is found the call will seek to
43       the next closest entry (in terms of time) instead. To verify whether
44       the newly selected entry actually matches the cursor, use
45       sd_journal_test_cursor(3).
46
47       Note that these calls do not actually make any entry the new current
48       entry, this needs to be done in a separate step with a subsequent
49       sd_journal_next(3) invocation (or a similar call). Only then, entry
50       data may be retrieved via sd_journal_get_data(3). If no entry exists
51       that matches exactly the specified seek address, the next closest is
52       sought to. If sd_journal_next(3) is used, the closest following entry
53       will be sought to, if sd_journal_previous(3) is used the closest
54       preceding entry is sought to.
55

RETURN VALUE

57       The functions return 0 on success or a negative errno-style error code.
58

NOTES

60       All functions listed here are thread-agnostic and only a single thread
61       may operate on a given sd_journal object.
62
63       These APIs are implemented as a shared library, which can be compiled
64       and linked to with the libsystemd pkg-config(1) file.
65

SEE ALSO

67       systemd(1), sd-journal(3), sd_journal_open(3), sd_journal_next(3),
68       sd_journal_get_data(3), sd_journal_get_cursor(3),
69       sd_journal_get_realtime_usec(3)
70
71
72
73systemd 239                                            SD_JOURNAL_SEEK_HEAD(3)
Impressum