Add optional compression feature

Author: ethanhann

docs-src/queuing.md

@@ -93,3 +93,13 @@ What about 3, 4, or 900 queues? Numerous queues gets to be a pain to manage and,
 If it is desirable, different [configuration files](configuration) can be used to run multiple instances of InEngine.NET.
 Simply create a new config file with a new QueueName setting and point inengine.exe at it.
 
+## Message Compression
+
+Messages can be compressed when saved in the queue. 
+It is important to understand the trade-offs of this feature before enabling it.
+Compressing messages takes more CPU resources and might negatively impact queueing throughput if the queued commands do not have a lot of internal state.
+Put simply, if the commands are too small to benefit from being compressed, then compressing them wastes resources.
+ 
+If the commands have a lot of internal state, then this feature will reduce the queue's memory consumption.
+Also, in a high-throughput scenario, where network bandwidth is limited, this feature can greatly reduce the amount of bandwidth used.
+

docs/commands/index.html

@@ -504,7 +504,6 @@ <h2 id="create-a-command">Create a Command<a class="headerlink" href="#create-a-
         <span class="k">public</span> <span class="k">void</span> <span class="nf">Run</span><span class="p">()</span>
         <span class="p">{</span>
             <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="s">&quot;Hello, world!&quot;</span><span class="p">);</span>
-            <span class="k">return</span> <span class="k">new</span> <span class="nf">void</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
         <span class="p">}</span>
     <span class="p">}</span>
 <span class="p">}</span>
@@ -523,7 +522,6 @@ <h2 id="create-a-command">Create a Command<a class="headerlink" href="#create-a-
         <span class="k">public</span> <span class="k">override</span> <span class="k">void</span> <span class="nf">Run</span><span class="p">()</span>
         <span class="p">{</span>
             <span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="s">&quot;Hello, world!&quot;</span><span class="p">);</span>
-            <span class="k">return</span> <span class="k">new</span> <span class="nf">void</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
         <span class="p">}</span>
     <span class="p">}</span>
 <span class="p">}</span>
@@ -663,7 +661,6 @@ <h2 id="logging">Logging<a class="headerlink" href="#logging" title="Permanent l
     <span class="n">Logger</span><span class="p">.</span><span class="n">Warn</span><span class="p">(</span><span class="s">&quot;Sample warning message&quot;</span><span class="p">);</span>
     <span class="n">Logger</span><span class="p">.</span><span class="n">Error</span><span class="p">(</span><span class="s">&quot;Sample error message&quot;</span><span class="p">);</span>
     <span class="n">Logger</span><span class="p">.</span><span class="n">Fatal</span><span class="p">(</span><span class="s">&quot;Sample fatal error message&quot;</span><span class="p">);</span>
-    <span class="k">return</span> <span class="k">new</span> <span class="nf">void</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
 <span class="p">}</span>
 </pre></div>
 
@@ -700,8 +697,6 @@ <h2 id="progress-bar">Progress Bar<a class="headerlink" href="#progress-bar" tit
         <span class="c1">// Update the command&#39;s progress</span>
         <span class="n">UpdateProgress</span><span class="p">(</span><span class="n">i</span><span class="p">);</span>
     <span class="p">}</span>
-
-    <span class="k">return</span> <span class="k">new</span> <span class="nf">void</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
 <span class="p">}</span>
 </pre></div>
 

docs/queuing/index.html

@@ -384,6 +384,13 @@
 
 </li>
 
+        <li class="md-nav__item">
+  <a href="#message-compression" title="Message Compression" class="md-nav__link">
+    Message Compression
+  </a>
+  
+</li>
+      
 
 
     </ul>
@@ -518,6 +525,13 @@
 
 </li>
 
+        <li class="md-nav__item">
+  <a href="#message-compression" title="Message Compression" class="md-nav__link">
+    Message Compression
+  </a>
+  
+</li>
+      
 
 
     </ul>
@@ -606,6 +620,13 @@ <h2 id="primary-and-secondary-queue">Primary and Secondary Queue<a class="header
 <p>What about 3, 4, or 900 queues? Numerous queues gets to be a pain to manage and, practically speaking, is probably unnecessary.
 If it is desirable, different <a href="../configuration">configuration files</a> can be used to run multiple instances of InEngine.NET.
 Simply create a new config file with a new QueueName setting and point inengine.exe at it.</p>
+<h2 id="message-compression">Message Compression<a class="headerlink" href="#message-compression" title="Permanent link">&para;</a></h2>
+<p>Messages can be compressed when saved in the queue. 
+It is important to understand the trade-offs of this feature before enabling it.
+Compressing messages takes more CPU resources and might negatively impact queueing throughput if the queued commands do not have a lot of internal state.
+Put simply, if the commands are too small to benefit from being compressed, then compressing them wastes resources.</p>
+<p>If the commands have a lot of internal state, then this feature will reduce the queue's memory consumption.
+Also, in a high-throughput scenario, where network bandwidth is limited, this feature can greatly reduce the amount of bandwidth used.</p>