]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/core/dbus-unit.h
units: introduce new Documentation= field and make use of it everywhere
[thirdparty/systemd.git] / src / core / dbus-unit.h
1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
2
3 #ifndef foodbusunithfoo
4 #define foodbusunithfoo
5
6 /***
7 This file is part of systemd.
8
9 Copyright 2010 Lennart Poettering
10
11 systemd is free software; you can redistribute it and/or modify it
12 under the terms of the GNU Lesser General Public License as published by
13 the Free Software Foundation; either version 2.1 of the License, or
14 (at your option) any later version.
15
16 systemd is distributed in the hope that it will be useful, but
17 WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 Lesser General Public License for more details.
20
21 You should have received a copy of the GNU Lesser General Public License
22 along with systemd; If not, see <http://www.gnu.org/licenses/>.
23 ***/
24
25 #include <dbus/dbus.h>
26
27 #include "manager.h"
28 #include "dbus-common.h"
29
30 #define BUS_UNIT_INTERFACE \
31 " <interface name=\"org.freedesktop.systemd1.Unit\">\n" \
32 " <method name=\"Start\">\n" \
33 " <arg name=\"mode\" type=\"s\" direction=\"in\"/>\n" \
34 " <arg name=\"job\" type=\"o\" direction=\"out\"/>\n" \
35 " </method>\n" \
36 " <method name=\"Stop\">\n" \
37 " <arg name=\"mode\" type=\"s\" direction=\"in\"/>\n" \
38 " <arg name=\"job\" type=\"o\" direction=\"out\"/>\n" \
39 " </method>\n" \
40 " <method name=\"Reload\">\n" \
41 " <arg name=\"mode\" type=\"s\" direction=\"in\"/>\n" \
42 " <arg name=\"job\" type=\"o\" direction=\"out\"/>\n" \
43 " </method>\n" \
44 " <method name=\"Restart\">\n" \
45 " <arg name=\"mode\" type=\"s\" direction=\"in\"/>\n" \
46 " <arg name=\"job\" type=\"o\" direction=\"out\"/>\n" \
47 " </method>\n" \
48 " <method name=\"TryRestart\">\n" \
49 " <arg name=\"mode\" type=\"s\" direction=\"in\"/>\n" \
50 " <arg name=\"job\" type=\"o\" direction=\"out\"/>\n" \
51 " </method>\n" \
52 " <method name=\"ReloadOrRestart\">\n" \
53 " <arg name=\"mode\" type=\"s\" direction=\"in\"/>\n" \
54 " <arg name=\"job\" type=\"o\" direction=\"out\"/>\n" \
55 " </method>\n" \
56 " <method name=\"ReloadOrTryRestart\">\n" \
57 " <arg name=\"mode\" type=\"s\" direction=\"in\"/>\n" \
58 " <arg name=\"job\" type=\"o\" direction=\"out\"/>\n" \
59 " </method>\n" \
60 " <method name=\"Kill\">\n" \
61 " <arg name=\"who\" type=\"s\" direction=\"in\"/>\n" \
62 " <arg name=\"mode\" type=\"s\" direction=\"in\"/>\n" \
63 " <arg name=\"signal\" type=\"i\" direction=\"in\"/>\n" \
64 " </method>\n" \
65 " <method name=\"ResetFailed\"/>\n" \
66 " <property name=\"Id\" type=\"s\" access=\"read\"/>\n" \
67 " <property name=\"Names\" type=\"as\" access=\"read\"/>\n" \
68 " <property name=\"Following\" type=\"s\" access=\"read\"/>\n" \
69 " <property name=\"Requires\" type=\"as\" access=\"read\"/>\n" \
70 " <property name=\"RequiresOverridable\" type=\"as\" access=\"read\"/>\n" \
71 " <property name=\"Requisite\" type=\"as\" access=\"read\"/>\n" \
72 " <property name=\"RequisiteOverridable\" type=\"as\" access=\"read\"/>\n" \
73 " <property name=\"Wants\" type=\"as\" access=\"read\"/>\n" \
74 " <property name=\"BindTo\" type=\"as\" access=\"read\"/>\n" \
75 " <property name=\"RequiredBy\" type=\"as\" access=\"read\"/>\n" \
76 " <property name=\"RequiredByOverridable\" type=\"as\" access=\"read\"/>\n" \
77 " <property name=\"WantedBy\" type=\"as\" access=\"read\"/>\n" \
78 " <property name=\"BoundBy\" type=\"as\" access=\"read\"/>\n" \
79 " <property name=\"Conflicts\" type=\"as\" access=\"read\"/>\n" \
80 " <property name=\"ConflictedBy\" type=\"as\" access=\"read\"/>\n" \
81 " <property name=\"Before\" type=\"as\" access=\"read\"/>\n" \
82 " <property name=\"After\" type=\"as\" access=\"read\"/>\n" \
83 " <property name=\"OnFailure\" type=\"as\" access=\"read\"/>\n" \
84 " <property name=\"Triggers\" type=\"as\" access=\"read\"/>\n" \
85 " <property name=\"TriggeredBy\" type=\"as\" access=\"read\"/>\n" \
86 " <property name=\"PropagateReloadTo\" type=\"as\" access=\"read\"/>\n" \
87 " <property name=\"PropagateReloadFrom\" type=\"as\" access=\"read\"/>\n" \
88 " <property name=\"RequiresMountsFor\" type=\"as\" access=\"read\"/>\n" \
89 " <property name=\"Description\" type=\"s\" access=\"read\"/>\n" \
90 " <property name=\"Documentation\" type=\"as\" access=\"read\"/>\n" \
91 " <property name=\"LoadState\" type=\"s\" access=\"read\"/>\n" \
92 " <property name=\"ActiveState\" type=\"s\" access=\"read\"/>\n" \
93 " <property name=\"SubState\" type=\"s\" access=\"read\"/>\n" \
94 " <property name=\"FragmentPath\" type=\"s\" access=\"read\"/>\n" \
95 " <property name=\"UnitFileState\" type=\"s\" access=\"read\"/>\n" \
96 " <property name=\"InactiveExitTimestamp\" type=\"t\" access=\"read\"/>\n" \
97 " <property name=\"InactiveExitTimestampMonotonic\" type=\"t\" access=\"read\"/>\n" \
98 " <property name=\"ActiveEnterTimestamp\" type=\"t\" access=\"read\"/>\n" \
99 " <property name=\"ActiveEnterTimestampMonotonic\" type=\"t\" access=\"read\"/>\n" \
100 " <property name=\"ActiveExitTimestamp\" type=\"t\" access=\"read\"/>\n" \
101 " <property name=\"ActiveExitTimestampMonotonic\" type=\"t\" access=\"read\"/>\n" \
102 " <property name=\"InactiveEnterTimestamp\" type=\"t\" access=\"read\"/>\n" \
103 " <property name=\"InactiveEnterTimestampMonotonic\" type=\"t\" access=\"read\"/>\n" \
104 " <property name=\"CanStart\" type=\"b\" access=\"read\"/>\n" \
105 " <property name=\"CanStop\" type=\"b\" access=\"read\"/>\n" \
106 " <property name=\"CanReload\" type=\"b\" access=\"read\"/>\n" \
107 " <property name=\"CanIsolate\" type=\"b\" access=\"read\"/>\n" \
108 " <property name=\"Job\" type=\"(uo)\" access=\"read\"/>\n" \
109 " <property name=\"StopWhenUnneeded\" type=\"b\" access=\"read\"/>\n" \
110 " <property name=\"RefuseManualStart\" type=\"b\" access=\"read\"/>\n" \
111 " <property name=\"RefuseManualStop\" type=\"b\" access=\"read\"/>\n" \
112 " <property name=\"AllowIsolate\" type=\"b\" access=\"read\"/>\n" \
113 " <property name=\"DefaultDependencies\" type=\"b\" access=\"read\"/>\n" \
114 " <property name=\"OnFailureIsolate\" type=\"b\" access=\"read\"/>\n" \
115 " <property name=\"IgnoreOnIsolate\" type=\"b\" access=\"read\"/>\n" \
116 " <property name=\"IgnoreOnSnapshot\" type=\"b\" access=\"read\"/>\n" \
117 " <property name=\"DefaultControlGroup\" type=\"s\" access=\"read\"/>\n" \
118 " <property name=\"ControlGroup\" type=\"as\" access=\"read\"/>\n" \
119 " <property name=\"ControlGroupAttributes\" type=\"a(sss)\" access=\"read\"/>\n" \
120 " <property name=\"NeedDaemonReload\" type=\"b\" access=\"read\"/>\n" \
121 " <property name=\"JobTimeoutUSec\" type=\"t\" access=\"read\"/>\n" \
122 " <property name=\"ConditionTimestamp\" type=\"t\" access=\"read\"/>\n" \
123 " <property name=\"ConditionTimestampMonotonic\" type=\"t\" access=\"read\"/>\n" \
124 " <property name=\"ConditionResult\" type=\"b\" access=\"read\"/>\n" \
125 " <property name=\"LoadError\" type=\"(ss)\" access=\"read\"/>\n" \
126 " </interface>\n"
127
128 #define BUS_UNIT_INTERFACES_LIST \
129 BUS_GENERIC_INTERFACES_LIST \
130 "org.freedesktop.systemd1.Unit\0"
131
132 extern const BusProperty bus_unit_properties[];
133
134 void bus_unit_send_change_signal(Unit *u);
135 void bus_unit_send_removed_signal(Unit *u);
136
137 extern const DBusObjectPathVTable bus_unit_vtable;
138
139 extern const char bus_unit_interface[];
140
141 #endif