Warning, /frameworks/modemmanager-qt/src/dbus/introspection/org.freedesktop.ModemManager1.Bearer.xml is written in an unsupported language. File is not indexed.
0001 <?xml version="1.0" encoding="UTF-8" ?>
0002
0003 <!--
0004 ModemManager 1.0 Interface Specification
0005
0006 Copyright (C) 2011-2013 Red Hat, Inc.
0007 Copyright (C) 2011-2013 Google, Inc.
0008 Copyright (C) 2011-2013 Lanedo GmbH
0009 -->
0010
0011 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
0012
0013 <!--
0014 org.freedesktop.ModemManager1.Bearer:
0015 @short_description: The ModemManager Bearer interface.
0016
0017 This interface provides access to specific actions that may be performed
0018 on available bearers.
0019 -->
0020 <interface name="org.freedesktop.ModemManager1.Bearer">
0021
0022 <!--
0023 Connect:
0024
0025 Requests activation of a packet data connection with the network using
0026 this bearer's properties. Upon successful activation, the modem can
0027 send and receive packet data and, depending on the addressing
0028 capability of the modem, a connection manager may need to start PPP,
0029 perform DHCP, or assign the IP address returned by the modem to the
0030 data interface. Upon successful return, the
0031 #org.freedesktop.ModemManager1.Bearer:Ip4Config
0032 and/or
0033 #org.freedesktop.ModemManager1.Bearer:Ip6Config
0034 properties become valid and may contain IP configuration information for
0035 the data interface associated with this bearer.
0036 -->
0037 <method name="Connect" />
0038
0039 <!--
0040 Disconnect:
0041
0042 Disconnect and deactivate this packet data connection.
0043
0044 Any ongoing data session will be terminated and IP addresses become
0045 invalid when this method is called.
0046 -->
0047 <method name="Disconnect" />
0048
0049 <!--
0050 For 3GPP (GSM/UMTS/LTE) technologies, Bearer objects represent only
0051 Primary PDP contexts; Secondary contexts are not exposed as a concept
0052 because they share everything with their parent primary PDP context
0053 except QoS and traffic flows. Instead, methods for setting QoS and
0054 Traffic Flow Templates (TFTs) should be provided here which could as a
0055 result of being called create secondary PDP contexts with those QoS and
0056 TFT parameters.
0057
0058 FIXME: add methods to set QoS/TFT on the Bearer object, which should
0059 create Secondary contexts if needed, and figure out some method of
0060 disposing of those secondary contexts when no longer required.
0061 -->
0062
0063 <!--
0064 Interface:
0065
0066 The operating system name for the network data interface that provides
0067 packet data using this bearer.
0068
0069 Connection managers must configure this interface depending on the IP
0070 <literal>"method"</literal> given by the
0071 #org.freedesktop.ModemManager1.Bearer:Ip4Config
0072 or
0073 #org.freedesktop.ModemManager1.Bearer:Ip6Config
0074 properties set by bearer activation.
0075
0076 If <link linkend="MM-BEARER-IP-METHOD-STATIC:CAPS">MM_BEARER_IP_METHOD_STATIC</link>
0077 or
0078 <link linkend="MM-BEARER-IP-METHOD-DHCP:CAPS">MM_BEARER_IP_METHOD_DHCP</link>
0079 methods are given, the interface
0080 will be an ethernet-style interface suitable for DHCP or setting static
0081 IP configuration on, while if the
0082 <link linkend="MM-BEARER-IP-METHOD-PPP:CAPS">MM_BEARER_IP_METHOD_PPP</link>
0083 method is given, the interface
0084 will be a serial TTY which must then have PPP run over it.
0085 -->
0086 <property name="Interface" type="s" access="read" />
0087
0088 <!--
0089 Connected:
0090
0091 Indicates whether or not the bearer is connected and thus whether
0092 packet data communication using this bearer is possible.
0093 -->
0094 <property name="Connected" type="b" access="read" />
0095
0096 <!--
0097 Suspended:
0098
0099 In some devices, packet data service will be suspended while the device
0100 is handling other communication, like a voice call. If packet data
0101 service is suspended (but not deactivated) this property will be %TRUE.
0102 -->
0103 <property name="Suspended" type="b" access="read" />
0104
0105 <!--
0106 Ip4Config:
0107
0108 If the bearer was configured for IPv4 addressing, upon activation this
0109 property contains the addressing details for assignment to the data
0110 interface.
0111
0112 Mandatory items include:
0113 <variablelist>
0114 <varlistentry><term><literal>"method"</literal></term>
0115 <listitem>
0116 A <link linkend="MMBearerIpMethod">MMBearerIpMethod</link>,
0117 given as an unsigned integer value (signature <literal>"u"</literal>).
0118 </listitem>
0119 </varlistentry>
0120 </variablelist>
0121
0122 If the bearer specifies configuration via PPP or DHCP, only the
0123 <literal>"method"</literal> item will be present.
0124
0125 Additional items which are only applicable when using the
0126 <link linkend="MM-BEARER-IP-METHOD-STATIC:CAPS">MM_BEARER_IP_METHOD_STATIC</link>
0127 method are:
0128 <variablelist>
0129 <varlistentry><term><literal>"address"</literal></term>
0130 <listitem>
0131 IP address, given as a string value (signature <literal>"s"</literal>).
0132 </listitem>
0133 </varlistentry>
0134 <varlistentry><term><literal>"prefix"</literal></term>
0135 <listitem>
0136 Numeric CIDR network prefix (ie, 24, 32, etc), give as an unsigned integer value (signature <literal>"u"</literal>).
0137 </listitem>
0138 </varlistentry>
0139 <varlistentry><term><literal>"dns1"</literal></term>
0140 <listitem>
0141 IP address of the first DNS server, given as a string value (signature <literal>"s"</literal>).
0142 </listitem>
0143 </varlistentry>
0144 <varlistentry><term><literal>"dns2"</literal></term>
0145 <listitem>
0146 IP address of the second DNS server, given as a string value (signature <literal>"s"</literal>).
0147 </listitem>
0148 </varlistentry>
0149 <varlistentry><term><literal>"dns3"</literal></term>
0150 <listitem>
0151 IP address of the third DNS server, given as a string value (signature <literal>"s"</literal>).
0152 </listitem>
0153 </varlistentry>
0154 <varlistentry><term><literal>"gateway"</literal></term>
0155 <listitem>
0156 IP address of the default gateway, given as a string value (signature <literal>"s"</literal>).
0157 </listitem>
0158 </varlistentry>
0159 </variablelist>
0160 -->
0161 <property name="Ip4Config" type="a{sv}" access="read">
0162 <annotation name="org.qtproject.QtDBus.QtTypeName" value="QVariantMap"/>
0163 </property>
0164
0165 <!--
0166 Ip6Config:
0167
0168 If the bearer was configured for IPv6 addressing, upon activation this
0169 property contains the addressing details for assignment to the data
0170 interface.
0171
0172 Mandatory items include:
0173 <variablelist>
0174 <varlistentry><term><literal>"method"</literal></term>
0175 <listitem>
0176 A <link linkend="MMBearerIpMethod">MMBearerIpMethod</link>,
0177 given as an unsigned integer value (signature <literal>"u"</literal>).
0178 </listitem>
0179 </varlistentry>
0180 </variablelist>
0181
0182 If the bearer specifies configuration via PPP or DHCP, only the
0183 <literal>"method"</literal> item will be present.
0184
0185 Additional items which are only applicable when using the
0186 <link linkend="MM-BEARER-IP-METHOD-STATIC:CAPS">MM_BEARER_IP_METHOD_STATIC</link>
0187 method are:
0188 <variablelist>
0189 <varlistentry><term><literal>"address"</literal></term>
0190 <listitem>
0191 IP address, given as a string value (signature <literal>"s"</literal>).
0192 </listitem>
0193 </varlistentry>
0194 <varlistentry><term><literal>"prefix"</literal></term>
0195 <listitem>
0196 Numeric CIDR network prefix (ie, 24, 32, etc), give as an unsigned integer value (signature <literal>"u"</literal>).
0197 </listitem>
0198 </varlistentry>
0199 <varlistentry><term><literal>"dns1"</literal></term>
0200 <listitem>
0201 IP address of the first DNS server, given as a string value (signature <literal>"s"</literal>).
0202 </listitem>
0203 </varlistentry>
0204 <varlistentry><term><literal>"dns2"</literal></term>
0205 <listitem>
0206 IP address of the second DNS server, given as a string value (signature <literal>"s"</literal>).
0207 </listitem>
0208 </varlistentry>
0209 <varlistentry><term><literal>"dns3"</literal></term>
0210 <listitem>
0211 IP address of the third DNS server, given as a string value (signature <literal>"s"</literal>).
0212 </listitem>
0213 </varlistentry>
0214 <varlistentry><term><literal>"gateway"</literal></term>
0215 <listitem>
0216 IP address of the default gateway, given as a string value (signature <literal>"s"</literal>).
0217 </listitem>
0218 </varlistentry>
0219 </variablelist>
0220 -->
0221 <property name="Ip6Config" type="a{sv}" access="read">
0222 <annotation name="org.qtproject.QtDBus.QtTypeName" value="QVariantMap"/>
0223 </property>
0224
0225 <!--
0226 IpTimeout:
0227
0228 Maximum time to wait for a successful IP establishment, when PPP is used.
0229 -->
0230 <property name="IpTimeout" type="u" access="read" />
0231
0232 <!--
0233 Properties:
0234
0235 List of properties used when creating the bearer.
0236 -->
0237 <property name="Properties" type="a{sv}" access="read">
0238 <annotation name="org.qtproject.QtDBus.QtTypeName" value="QVariantMap"/>
0239 </property>
0240
0241 </interface>
0242 </node>