| 1 |
'\" t |
| 2 |
.TH "SD_JOURNAL_GET_CURSOR" "3" "" "systemd 261~rc3" "sd_journal_get_cursor" |
| 3 |
.\" ----------------------------------------------------------------- |
| 4 |
.\" * Define some portability stuff |
| 5 |
.\" ----------------------------------------------------------------- |
| 6 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 7 |
.\" http://bugs.debian.org/507673 |
| 8 |
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
| 9 |
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 10 |
.ie \n(.g .ds Aq \(aq |
| 11 |
.el .ds Aq ' |
| 12 |
.\" ----------------------------------------------------------------- |
| 13 |
.\" * set default formatting |
| 14 |
.\" ----------------------------------------------------------------- |
| 15 |
.\" disable hyphenation |
| 16 |
.nh |
| 17 |
.\" disable justification (adjust text to left margin only) |
| 18 |
.ad l |
| 19 |
.\" ----------------------------------------------------------------- |
| 20 |
.\" * MAIN CONTENT STARTS HERE * |
| 21 |
.\" ----------------------------------------------------------------- |
| 22 |
.SH "NAME" |
| 23 |
sd_journal_get_cursor, sd_journal_test_cursor \- Get cursor string for or test cursor string against the current journal entry |
| 24 |
.SH "SYNOPSIS" |
| 25 |
.sp |
| 26 |
.ft B |
| 27 |
.nf |
| 28 |
#include <systemd/sd\-journal\&.h> |
| 29 |
.fi |
| 30 |
.ft |
| 31 |
.HP \w'int\ sd_journal_get_cursor('u |
| 32 |
.BI "int sd_journal_get_cursor(sd_journal\ *" "j" ", char\ **" "ret_cursor" ");" |
| 33 |
.HP \w'int\ sd_journal_test_cursor('u |
| 34 |
.BI "int sd_journal_test_cursor(sd_journal\ *" "j" ", const\ char\ *" "cursor" ");" |
| 35 |
.SH "DESCRIPTION" |
| 36 |
.PP |
| 37 |
\fBsd_journal_get_cursor()\fR |
| 38 |
returns a cursor string for the current journal entry\&. A cursor is a serialization of the current journal position formatted as text\&. The string only contains printable characters and can be passed around in text form\&. The cursor identifies a journal entry globally and in a stable way and may be used to later seek to it via |
| 39 |
\fBsd_journal_seek_cursor\fR(3)\&. The cursor string should be considered opaque and not be parsed by clients\&. Seeking to a cursor position without the specific entry being available locally will seek to the next closest (in terms of time) available entry\&. The call takes two arguments: a journal context object and a pointer to a string pointer where the cursor string will be placed\&. The string is allocated via libc |
| 40 |
\fBmalloc\fR(3) |
| 41 |
and should be freed after use with |
| 42 |
\fBfree\fR(3)\&. The |
| 43 |
\fIret_cursor\fR |
| 44 |
parameter may be passed as |
| 45 |
\fBNULL\fR |
| 46 |
in which case the cursor string is not generated, however the return value will indicate whether the journal context is currently positioned on an entry, and thus has a cursor associated\&. |
| 47 |
.PP |
| 48 |
\fBsd_journal_test_cursor()\fR |
| 49 |
may be used to check whether the current position in the journal matches the specified cursor\&. This is useful since cursor strings do not uniquely identify an entry: the same entry might be referred to by multiple different cursor strings, and hence string comparing cursors is not possible\&. Use this call to verify after an invocation of |
| 50 |
\fBsd_journal_seek_cursor\fR(3), whether the entry being sought to was actually found in the journal or the next closest entry was used instead\&. |
| 51 |
.PP |
| 52 |
Note that |
| 53 |
\fBsd_journal_get_cursor()\fR |
| 54 |
and |
| 55 |
\fBsd_journal_test_cursor()\fR |
| 56 |
will not work before |
| 57 |
\fBsd_journal_next\fR(3) |
| 58 |
(or one of the other functions which move to an entry) has been called at least once to position the read pointer at a valid entry\&. |
| 59 |
.SH "RETURN VALUE" |
| 60 |
.PP |
| 61 |
\fBsd_journal_get_cursor()\fR |
| 62 |
returns 0 on success or a negative errno\-style error code\&. |
| 63 |
\fBsd_journal_test_cursor()\fR |
| 64 |
returns positive if the current entry matches the specified cursor, 0 if it does not match the specified cursor or a negative errno\-style error code on failure\&. |
| 65 |
.SS "Errors" |
| 66 |
.PP |
| 67 |
Returned errors may indicate the following problems: |
| 68 |
.PP |
| 69 |
\fB\-EADDRNOTAVAIL\fR |
| 70 |
.RS 4 |
| 71 |
The journal context is currently not positioned on any entry, and hence no cursor string can be generated\&. |
| 72 |
.RE |
| 73 |
.PP |
| 74 |
\fB\-EINVAL\fR |
| 75 |
.RS 4 |
| 76 |
The journal context parameter is |
| 77 |
\fBNULL\fR\&. |
| 78 |
.RE |
| 79 |
.PP |
| 80 |
\fB\-ECHILD\fR |
| 81 |
.RS 4 |
| 82 |
The journal context object has been allocated in a different process than it is being used in now\&. |
| 83 |
.RE |
| 84 |
.SH "NOTES" |
| 85 |
.PP |
| 86 |
All functions listed here are thread\-agnostic and only a single thread may operate on a given object at any given time\&. Different threads may access the same object at different times\&. Multiple independent objects may be used from different threads in parallel\&. |
| 87 |
.PP |
| 88 |
Functions described here are available as a shared library, which can be compiled against and linked to with the |
| 89 |
\fBlibsystemd\fR\ \&\fBpkg-config\fR(1) |
| 90 |
file\&. |
| 91 |
.SH "HISTORY" |
| 92 |
.PP |
| 93 |
\fBsd_journal_get_cursor()\fR |
| 94 |
was added in version 187\&. |
| 95 |
.PP |
| 96 |
\fBsd_journal_test_cursor()\fR |
| 97 |
was added in version 195\&. |
| 98 |
.SH "SEE ALSO" |
| 99 |
.PP |
| 100 |
\fBsystemd\fR(1), \fBsd-journal\fR(3), \fBsd_journal_open\fR(3), \fBsd_journal_seek_cursor\fR(3) |