* Added centralized network error tracking methods to IntelReporter

Author: Jonathan McGee

PleaseIgnore.IntelMap/IntelChannelCollection.cs

@@ -124,14 +124,16 @@ IEnumerator IEnumerable.GetEnumerator() {
         internal void Tick() {
             var now = DateTime.UtcNow;
             var period = parent.ChannelDownloadPeriod;
-            if (!lastDownload.HasValue || now > lastDownload + period) {
+            if ((!lastDownload.HasValue || now > lastDownload + period)
+                    && parent.CanSend(false)) {
                 // Get the updated channel list
-                // TODO: Dial it back on network failures
                 string[] channels = null;
                 try {
                     channels = IntelSession.GetIntelChannels();
-                } catch (WebException) {
-                } catch (IntelException) {
+                } catch (WebException e) {
+                    parent.ReportFailure(e);
+                } catch (IntelException e) {
+                    parent.ReportFailure(e);
                 }
 
                 // Remove stale channels
@@ -154,9 +156,9 @@ internal void Tick() {
                             channel.Rescan();
                             list.Add(channel);
                         }
-                    }
-                }
-            }
+                    } //lock (this.syncRoot) {
+                } //if ((channels != null) && (channels.Length > 0)) {
+            } //if ((!lastDownload.HasValue || now > lastDownload + period)
 
             list.ForEach(x => x.Tick());
         }

PleaseIgnore.IntelMap/IntelReporter.cs

@@ -205,25 +205,42 @@ private void ThreadMain() {
         ///     Gets or sets the TEST Alliance AUTH username.
         /// </summary>
         /// <remarks>
-        ///     Changing the username or password will force a reauthentication
-        ///     against the intel reporting server if the monitoring service is
-        ///     running.  This means that changing both may force two separate
-        ///     authentications.  Use <see cref="Authenticate"/> to change the
-        ///     username and password once the service has already started.
+        ///     Changes to the <see cref="Username"/>, <see cref="Password"/>,
+        ///     or <see cref="PasswordHash"/> will not be used until the next
+        ///     time the client tries to reauthenticate.  To verify that the
+        ///     authentication information is correct, use the
+        ///     <see cref="Authenticate"/> or <see cref="BeginAuthenticate"/>
+        ///     methods.
         /// </remarks>
         [DefaultValue((String)null), Category("Behavior")]
         public string Username { get; set; }
 
         /// <summary>
         ///     Gets or sets the <em>hashed</em> services password for the user.
         /// </summary>
+        /// <remarks>
+        ///     Changes to the <see cref="Username"/>, <see cref="Password"/>,
+        ///     or <see cref="PasswordHash"/> will not be used until the next
+        ///     time the client tries to reauthenticate.  To verify that the
+        ///     authentication information is correct, use the
+        ///     <see cref="Authenticate"/> or <see cref="BeginAuthenticate"/>
+        ///     methods.
+        /// </remarks>
         [DefaultValue((String)null), Category("Behavior")]
         public string PasswordHash { get; set; }
 
         /// <summary>
         ///     Sets the hashed password by automatically hashing and storing the
         ///     plaintext password.
         /// </summary>
+        /// <remarks>
+        ///     Changes to the <see cref="Username"/>, <see cref="Password"/>,
+        ///     or <see cref="PasswordHash"/> will not be used until the next
+        ///     time the client tries to reauthenticate.  To verify that the
+        ///     authentication information is correct, use the
+        ///     <see cref="Authenticate"/> or <see cref="BeginAuthenticate"/>
+        ///     methods.
+        /// </remarks>
         [Browsable(false)]
         public string Password {
             set {
@@ -233,27 +250,6 @@ public string Password {
             }
         }
 
-        /// <summary>
-        ///     Provides the asynchronous implementation of Authenticate()
-        /// </summary>
-        private class AuthenticateAsyncResult : IntelAsyncResult<IntelReporter, bool> {
-            private readonly string username;
-            private readonly string password;
-
-            public AuthenticateAsyncResult(IntelReporter owner, AsyncCallback callback,
-                    object state, string username, string password)
-                    : base(owner, callback, state) {
-                Contract.Requires(username != null);
-                Contract.Requires(password != null);
-                this.username = username;
-                this.password = IntelSession.HashPassword(password);
-            }
-
-            public void Execute() {
-                // TODO: Implement
-            }
-        }
-
         /// <summary>
         ///     Requests that we authenticate with the server under new
         ///     credentials, reporting the results asynchronously.
@@ -336,6 +332,31 @@ public bool EndAuthenticate(IAsyncResult asyncResult) {
         public bool Authenticate(string username, string password) {
             return EndAuthenticate(BeginAuthenticate(username, password, null, null));
         }
+
+        /// <summary>
+        ///     Provides the asynchronous implementation of Authenticate()
+        /// </summary>
+        private class AuthenticateAsyncResult : IntelAsyncResult<IntelReporter, bool> {
+            private readonly string username;
+            private readonly string password;
+
+            public AuthenticateAsyncResult(IntelReporter owner, AsyncCallback callback,
+                    object state, string username, string password)
+                : base(owner, callback, state) {
+                Contract.Requires(username != null);
+                Contract.Requires(password != null);
+                this.username = username;
+                this.password = IntelSession.HashPassword(password);
+            }
+
+            public void Cancel() {
+                // TODO: Implement
+            }
+
+            public void Execute() {
+                // TODO: Implement
+            }
+        }
         #endregion
 
         #region File Monitoring
@@ -506,33 +527,30 @@ public IntelChannelCollection Channels {
         ///     <see langword="true"/> if the intel was sucessfully sent to the
         ///     reporting server; otherwise, <see langword="false"/>.
         /// </returns>
-        internal bool OnIntelReported(IntelEventArgs e) {
-            Contract.Requires(e != null);
+        internal bool OnIntelReported(IntelEventArgs args) {
+            Contract.Requires(args != null);
 
             // Send into the ThreadPool so not to interfere with our processing
-            ThreadPool.QueueUserWorkItem(this.IntelReportedWorkItem, e);
+            ThreadPool.QueueUserWorkItem(this.IntelReportedWorkItem, args);
 
             if (this.CanSend(false)) {
                 // Report the intelligence
                 try {
                     bool success = GetSession()
-                        .Report(e.Channel.Name, e.Timestamp, e.Message);
+                        .Report(args.Channel.Name, args.Timestamp, args.Message);
                     if (success) {
                         ++this.IntelSent;
                         return true;
                     } else {
                         ++this.IntelDropped;
                         return false;
                     }
-                } catch (AuthenticationException) {
-                    // TODO: Record the type of failure
-                    this.lastFailure = DateTime.UtcNow;
-                } catch (IntelException) {
-                    // TODO: Record the type of failure
-                    this.lastFailure = DateTime.UtcNow;
-                } catch (WebException) {
-                    // TODO: Record the type of failure
-                    this.lastFailure = DateTime.UtcNow;
+                } catch (AuthenticationException e) {
+                    this.ReportFailure(e);
+                } catch (IntelException e) {
+                    this.ReportFailure(e);
+                } catch (WebException e) {
+                    this.ReportFailure(e);
                 }
             }
 
@@ -612,7 +630,7 @@ public int Users {
         ///     <see langword="true"/> if we should try to contact the server
         ///     again; otherwise, <see langword="false"/>.
         /// </returns>
-        private bool CanSend(bool throwError) {
+        internal bool CanSend(bool throwError) {
             Contract.EnsuresOnThrow<IntelException>(throwError);
 
             if (!lastFailure.HasValue) {
@@ -631,6 +649,19 @@ private bool CanSend(bool throwError) {
             }
         }
 
+        /// <summary>
+        ///     Reports a communications error with the server, setting the
+        ///     retry timer and notify the client (if required).
+        /// </summary>
+        /// <param name="e">
+        ///     The exception describing the failure.
+        /// </param>
+        internal void ReportFailure(Exception e) {
+            Contract.Requires(e != null);
+            // TODO: Record manner of failure
+            this.lastFailure = DateTime.UtcNow;
+        }
+
         /// <summary>
         ///     Returns the current session, initiating one if it does not already
         ///     exist.  Can throw any exception normally thrown by
@@ -656,9 +687,8 @@ private IntelSession GetSession() {
                 try {
                     this.session = new IntelSession(this.Username, this.PasswordHash);
                     this.lastKeepAlive = DateTime.UtcNow;
-                } catch {
-                    // TODO: Record the type of failure
-                    this.lastFailure = DateTime.UtcNow;
+                } catch(Exception e) {
+                    this.ReportFailure(e);
                     throw;
                 }
             }
@@ -683,12 +713,10 @@ private void KeepAlive() {
                         if (this.session.KeepAlive()) {
                             this.lastKeepAlive = now;
                         }
-                    } catch (IntelException) {
-                        // TODO: Record the type of failure
-                        this.lastFailure = now;
-                    } catch (WebException) {
-                        // TODO: Record the type of failure
-                        this.lastFailure = now;
+                    } catch (IntelException e) {
+                        this.ReportFailure(e);
+                    } catch (WebException e) {
+                        this.ReportFailure(e);
                     }
                 }
             }