performance fix:

- grid is now updated by a timer every 250ms if necessary instead of for each row - queued update threads exit early if they belong to an obsolete request
PredatH0r · May 23, 2015 · e19c0af · e19c0af
1 parent b8456f4
commit e19c0af
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 28 deletions.
diff --git a/ServerBrowser/ServerBrowserForm.Designer.cs b/ServerBrowser/ServerBrowserForm.Designer.cs
diff --git a/ServerBrowser/ServerBrowserForm.cs b/ServerBrowser/ServerBrowserForm.cs
@@ -46,6 +46,9 @@ public partial class ServerBrowserForm : XtraForm
     private int ignoreUiEvents;
     private readonly CheckEdit[] favGameRadioButtons;
     private readonly List<Game> gameIdForComboBoxIndex = new List<Game>();
+    private volatile bool serverListUpdateNeeded;
+    private const int maxResults = 500;
+    private volatile int currentRequestId; // logical clock to drop obsolete replies, e.g. when the user selected a different game in the meantime
 
     #region ctor()
     public ServerBrowserForm()
@@ -334,15 +337,17 @@ private void UpdateServerList()
       IpFilter filter = new IpFilter();
       filter.App = this.SteamAppID;
       var region = (QueryMaster.Region)steamRegions[this.comboRegion.SelectedIndex * 2 + 1];
-      master.GetAddresses(region, endpoints => OnMasterServerReceive(endpoints, this.SteamAppID), filter);
+
+      var requestId = ++this.currentRequestId;
+      master.GetAddresses(region, endpoints => OnMasterServerReceive(endpoints, requestId), filter);
     }
     #endregion
 
     #region OnMasterServerReceive()
-    private void OnMasterServerReceive(ReadOnlyCollection<IPEndPoint> endPoints, Game queryAppId)
+    private void OnMasterServerReceive(ReadOnlyCollection<IPEndPoint> endPoints, int requestId)
     {
-      // ignore results from older queries with a different appId
-      if (queryAppId != this.SteamAppID)
+      // ignore results from older queries
+      if (requestId != this.currentRequestId)
         return;
 
       string statusText;
@@ -358,67 +363,70 @@ private void OnMasterServerReceive(ReadOnlyCollection<IPEndPoint> endPoints, Gam
           if (ep.Address.Equals(IPAddress.Any))
           {
             statusText = "Master server returned " + this.servers.Count + " servers";
-            AllServersReceived();
+            this.AllServersReceived(requestId);
           }
-          else if (servers.Count >= 1000)
+          else if (servers.Count >= maxResults)
           {
-            statusText = "Server list limited to 1000 entries";
-            AllServersReceived();
+            statusText = "Server list limited to " + maxResults + " entries";
+            this.AllServersReceived(requestId);
             break;
           }
           else
             servers.Add(new ServerRow(ep));
         }
       }
 
+      this.serverListUpdateNeeded = true;
       this.BeginInvoke((Action) (() =>
       {
-        if (statusText != null)
-          this.txtStatus.Caption = statusText;
-        this.gvServers.BeginDataUpdate();
-        this.gvServers.EndDataUpdate();
+        this.txtStatus.Caption = statusText;
       }));
     }
     #endregion
 
     #region AllServersReceived()
-    private void AllServersReceived()
+    private void AllServersReceived(int requestId)
     {
       foreach (var row in this.servers)
       {
         var safeRow = row;
-        ThreadPool.QueueUserWorkItem(context => UpdateServerDetails(safeRow));
+        ThreadPool.QueueUserWorkItem(context => UpdateServerDetails(safeRow, requestId));
       }
     }
     #endregion
 
     #region UpdateServerDetails()
-    private void UpdateServerDetails(ServerRow row, Action callback = null)
-    {     
+    private void UpdateServerDetails(ServerRow row, int requestId, Action callback = null)
+    {
+      if (requestId != this.currentRequestId) // drop obsolete requests
+        return;
+
       Server server = ServerQuery.GetServerInstance(EngineType.Source, row.EndPoint, false, 500, 500);
-      string status = UpdateServerInfo(row, server) && UpdatePlayers(row, server) && UpdateRules(row, server) ? "ok" : "timeout";
+      string status = UpdateServerInfo(row, server, requestId) && UpdatePlayers(row, server, requestId) && UpdateRules(row, server, requestId) ? "ok" : "timeout";
+      if (requestId != this.currentRequestId) // status might have changed
+        return;
+
       if (row.Retries > 0)
         status += " (" + row.Retries + ")";
       row.Status = status;
       row.Update();
 
       if (this.shutdown)
         return;
-      this.BeginInvoke((Action)(() =>
-      {
-        this.gvServers.BeginDataUpdate();
-        this.gvServers.EndDataUpdate();
-        if (callback != null)
-          callback();
-      }));
+      this.serverListUpdateNeeded = true;
+      if (callback != null)
+        this.BeginInvoke(callback);
     }
     #endregion
 
     #region UpdateServerInfo()
-    private bool UpdateServerInfo(ServerRow row, Server server)
+    private bool UpdateServerInfo(ServerRow row, Server server, int requestId)
     {
       for (row.Retries = 0; row.Retries < 3; row.Retries++)
       {
+        if (requestId != this.currentRequestId)
+          return false;
+
         try
         {
           row.Status = "try " + (row.Retries + 1);
@@ -432,8 +440,10 @@ private bool UpdateServerInfo(ServerRow row, Server server)
     #endregion
 
     #region UpdatePlayers()
-    private bool UpdatePlayers(ServerRow row, Server server)
+    private bool UpdatePlayers(ServerRow row, Server server, int requestId)
     {
+      if (requestId != this.currentRequestId)
+        return false;
       for (int attempt=0; attempt < 3; attempt++, row.Retries++)
       {
         try
@@ -450,8 +460,10 @@ private bool UpdatePlayers(ServerRow row, Server server)
     #endregion
 
     #region UpdateRules()
-    private bool UpdateRules(ServerRow row, Server server)
+    private bool UpdateRules(ServerRow row, Server server, int requestId)
     {
+      if (requestId != this.currentRequestId)
+        return false;
       if (this.currentExtension != null && !this.currentExtension.SupportsRules)
         return true;
 
@@ -604,7 +616,7 @@ private void gvServers_FocusedRowChanged(object sender, DevExpress.XtraGrid.View
         Application.DoEvents();
         row.Status = "updating...";
         ThreadPool.QueueUserWorkItem(dummy =>
-          this.UpdateServerDetails(row, () =>
+          this.UpdateServerDetails(row, this.currentRequestId, () =>
           {
             if (this.gvServers.GetRow(this.gvServers.FocusedRowHandle) == row)
               this.UpdateGridDataSources(row);
@@ -644,5 +656,16 @@ private void dockManager1_StartDocking(object sender, DockPanelCancelEventArgs e
         e.Cancel = true;
     }
     #endregion
+
+    #region timerUpdateServerList_Tick
+    private void timerUpdateServerList_Tick(object sender, EventArgs e)
+    {
+      if (!this.serverListUpdateNeeded)
+        return;
+      this.serverListUpdateNeeded = false;
+      this.gvServers.BeginDataUpdate();
+      this.gvServers.EndDataUpdate();
+    }
+    #endregion
   }
 }
diff --git a/ServerBrowser/ServerBrowserForm.resx b/ServerBrowser/ServerBrowserForm.resx
@@ -132,4 +132,7 @@
   <metadata name="dsRules.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
     <value>475, 17</value>
   </metadata>
+  <metadata name="timerUpdateServerList.TrayLocation" type="System.Drawing.Point, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a">
+    <value>568, 17</value>
+  </metadata>
 </root>