summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man3/sd_bus_slot_ref.3
blob: 21def369d3f93ff51a29f05f0452f14da2c71538 (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
'\" t
.TH "SD_BUS_SLOT_REF" "3" "" "systemd 255" "sd_bus_slot_ref"
.\" -----------------------------------------------------------------
.\" * 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_slot_ref, sd_bus_slot_unref, sd_bus_slot_unrefp \- Create and destroy references to a bus slot object
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <systemd/sd\-bus\&.h>
.fi
.ft
.HP \w'sd_bus_slot\ *sd_bus_slot_ref('u
.BI "sd_bus_slot *sd_bus_slot_ref(sd_bus_slot\ *" "slot" ");"
.HP \w'sd_bus_slot\ *sd_bus_slot_unref('u
.BI "sd_bus_slot *sd_bus_slot_unref(sd_bus_slot\ *" "slot" ");"
.HP \w'void\ sd_bus_slot_unrefp('u
.BI "void sd_bus_slot_unrefp(sd_bus_slot\ **" "slotp" ");"
.SH "DESCRIPTION"
.PP
\fBsd_bus_slot_ref()\fR
increases the internal reference counter of
\fIslot\fR
by one\&.
.PP
\fBsd_bus_slot_unref()\fR
decreases the internal reference counter of
\fIslot\fR
by one\&. Once the reference count has dropped to zero, slot object is destroyed and cannot be used anymore, so further calls to
\fBsd_bus_slot_ref()\fR
or
\fBsd_bus_slot_unref()\fR
are illegal\&.
.PP
\fBsd_bus_slot_unrefp()\fR
is similar to
\fBsd_bus_slot_unref()\fR
but takes a pointer to a pointer to an
\fBsd_bus_slot\fR
object\&. This call is useful in conjunction with GCC\*(Aqs and LLVM\*(Aqs
\m[blue]\fBClean\-up Variable Attribute\fR\m[]\&\s-2\u[1]\d\s+2\&. See
\fBsd_bus_new\fR(3)
for an example how to use the cleanup attribute\&.
.PP
\fBsd_bus_slot_ref()\fR
and
\fBsd_bus_slot_unref()\fR
execute no operation if the passed in bus object address is
\fBNULL\fR\&.
\fBsd_bus_slot_unrefp()\fR
will first dereference its argument, which must not be
\fBNULL\fR, and will execute no operation if
\fIthat\fR
is
\fBNULL\fR\&.
.SH "RETURN VALUE"
.PP
\fBsd_bus_slot_ref()\fR
always returns the argument\&.
.PP
\fBsd_bus_slot_unref()\fR
always returns
\fBNULL\fR\&.
.SH "NOTES"
.PP
Functions described here are available as a shared library, which can be compiled against and linked to with the
\fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
file\&.
.PP
The code described here uses
\fBgetenv\fR(3), which is declared to be not multi\-thread\-safe\&. This means that the code calling the functions described here must not call
\fBsetenv\fR(3)
from a parallel thread\&. It is recommended to only do calls to
\fBsetenv()\fR
from an early phase of the program when no other threads have been started\&.
.SH "HISTORY"
.PP
\fBsd_bus_slot_ref()\fR,
\fBsd_bus_slot_unref()\fR, and
\fBsd_bus_slot_unrefp()\fR
were added in version 240\&.
.SH "SEE ALSO"
.PP
\fBsystemd\fR(1),
\fBsd-bus\fR(3),
\fBsd_bus_new\fR(3),
\fBsd_bus_message_new\fR(3),
\fBsd_bus_call_method_async\fR(3)
.SH "NOTES"
.IP " 1." 4
Clean-up Variable Attribute
.RS 4
\%https://gcc.gnu.org/onlinedocs/gcc/Common-Variable-Attributes.html
.RE