summaryrefslogtreecommitdiffstats
path: root/upstream/mageia-cauldron/man3/sd_bus_slot_get_bus.3
blob: 13e790f0e7248e6a86834458153f51f7151aabff (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
'\" t
.TH "SD_BUS_SLOT_GET_BUS" "3" "" "systemd 255" "sd_bus_slot_get_bus"
.\" -----------------------------------------------------------------
.\" * 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_get_bus, sd_bus_slot_get_current_handler, sd_bus_slot_get_current_message, sd_bus_slot_get_current_userdata \- Query information attached to a bus slot object
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <systemd/sd\-bus\&.h>
.fi
.ft
.HP \w'typedef\ int\ (*sd_bus_message_handler_t)('u
.BI "typedef int (*sd_bus_message_handler_t)(sd_bus_message\ *" "m" ", void\ *" "userdata" ", sd_bus_error\ *" "ret_error" ");"
.HP \w'sd_bus\ *sd_bus_slot_get_bus('u
.BI "sd_bus *sd_bus_slot_get_bus(sd_bus_slot\ *" "slot" ");"
.HP \w'sd_bus_message_handler_t\ sd_bus_slot_get_current_handler('u
.BI "sd_bus_message_handler_t sd_bus_slot_get_current_handler(sd_bus_slot\ *" "slot" ");"
.HP \w'sd_bus_message\ *sd_bus_slot_get_current_message('u
.BI "sd_bus_message *sd_bus_slot_get_current_message(sd_bus_slot\ *" "slot" ");"
.HP \w'void\ *sd_bus_slot_get_current_userdata('u
.BI "void *sd_bus_slot_get_current_userdata(sd_bus_slot\ *" "slot" ");"
.SH "DESCRIPTION"
.PP
\fBsd_bus_slot_get_bus()\fR
returns the bus object that message
\fIslot\fR
is attached to\&.
.PP
\fBsd_bus_slot_get_current_handler()\fR,
\fBsd_bus_slot_get_current_message()\fR
and
\fBsd_bus_slot_get_current_userdata()\fR
return the current handler, message and userdata respectively of the bus
\fIslot\fR
is attached to if we\*(Aqre currently executing the callback associated with
\fIslot\fR\&.
.SH "RETURN VALUE"
.PP
\fBsd_bus_slot_get_bus()\fR
always returns the bus object\&.
.PP
On success,
\fBsd_bus_slot_get_current_handler()\fR,
\fBsd_bus_slot_get_current_message()\fR
and
\fBsd_bus_slot_get_current_userdata()\fR
return the requested object\&. On failure, they return
\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_get_bus()\fR,
\fBsd_bus_slot_get_current_handler()\fR,
\fBsd_bus_slot_get_current_message()\fR, and
\fBsd_bus_slot_get_current_userdata()\fR
were added in version 246\&.
.SH "SEE ALSO"
.PP
\fBsystemd\fR(1),
\fBsd-bus\fR(3),