Top |
org.freedesktop.ModemManager1.Bearerorg.freedesktop.ModemManager1.Bearer — The ModemManager Bearer interface. |
Connect (); Disconnect ();
Interface readable s Connected readable b Suspended readable b Ip4Config readable a{sv} Ip6Config readable a{sv} Stats readable a{sv} IpTimeout readable u BearerType readable u Properties readable a{sv}
This interface provides access to specific actions that may be performed on available bearers.
Connect ();
Requests activation of a packet data connection with the network using this bearer's properties. Upon successful activation, the modem can send and receive packet data and, depending on the addressing capability of the modem, a connection manager may need to start PPP, perform DHCP, or assign the IP address returned by the modem to the data interface. Upon successful return, the "Ip4Config" and/or "Ip6Config" properties become valid and may contain IP configuration information for the data interface associated with this bearer.
Interface readable s
The operating system name for the network data interface that provides packet data using this bearer.
Connection managers must configure this interface depending on the IP
"method"
given by the
"Ip4Config"
or
"Ip6Config"
properties set by bearer activation.
If MM_BEARER_IP_METHOD_STATIC or MM_BEARER_IP_METHOD_DHCP methods are given, the interface will be an ethernet-style interface suitable for DHCP or setting static IP configuration on, while if the MM_BEARER_IP_METHOD_PPP method is given, the interface will be a serial TTY which must then have PPP run over it.
Connected readable b
Indicates whether or not the bearer is connected and thus whether packet data communication using this bearer is possible.
Suspended readable b
In some devices, packet data service will be suspended while the device
is handling other communication, like a voice call. If packet data
service is suspended (but not deactivated) this property will be TRUE
.
Ip4Config readable a{sv}
If the bearer was configured for IPv4 addressing, upon activation this property contains the addressing details for assignment to the data interface.
Mandatory items include:
|
A MMBearerIpMethod,
given as an unsigned integer value (signature "u" ).
|
If the bearer specifies configuration via PPP or DHCP, only the
"method"
item will be present.
Additional items which are only applicable when using the MM_BEARER_IP_METHOD_STATIC method are:
|
IP address, given as a string value (signature "s" ).
|
|
Numeric CIDR network prefix (ie, 24, 32, etc), given as an unsigned integer value (signature "u" ).
|
|
IP address of the first DNS server, given as a string value (signature "s" ).
|
|
IP address of the second DNS server, given as a string value (signature "s" ).
|
|
IP address of the third DNS server, given as a string value (signature "s" ).
|
|
IP address of the default gateway, given as a string value (signature "s" ).
|
This property may also include the following items when such information is available:
|
Maximum transmission unit (MTU), given as an unsigned integer value (signature "u" ).
|
Ip6Config readable a{sv}
If the bearer was configured for IPv6 addressing, upon activation this property contains the addressing details for assignment to the data interface.
Mandatory items include:
|
A MMBearerIpMethod,
given as an unsigned integer value (signature "u" ).
|
If the bearer specifies configuration via PPP or DHCP, often only the
"method"
item will be present. IPv6 SLAAC should
be used to retrieve correct addressing and DNS information via Router
Advertisements and DHCPv6. In some cases an IPv6 Link-Local
"address"
item will be present, which should be
assigned to the data port before performing SLAAC, as the mobile network
may expect SLAAC setup to use this address.
Additional items which are usually only applicable when using the MM_BEARER_IP_METHOD_STATIC method are:
|
IP address, given as a string value (signature "s" ).
|
|
Numeric CIDR network prefix (ie, 24, 32, etc), given as an unsigned integer value (signature "u" ).
|
|
IP address of the first DNS server, given as a string value (signature "s" ).
|
|
IP address of the second DNS server, given as a string value (signature "s" ).
|
|
IP address of the third DNS server, given as a string value (signature "s" ).
|
|
IP address of the default gateway, given as a string value (signature "s" ).
|
This property may also include the following items when such information is available:
|
Maximum transmission unit (MTU), given as an unsigned integer value (signature "u" ).
|
Stats readable a{sv}
If the modem supports it, this property will show statistics associated to the bearer.
There are two main different statistic types reported: either applicable to the ongoing connection, or otherwise compiled for all connections that have been done on this bearer object.
When the connection is disconnected automatically or explicitly by the user, the values applicable to the ongoing connection will show the last values cached.
The following items may appear in the list of statistics:
|
Number of bytes received without error in the ongoing connection,
given as an unsigned 64-bit integer value (signature
"t" ).
|
|
Number of bytes transmitted without error in the ongoing
connection, given as an unsigned 64-bit integer value (signature
"t" ).
|
|
Duration of the ongoing connection, in seconds, given as an
unsigned integer value (signature "u" ).
|
|
Total number of connection attempts done with this bearer, given
as an unsigned integer value (signature "u" ).
|
|
Number of failed connection attempts done with this bearer,
given as an unsigned integer value (signature
"u" ).
|
|
Total number of bytes received without error in all the successful
connection establishments, given as an unsigned 64-bit integer
value (signature "t" ).
|
|
Total number of bytes transmitted without error in all the
successful connection establishments, given as an unsigned 64-bit
integer value (signature "t" ).
|
|
Total duration of all the successful connection establishments, in
seconds, given as an unsigned integer value (signature
"u" ).
|
IpTimeout readable u
Maximum time to wait for a successful IP establishment, when PPP is used.