dbus: use the annotations for documentation
[NetworkManager.git] / introspection / nm-device-ip-tunnel.xml
1 <?xml version="1.0" encoding="UTF-8" ?>
2
3 <node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
4   <interface name="org.freedesktop.NetworkManager.Device.IPTunnel">
5
6     <property name="Mode" type="u" access="read">
7       <annotation name="org.gtk.GDBus.DocString" value="
8         The tunneling mode.
9       " />
10     </property>
11
12     <property name="Parent" type="o" access="read">
13       <annotation name="org.gtk.GDBus.DocString" value="
14         The object path of the parent device.
15       " />
16     </property>
17
18     <property name="Local" type="s" access="read">
19       <annotation name="org.gtk.GDBus.DocString" value="
20         The local endpoint of the tunnel.
21       " />
22     </property>
23
24     <property name="Remote" type="s" access="read">
25       <annotation name="org.gtk.GDBus.DocString" value="
26         The remote endpoint of the tunnel.
27       " />
28     </property>
29
30     <property name="Ttl" type="y" access="read">
31       <annotation name="org.gtk.GDBus.DocString" value="
32         The TTL assigned to tunneled packets. 0 is a special value
33         meaning that packets inherit the TTL value
34       " />
35     </property>
36
37     <property name="Tos" type="y" access="read">
38       <annotation name="org.gtk.GDBus.DocString" value="
39         The type of service (IPv4) or traffic class (IPv6) assigned to
40         tunneled packets.
41       " />
42     </property>
43
44     <property name="PathMtuDiscovery" type="b" access="read">
45       <annotation name="org.gtk.GDBus.DocString" value="
46         Whether path MTU discovery is enabled on this tunnel.
47       " />
48     </property>
49
50     <property name="InputKey" type="s" access="read">
51       <annotation name="org.gtk.GDBus.DocString" value="
52         The key used for incoming packets.
53       " />
54     </property>
55
56     <property name="OutputKey" type="s" access="read">
57       <annotation name="org.gtk.GDBus.DocString" value="
58         The key used for outgoing packets.
59       " />
60     </property>
61
62     <property name="EncapsulationLimit" type="y" access="read">
63       <annotation name="org.gtk.GDBus.DocString" value="
64         How many additional levels of encapsulation are permitted to
65         be prepended to packets. This property applies only to IPv6
66         tunnels.
67       " />
68     </property>
69
70     <property name="FlowLabel" type="u" access="read">
71       <annotation name="org.gtk.GDBus.DocString" value="
72         The flow label to assign to tunnel packets. This property
73         applies only to IPv6 tunnels.
74       " />
75     </property>
76
77     <signal name="PropertiesChanged">
78         <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
79             <annotation name="org.gtk.GDBus.DocString" value="
80                 A dictionary mapping property names to variant boxed values
81             " />
82         </arg>
83     </signal>
84
85   </interface>
86 </node>