Update docs and refactor some core code

Author: ethanhann

docs-src/css/style.css

@@ -1,3 +1,7 @@
+.navbar-brand {
+    background: no-repeat url("/images/inengine-logo-32-alt.png");
+}
+
 .navbar-default {
     background: #0a69fa;
 }

docs-src/queuing.md

@@ -0,0 +1,82 @@
+# Queuing
+
+## Prerequisites
+
+Redis is required to use the InEngine.NET Queue feature. 
+It can be installed on Ubuntu with this command:
+
+```bash
+sudo apt-get install redis-server
+```
+
+Start Redis with this command:
+
+```bash
+sudo service redis start
+```
+
+<div class="alert alert-info">
+It is highly recommended to <a href="https://redis.io/topics/security#authentication-feature">set a password</a> for Redis.
+</div>
+
+## Working with Queues
+
+### Publishing Commands
+
+#### Programmatically
+
+[Commands](commands) can be published programmatically with the **InEngine.Core.Queue.Broker** class:
+
+```csharp
+Broker.Make().Publish(new MyCommand());
+```
+
+#### From the Command Line
+Commands can be published from the command line as well.
+Note that all queue commands reside in the **InEngine.Core** plugin.
+This is an example of how to publish a command from the CLI by specifying the commands assembly, class name, and arguments:
+
+```bash
+InEngineCli.exe -pInEngine.Core queue:publish --command-assembly=MyCommandPlugin.dll --command-class=MyCommand --args "text=bar"
+```
+
+There is an "Echo" command in the *InEngine.Core* package. It is useful for end-to-end testing with the queue feature.
+ 
+```bash
+InEngineCli.exe -pInEngine.Core queue:publish --command-assembly=InEngine.Core.dll --command-class=InEngine.Core.Commands.Echo --args "text=foo"
+```
+
+### Consuming Commands
+
+#### Programmatically
+Consuming a command is also accomplished with the Broker class:
+
+```csharp
+Broker.Make().Consume();
+```
+
+Both methods take an optional second argument to indicate if the secondary queue should be used instead of the primary queue.
+
+```csharp
+// Uses secondary queue.
+Broker.Make().Consume(true);
+```
+
+Commands can be consumed from the command line as well with this simple command:
+
+#### From the Command Line
+
+```bash
+InEngineCli.exe -pInEngine.Core queue:consume
+```
+
+use the **--secondary** switch to consume the secondary queue instead of the primary queue:
+
+```bash
+InEngineCli.exe -pInEngine.Core queue:consume --secondary
+```
+
+#### With the Scheduler
+
+The InEngine scheduler is needed to consume queued messages in the background. 
+There are a variety of [ways to run the scheduler](scheduling/#running-the-scheduler).

docs-src/scheduling.md

@@ -2,7 +2,9 @@
 
 [Commands](commands) can be scheduled to run by leveraging the InEngineScheduler.exe program, available as a download from a recent [release](https://github.com/InEngine-NET/InEngine.NET/releases).
 
-## Manually Running the Scheduler
+## Running the Scheduler
+
+### Manually from the CLI
 
 Running the scheduler from the CommandLine is useful for debugging or local development. Simply run *InEngineScheduler.exe* from the command line.
 
@@ -16,37 +18,37 @@ It can also be run on Mac/Linux with Mono.
 mono InEngineScheduler.exe
 ``` 
 
-## Running as a Windows Service
+### On Windows as a Service
 
 
-### Installing as a Windows Service
+#### Installing
 Run the Install.ps1 PowerShell script in the scheduler directory to install the scheduler in place. The script needs to be run as an administrator. The script will register the service at the location where the script is run. 
 
 ```bash
 ps Install.ps1
 ```
 
-### Uninstalling the Windows Service
+#### Uninstalling
 
 Simply run the **Uninstall.ps1** script with elevated permissions to unregister the service.
 
 ```bash
 ps Uninstall.ps1
 ```
 
-## Running with Supervisor (on Linux)
+### On Linux with Supervisor
 
 Supervisor is a process control system for Linux. It has extensive [documentation](http://supervisord.org/index.html), but the following should be enough to get started.
 
-### Installing Supervisor
+#### Installing Supervisor
 
 This command installs Supervisor on Ubuntu:
 
 ```
 sudo apt-get install supervisor
 ```
 
-### Configuring Supervisor
+#### Configuring Supervisor
 
 Supervisor configuration files are stored in the **/etc/supervisor/conf.d** directory. Multiple files can be created in this directory to specify different programs, or multiple instances of the same program, for Supervisor to monitor. Copy this sample config into a file called **/etc/supervisor/conf.d/inengine-scheduler.conf**. 
 
@@ -63,7 +65,7 @@ redirect_stderr=true
 stdout_logfile=./scheduler.log
 ```
 
-### Starting Supervisor
+#### Starting Supervisor
 
 Whenever a configuration change happens to files in the Supervisor config files, Supervisor needs to be instructed to reload its configuration.
 

docs/404.html

@@ -49,8 +49,22 @@
                     <li >
                         <a href="/">Getting Started</a>
                     </li>
-                    <li >
-                        <a href="/commands/">Commands</a>
+                    <li class="dropdown">
+                        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+                        <ul class="dropdown-menu">
+                            
+<li >
+    <a href="/commands/">Commands</a>
+</li>
+                            
+<li >
+    <a href="/scheduling/">Scheduling</a>
+</li>
+                            
+<li >
+    <a href="/queuing/">Queuing</a>
+</li>
+                        </ul>
                     </li>
                 </ul>
 

docs/commands/index.html

@@ -49,8 +49,22 @@
                     <li >
                         <a href="..">Getting Started</a>
                     </li>
-                    <li class="active">
-                        <a href="./">Commands</a>
+                    <li class="dropdown active">
+                        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+                        <ul class="dropdown-menu">
+                            
+<li class="active">
+    <a href="./">Commands</a>
+</li>
+                            
+<li >
+    <a href="../scheduling/">Scheduling</a>
+</li>
+                            
+<li >
+    <a href="../queuing/">Queuing</a>
+</li>
+                        </ul>
                     </li>
                 </ul>
 
@@ -65,8 +79,8 @@
                             <i class="fa fa-arrow-left"></i> Previous
                         </a>
                     </li>
-                    <li class="disabled">
-                        <a rel="prev" >
+                    <li >
+                        <a rel="prev" href="../scheduling/">
                             Next <i class="fa fa-arrow-right"></i>
                         </a>
                     </li>
@@ -86,9 +100,11 @@
         <li class="main active"><a href="#commands">Commands</a></li>
             <li><a href="#create-a-command">Create a Command</a></li>
             <li><a href="#run-a-command">Run a Command</a></li>
-            <li><a href="#discover-commands-plugins">Discover Commands Plugins</a></li>
+            <li><a href="#discover-command-plugins">Discover Command Plugins</a></li>
             <li><a href="#discover-commands-in-a-plugin">Discover Commands in a Plugin</a></li>
             <li><a href="#print-help-text-for-a-plugins-commands">Print Help Text for a Plugin's Commands</a></li>
+            <li><a href="#logging">Logging</a></li>
+            <li><a href="#progress-bar">Progress Bar</a></li>
     </ul>
 </div></div>
                 <div class="col-md-9" role="main">
@@ -178,7 +194,7 @@ <h2 id="run-a-command">Run a Command</h2>
 <pre><code class="bash">InEngineCli.exe -pMyCommandPlugin my-command
 </code></pre>
 
-<h2 id="discover-commands-plugins">Discover Commands Plugins</h2>
+<h2 id="discover-command-plugins">Discover Command Plugins</h2>
 <p>Run InEngineCli.exe without any arguments to see a list of arguments.</p>
 <pre><code class="text">Available plugins... 
 InEngine.Commands
@@ -191,8 +207,8 @@ <h2 id="discover-commands-in-a-plugin">Discover Commands in a Plugin</h2>
 </code></pre>
 
 <p>The <strong>InEngine.Core</strong> library is itself a plugin that contains queue related commands. 
-This is the help output for the core plugin.</p>
-<pre><code class="text">InEngine 3.1.0
+As an example, this is the help output for the core plugin.</p>
+<pre><code class="text">InEngine 3.x
 Copyright © Ethan Hann 2017
 
   queue:publish    Publish a command message to a queue.
@@ -211,12 +227,79 @@ <h2 id="print-help-text-for-a-plugins-commands">Print Help Text for a Plugin's C
 </code></pre>
 
 <p>The <strong>InEngine.Core</strong> plugin's command to clear the InEngine.NET's queues produces this help message. </p>
-<pre><code class="text">InEngine 3.1.0
+<pre><code class="text">InEngine 3.x
 Copyright © Ethan Hann 2017
 
   --processing-queue    Clear the processing queue.
 
   --secondary           Clear the secondary queue.
+</code></pre>
+
+<h2 id="logging">Logging</h2>
+<p>The <strong>InEngine.Core.AbstractCommand</strong> class provides a Logger property. It implements the <strong>NLog.ILogger</strong> interface.</p>
+<pre><code class="csharp">using System;
+using InEngine.Core;
+
+namespace MyCommandPlugin
+{
+    public class MyCommand : ICommand
+    {
+        public override CommandResult Run()
+        {
+            Logger.Trace(&quot;Sample trace message&quot;);
+            Logger.Debug(&quot;Sample debug message&quot;);
+            Logger.Info(&quot;Sample informational message&quot;);
+            Logger.Warn(&quot;Sample warning message&quot;);
+            Logger.Error(&quot;Sample error message&quot;);
+            Logger.Fatal(&quot;Sample fatal error message&quot;);
+            return new CommandResult(true);
+        }
+    }
+}
+</code></pre>
+
+<p>Setup an <a href="https://github.com/NLog/NLog/wiki/Tutorial#configuration">NLog configuration</a> file, something like this...</p>
+<pre><code class="xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot; ?&gt;
+&lt;nlog xmlns=&quot;http://www.nlog-project.org/schemas/NLog.xsd&quot;
+      xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;&gt;
+
+    &lt;targets&gt;
+        &lt;target name=&quot;logfile&quot; xsi:type=&quot;File&quot; fileName=&quot;file.txt&quot; /&gt;
+        &lt;target name=&quot;console&quot; xsi:type=&quot;Console&quot; /&gt;
+    &lt;/targets&gt;
+
+    &lt;rules&gt;
+        &lt;logger name=&quot;*&quot; minlevel=&quot;Trace&quot; writeTo=&quot;logfile&quot; /&gt;
+        &lt;logger name=&quot;*&quot; minlevel=&quot;Info&quot; writeTo=&quot;console&quot; /&gt;
+    &lt;/rules&gt;
+&lt;/nlog&gt;
+</code></pre>
+
+<h2 id="progress-bar">Progress Bar</h2>
+<p>The <strong>InEngine.Core.AbstractCommand</strong> class provides a ProgressBar property. This is how it is used.</p>
+<pre><code class="csharp">using InEngine.Core;
+
+namespace MyCommandPlugin
+{
+    public class MyCommand : AbstractCommand
+    {
+        public override CommandResult Run()
+        {
+            // Define the ticks (aka steps) for the command...
+            var maxTicks = 100000;
+            SetProgressBarMaxTicks(maxTicks);
+
+            // Do some work...
+            for (var i = 0; i &lt;= maxTicks;i++)
+            {
+                // Update the command's progress
+                UpdateProgress(i);
+            }
+
+            return new CommandResult(true);
+        }
+    }
+}
 </code></pre></div>
         </div>
 

docs/css/style.css

@@ -1,16 +1,20 @@
+.navbar-brand {
+    background: no-repeat url("/images/inengine-logo-32-alt.png");
+}
+
 .navbar-default {
-    background: #2f2f2f;
+    background: #0a69fa;
 }
 
 .navbar-default .navbar-nav > .active > a,
 .navbar-default .navbar-nav > .active > a:hover,
 .navbar-default .navbar-nav > .active > a:focus {
-    background-color: #0f0f0f;
+    background-color: #0a69fa;
 }
 
 .navbar-default .navbar-nav > li > a:hover,
 .navbar-default .navbar-nav > li > a:focus {
-    background-color: #0f0f0f;
+    background-color: #0a69fa;
 }
 
 a,

docs/index.html

@@ -49,8 +49,22 @@
                     <li class="active">
                         <a href=".">Getting Started</a>
                     </li>
-                    <li >
-                        <a href="commands/">Commands</a>
+                    <li class="dropdown">
+                        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+                        <ul class="dropdown-menu">
+                            
+<li >
+    <a href="commands/">Commands</a>
+</li>
+                            
+<li >
+    <a href="scheduling/">Scheduling</a>
+</li>
+                            
+<li >
+    <a href="queuing/">Queuing</a>
+</li>
+                        </ul>
                     </li>
                 </ul>
 
@@ -132,5 +146,5 @@ <h4 class="modal-title" id="exampleModalLabel">Search</h4>
 
 <!--
 MkDocs version : 0.16.3
-Build Date UTC : 2017-11-20 04:36:59
+Build Date UTC : 2017-11-20 23:31:58
 -->