telepathy-mission-control: Split connectivity state into the concepts of " up" and "stable"

[Simon McVittie]

Module: telepathy-mission-control
Branch: master
Commit: eb0b99097edaa27a381c79733cd121d3ce68565d
URL:    http://cgit.freedesktop.org/telepathy/telepathy-mission-control/commit/?id=eb0b99097edaa27a381c79733cd121d3ce68565d

Author: Simon McVittie <simon.mcvittie at collabora.co.uk>
Date:   Tue Apr 30 16:54:14 2013 +0100

Split connectivity state into the concepts of "up" and "stable"

ConnMan and GNetworkMonitor only give us two states: either we have
some level of Internet connectivity, or we don't. NetworkManager adds
a third category of states (CONNECTING, DISCONNECTING, ASLEEP):
"you might have connectivity, but things are changing, so you might
want to disconnect now". I've represented this as "not stable".

The flag is deliberately "stable", not "unstable", so that all the
boolean flags have the same sense: if they are TRUE, we're
"more connected".

Bug: https://bugs.freedesktop.org/show_bug.cgi?id=56635
Signed-off-by: Simon McVittie <simon.mcvittie at collabora.co.uk>
Reviewed-by: Guillaume Desmottes <guillaume.desmottes at collabora.co.uk>

---

 src/connectivity-monitor.c |   90 +++++++++++++++++++++++++++----------------
 1 files changed, 56 insertions(+), 34 deletions(-)

diff --git a/src/connectivity-monitor.c b/src/connectivity-monitor.c
index 8d5d8c9..eb728ca 100644
--- a/src/connectivity-monitor.c
+++ b/src/connectivity-monitor.c
@@ -46,6 +46,16 @@
 
 #include "mcd-debug.h"
 
+typedef enum {
+    /* Set if the device is not suspended; clear if it is. */
+    CONNECTIVITY_AWAKE = (1 << 0),
+    /* Set if GNetworkMonitor says we're up. */
+    CONNECTIVITY_UP = (1 << 1),
+    /* Clear if NetworkManager says we're in a shaky state like
+     * disconnecting (the GNetworkMonitor can't tell this). Set otherwise. */
+    CONNECTIVITY_STABLE = (1 << 2)
+} Connectivity;
+
 struct _McdConnectivityMonitorPrivate {
 #ifdef HAVE_NM
   NMClient *nm_client;
@@ -60,11 +70,8 @@ struct _McdConnectivityMonitorPrivate {
   UpClient *upower_client;
 #endif
 
-  gboolean connected;
+  Connectivity connectivity;
   gboolean use_conn;
-
-  /* TRUE if the device is not suspended; FALSE while it is. */
-  gboolean awake;
 };
 
 enum {
@@ -82,35 +89,34 @@ static McdConnectivityMonitor *connectivity_monitor_singleton = NULL;
 
 G_DEFINE_TYPE (McdConnectivityMonitor, mcd_connectivity_monitor, G_TYPE_OBJECT);
 
+static gboolean
+is_connected (Connectivity connectivity)
+{
+  return ((connectivity & CONNECTIVITY_AWAKE) &&
+      (connectivity & CONNECTIVITY_UP) &&
+      (connectivity & CONNECTIVITY_STABLE));
+}
+
 static void
 connectivity_monitor_change_states (
     McdConnectivityMonitor *self,
-    gboolean connected,
-    gboolean awake)
+    Connectivity set,
+    Connectivity clear)
 {
   McdConnectivityMonitorPrivate *priv = self->priv;
-  gboolean old_total = priv->connected && priv->awake;
-  gboolean new_total = connected && awake;
+  Connectivity connectivity = ((priv->connectivity | set) & (~clear));
+  gboolean old_total = is_connected (priv->connectivity);
+  gboolean new_total = is_connected (connectivity);
 
-  if (priv->connected == connected &&
-      priv->awake == awake)
+  if (priv->connectivity == connectivity)
     return;
 
-  priv->connected = connected;
-  priv->awake = awake;
+  priv->connectivity = connectivity;
 
   if (old_total != new_total)
     g_signal_emit (self, signals[STATE_CHANGE], 0, new_total);
 }
 
-static void
-connectivity_monitor_set_connected (
-    McdConnectivityMonitor *self,
-    gboolean connected)
-{
-  connectivity_monitor_change_states (self, connected, self->priv->awake);
-}
-
 #ifdef HAVE_NM
 
 #if !defined(NM_CHECK_VERSION)
@@ -123,7 +129,6 @@ connectivity_monitor_nm_state_change_cb (NMClient *client,
     McdConnectivityMonitor *connectivity_monitor)
 {
   McdConnectivityMonitorPrivate *priv;
-  gboolean new_nm_connected;
   NMState state;
 
   priv = connectivity_monitor->priv;
@@ -132,17 +137,29 @@ connectivity_monitor_nm_state_change_cb (NMClient *client,
     return;
 
   state = nm_client_get_state (priv->nm_client);
-  new_nm_connected = !(state == NM_STATE_CONNECTING
+
+  if (state == NM_STATE_CONNECTING
 #if NM_CHECK_VERSION(0,8,992)
       || state == NM_STATE_DISCONNECTING
 #endif
-      || state == NM_STATE_ASLEEP
-      || state == NM_STATE_DISCONNECTED);
-
-  DEBUG ("New NetworkManager network state %d (connected: %s)", state,
-      new_nm_connected ? "true" : "false");
-
-  connectivity_monitor_set_connected (connectivity_monitor, new_nm_connected);
+      || state == NM_STATE_ASLEEP)
+    {
+      DEBUG ("New NetworkManager network state %d (unstable)", state);
+      connectivity_monitor_change_states (connectivity_monitor,
+          0, CONNECTIVITY_STABLE);
+    }
+  else if (state == NM_STATE_DISCONNECTED)
+    {
+      DEBUG ("New NetworkManager network state %d (stable, down)", state);
+      connectivity_monitor_change_states (connectivity_monitor,
+          CONNECTIVITY_STABLE, CONNECTIVITY_UP);
+    }
+  else
+    {
+      DEBUG ("New NetworkManager network state %d (stable, up)", state);
+      connectivity_monitor_change_states (connectivity_monitor,
+          CONNECTIVITY_STABLE|CONNECTIVITY_UP, 0);
+    }
 }
 #endif
 
@@ -233,7 +250,10 @@ connectivity_monitor_set_awake (
     McdConnectivityMonitor *self,
     gboolean awake)
 {
-  connectivity_monitor_change_states (self, self->priv->connected, awake);
+  if (awake)
+    connectivity_monitor_change_states (self, CONNECTIVITY_AWAKE, 0);
+  else
+    connectivity_monitor_change_states (self, 0, CONNECTIVITY_AWAKE);
 }
 
 static void
@@ -276,7 +296,7 @@ mcd_connectivity_monitor_init (McdConnectivityMonitor *connectivity_monitor)
   connectivity_monitor->priv = priv;
 
   priv->use_conn = TRUE;
-  priv->awake = TRUE;
+  priv->connectivity = CONNECTIVITY_AWAKE | CONNECTIVITY_STABLE;
 
 #ifdef HAVE_NM
   priv->nm_client = nm_client_new ();
@@ -323,7 +343,7 @@ mcd_connectivity_monitor_init (McdConnectivityMonitor *connectivity_monitor)
 #endif
 
 #if !defined(HAVE_NM) && !defined(HAVE_CONNMAN)
-  priv->connected = TRUE;
+  priv->connectivity |= CONNECTIVITY_UP;
 #endif
 
 #ifdef HAVE_UPOWER
@@ -489,7 +509,7 @@ mcd_connectivity_monitor_is_online (McdConnectivityMonitor *connectivity_monitor
 {
   McdConnectivityMonitorPrivate *priv = connectivity_monitor->priv;
 
-  return priv->connected && priv->awake;
+  return is_connected (priv->connectivity);
 }
 
 gboolean
@@ -526,7 +546,9 @@ mcd_connectivity_monitor_set_use_conn (McdConnectivityMonitor *connectivity_moni
   else
 #endif
     {
-      connectivity_monitor_set_connected (connectivity_monitor, TRUE);
+      /* !use_conn basically means "always assume it's stable and up". */
+      connectivity_monitor_change_states (connectivity_monitor,
+          CONNECTIVITY_STABLE|CONNECTIVITY_UP, 0);
     }
 
   g_object_notify (G_OBJECT (connectivity_monitor), "use-conn");