aboutsummaryrefslogtreecommitdiff
path: root/introspection
diff options
context:
space:
mode:
authorAleksander Morgado <aleksander@aleksander.es>2020-03-27 16:24:48 +0100
committerAleksander Morgado <aleksander@aleksander.es>2020-04-10 11:45:03 +0000
commitf325ef59020b0acc33b6d05e96c8df7b58373715 (patch)
tree820d9d192275a6f95f4b150eb6fefb11d99f7cb5 /introspection
parentb3ec30403fb813cf3902a02350289e769858f10e (diff)
api,bearer: add 'attempts' and 'failed-attempts' statistics
When we're reusing over and over the same bearer object, we can provide statistical information about the number of connection attempts that have been done and how many of them failed.
Diffstat (limited to 'introspection')
-rw-r--r--introspection/org.freedesktop.ModemManager1.Bearer.xml36
1 files changed, 29 insertions, 7 deletions
diff --git a/introspection/org.freedesktop.ModemManager1.Bearer.xml b/introspection/org.freedesktop.ModemManager1.Bearer.xml
index e86ef00d..b82c9d36 100644
--- a/introspection/org.freedesktop.ModemManager1.Bearer.xml
+++ b/introspection/org.freedesktop.ModemManager1.Bearer.xml
@@ -244,28 +244,50 @@
<!--
Stats:
- If the modem supports it, this property will show statistics of the
- ongoing connection.
+ 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 in this property will show the last values cached.
- The statistics are reset
+ user, the values applicable to the ongoing connection will show the last
+ values cached.
The following items may appear in the list of statistics:
<variablelist>
<varlistentry><term><literal>"rx-bytes"</literal></term>
<listitem>
- Number of bytes received without error, given as an unsigned 64-bit integer value (signature <literal>"t"</literal>).
+ Number of bytes received without error in the ongoing connection,
+ given as an unsigned 64-bit integer value (signature
+ <literal>"t"</literal>).
</listitem>
</varlistentry>
<varlistentry><term><literal>"tx-bytes"</literal></term>
<listitem>
- Number bytes transmitted without error, given as an unsigned 64-bit integer value (signature <literal>"t"</literal>).
+ Number bytes transmitted without error in the ongoing connection,
+ given as an unsigned 64-bit integer value (signature
+ <literal>"t"</literal>).
</listitem>
</varlistentry>
<varlistentry><term><literal>"duration"</literal></term>
<listitem>
- Duration of the connection, in seconds, given as an unsigned integer value (signature <literal>"u"</literal>).
+ Duration of the ongoing connection, in seconds, given as an
+ unsigned integer value (signature <literal>"u"</literal>).
+ </listitem>
+ </varlistentry>
+ <varlistentry><term><literal>"attempts"</literal></term>
+ <listitem>
+ Total number of connection attempts done with this bearer, given
+ as an unsigned integer value (signature <literal>"u"</literal>).
+ </listitem>
+ </varlistentry>
+ <varlistentry><term><literal>"failed-attempts"</literal></term>
+ <listitem>
+ Number of failed connection attempts done with this bearer,
+ given as an unsigned integer value (signature
+ <literal>"u"</literal>).
</listitem>
</varlistentry>
</variablelist>