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
|
'\" t
.TH "SD_BUS_GET_N_QUEUED_READ" "3" "" "systemd 255" "sd_bus_get_fd"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
sd_bus_get_n_queued_read, sd_bus_get_n_queued_write \- Get the number of pending bus messages in the read and write queues of a bus connection object
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <systemd/sd\-bus\&.h>
.fi
.ft
.HP \w'int\ sd_bus_get_n_queued_read('u
.BI "int sd_bus_get_n_queued_read(sd_bus\ *" "bus" ", uint64_t\ *" "ret" ");"
.HP \w'int\ sd_bus_get_n_queued_write('u
.BI "int sd_bus_get_n_queued_write(sd_bus\ *" "bus" ", uint64_t\ *" "ret" ");"
.SH "DESCRIPTION"
.PP
\fBsd_bus_get_n_queued_read()\fR
may be used to query the number of bus messages in the read queue of a bus connection object\&. The read queue contains all messages read from the transport medium (e\&.g\&. network socket) but not yet processed locally\&. The function expects two arguments: the bus object to query, and a pointer to a 64\-bit counter variable to write the current queue size to\&. Use
\fBsd_bus_process()\fR
in order to process queued messages, i\&.e\&. to reduce the size of the read queue (as well as, in fact, the write queue, see below)\&.
.PP
Similarly,
\fBsd_bus_get_n_queued_write()\fR
may be used to query the number of currently pending bus messages in the write queue of a bus connection object\&. The write queue contains all messages enqueued into the connection with a call such as
\fBsd_bus_send()\fR
but not yet written to the transport medium\&. The expected arguments are similar to
\fBsd_bus_get_n_queued_read()\fR\&. Here too, use
\fBsd_bus_process()\fR
to reduce the size of the write queue\&. Alternatively, use
\fBsd_bus_flush()\fR
to synchronously write out any pending bus messages until the write queue is empty\&.
.SH "RETURN VALUE"
.PP
On success, these functions return 0 or a positive integer\&. On failure, they return a negative errno\-style error code\&.
.SS "Errors"
.PP
Returned errors may indicate the following problems:
.PP
\fB\-ECHILD\fR
.RS 4
The bus connection was created in a different process, library or module instance\&.
.RE
.SH "HISTORY"
.PP
\fBsd_bus_get_n_queued_read()\fR
and
\fBsd_bus_get_n_queued_write()\fR
were added in version 238\&.
.SH "SEE ALSO"
.PP
\fBsystemd\fR(1),
\fBsd-bus\fR(3),
\fBsd_bus_process\fR(3),
\fBsd_bus_send\fR(3),
\fBsd_bus_flush\fR(3)
|
