system/NetworkManager
system/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager synced 2024-10-06 16:21:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

dbus: improve the connectivity check and manager state documentation

Browse source 
This hopefully clears up the confusion between Connectivity and State
properties.
This commit is contained in:
Lubomir Rintel 2017-02-16 11:13:44 +01:00
parent 07bf4151ba
commit 568c4f3e49
2 changed files with 65 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
introspection/org.freedesktop.NetworkManager.xml
View file

@ -395,6 +395,15 @@
The overall state of the NetworkManager daemon.
This takes state of all active connections and the connectivity state into account
to produce a single indicator of the network accessibility status.
The graphical shells may use this property to provide network connection status
indication and applications may use this to check if Internet connection is
accessible. Shell that is able to cope with captive portals should use the
"Connectivity" property to decide whether to present a captive portal authentication
dialog.
Returns: <link linkend="NMState">NMState</link>
-->
<property name="State" type="u" access="read"/>
@ -412,7 +421,19 @@
<!--
Connectivity:
The network connectivity state.
The result of the last connectivity check. The connectivity check is triggered
automatically when a default connection becomes available, periodically and by
calling a CheckConnectivity() method.
This property is in general useful for the graphical shell to determine whether
the Internet access is being hijacked by an authentication gateway (a "captive
portal"). In such case it would typically present a web browser window to give
the user a chance to authenticate and call CheckConnectivity() when the user
submits a form or dismisses the window.
To determine the whether the user is able to access the Internet without dealing
with captive portals (e.g. to provide a network connection indicator or disable
controls that require Internet access), the "State" property is more suitable.
Returns: <link linkend="NMConnectivityState">NMConnectivityState</link>
-->

57
libnm-core/nm-dbus-interface.h
View file

@ -105,14 +105,32 @@ typedef enum {
/**
* NMState:
* @NM_STATE_UNKNOWN: networking state is unknown
* @NM_STATE_ASLEEP: networking is not enabled
* @NM_STATE_DISCONNECTED: there is no active network connection
* @NM_STATE_DISCONNECTING: network connections are being cleaned up
* @NM_STATE_CONNECTING: a network connection is being started
* @NM_STATE_CONNECTED_LOCAL: there is only local IPv4 and/or IPv6 connectivity
* @NM_STATE_CONNECTED_SITE: there is only site-wide IPv4 and/or IPv6 connectivity
* @NM_STATE_CONNECTED_GLOBAL: there is global IPv4 and/or IPv6 Internet connectivity
* @NM_STATE_UNKNOWN: Networking state is unknown. This indicates a daemon error
* that makes it unable to reasonably assess the state. In such event the
* applications are expected to assume Internet connectivity might be present
* and not disable controls that require network access.
* The graphical shells may hide the network accessibility indicator altogether
* since no meaningful status indication can be provided.
* @NM_STATE_ASLEEP: Networking is not enabled, the system is being suspended or
* resumed from suspend.
* @NM_STATE_DISCONNECTED: There is no active network connection.
* The graphical shell should indicate no network connectivity and the
* applications should not attempt to access the network.
* @NM_STATE_DISCONNECTING: Network connections are being cleaned up.
* The applications should tear down their network sessions.
* @NM_STATE_CONNECTING: A network connection is being started
* The graphical shell should indicate the network is being connected while
* the applications should still make no attempts to connect the network.
* @NM_STATE_CONNECTED_LOCAL: There is only local IPv4 and/or IPv6 connectivity,
* but no default route to access the Internet. The graphical shell should
* indicate no network connectivity.
* @NM_STATE_CONNECTED_SITE: There is only site-wide IPv4 and/or IPv6 connectivity.
* This means a default route is available, but the Internet connectivity check
* (see "Connectivity" property) did not succeed. The graphical shell should
* indicate limited network connectivity.
* @NM_STATE_CONNECTED_GLOBAL: There is global IPv4 and/or IPv6 Internet connectivity
* This means the Internet connectivity check succeeded, the graphical shell should
* indicate full network connectivity.
*
* #NMState values indicate the current overall networking state.
**/
@ -129,12 +147,23 @@ typedef enum {
/**
* NMConnectivityState:
* @NM_CONNECTIVITY_UNKNOWN: Network connectivity is unknown.
* @NM_CONNECTIVITY_NONE: The host is not connected to any network.
* @NM_CONNECTIVITY_PORTAL: The host is behind a captive portal and
* cannot reach the full Internet.
* @NM_CONNECTIVITY_LIMITED: The host is connected to a network, but
* does not appear to be able to reach the full Internet.
* @NM_CONNECTIVITY_UNKNOWN: Network connectivity is unknown. This means the
* connectivity checks are disabled (e.g. on server installations) or has
* not run yet. The graphical shell should assume the Internet connection
* might be available and not present a captive portal window.
* @NM_CONNECTIVITY_NONE: The host is not connected to any network. There's
* no active connection that contains a default route to the internet and
* thus it makes no sense to even attempt a connectivity check. The graphical
* shell should use this state to indicate the network connection is unavailable.
* @NM_CONNECTIVITY_PORTAL: The Internet connection is hijacked by a captive
* portal gateway. The graphical shell may open a sandboxed web browser window
* (because the captive portals typically attempt a man-in-the-middle attacks
* agains the https connections) for the purpose of authenticating to a gateway
* and retrigger the connectivity check with CheckConnectivity() when the
* browser window is dismissed.
* @NM_CONNECTIVITY_LIMITED: The host is connected to a network, does not appear
* to be able to reach the full Internet, but a captive portal has not been
* detected.
* @NM_CONNECTIVITY_FULL: The host is connected to a network, and
* appears to be able to reach the full Internet.
*/