tidying up code & config examples

BlogTalkRadio · Sep 1, 2012 · 87a9273 · 87a9273
1 parent 9f2b158
commit 87a9273
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 25 deletions.
diff --git a/Roque.Common.Interfaces/IRoqueCommander.cs b/Roque.Common.Interfaces/IRoqueCommander.cs
@@ -12,7 +12,7 @@ namespace Cinchcast.Roque.Common
     using System.Text;
 
     /// <summary>
-    /// TODO: Update summary.
+    /// Work service interface example
     /// </summary>
     public interface IRoqueCommander
     {

diff --git a/Roque.Common.Interfaces/ITrace.cs b/Roque.Common.Interfaces/ITrace.cs
@@ -12,7 +12,7 @@ namespace Cinchcast.Roque.Common
     using System.Text;
 
     /// <summary>
-    /// TODO: Update summary.
+    /// Work service interface example
     /// </summary>
     public interface ITrace
     {

diff --git a/Roque.Common.Services/PropertyChangeTracer.cs b/Roque.Common.Services/PropertyChangeTracer.cs
@@ -14,7 +14,8 @@ namespace Cinchcast.Roque.Common
     using System.Text;
 
     /// <summary>
-    /// TODO: Update summary.
+    /// Subscriber class example. All methods starting with "Subscribe" will be called on initialization.
+    /// All events you subscribe to in Subscribe* methods will be routed to the queue you attach this class to. 
     /// </summary>
     public class PropertyChangeTracer
     {

diff --git a/Roque.Common.Services/RoqueCommander.cs b/Roque.Common.Services/RoqueCommander.cs
@@ -14,7 +14,7 @@ namespace Cinchcast.Roque.Common
     using System.Text;
 
     /// <summary>
-    /// TODO: Update summary.
+    /// Work service implementation example
     /// </summary>
     public class RoqueCommander : IRoqueCommander
     {

diff --git a/Roque.Common.Services/Trace.cs b/Roque.Common.Services/Trace.cs
@@ -14,7 +14,7 @@ namespace Cinchcast.Roque.Common
     using System.Text;
 
     /// <summary>
-    /// TODO: Update summary.
+    /// Work service implementation example
     /// </summary>
     public class Trace : ITrace
     {

diff --git a/Roque.Core/DictionaryExtensions.cs b/Roque.Core/DictionaryExtensions.cs
@@ -12,7 +12,7 @@ namespace Cinchcast.Roque.Core
     using System.Text;
 
     /// <summary>
-    /// TODO: Update summary.
+    /// Utility methods to get values from an IDictionary
     /// </summary>
     public static class DictionaryExtensions
     {

diff --git a/Roque.Redis/RedisQueue.cs b/Roque.Redis/RedisQueue.cs
@@ -19,7 +19,7 @@ namespace Cinchcast.Roque.Redis
     using System.Text;
 
     /// <summary>
-    /// TODO: Update summary.
+    /// Redis-based implementation of a <see cref="Queue"/>
     /// </summary>
     public class RedisQueue : Queue, IQueueWithInProgressData
     {

diff --git a/Roque.Service/app.config b/Roque.Service/app.config
@@ -4,50 +4,41 @@
     <section name="roque" type="Cinchcast.Roque.Core.Configuration.Roque, Roque.Core"/>
     <section name="castle" type="Castle.Windsor.Configuration.AppDomain.CastleSectionHandler,Castle.Windsor" />
   </configSections>
-  <appSettings>
-    <add key="KissMetrics_ApiKey" value="NONE"/>
-  </appSettings>
   <roque>
     <queues>
-      <queue name="kissmetrics" type="Cinchcast.Roque.Redis.RedisQueue, Roque.Redis">
-        <settings>
-          <setting key="host" value="localhost"/>
-        </settings>
-      </queue>
-      <queue name="kissmetrics2" type="Cinchcast.Roque.Redis.RedisQueue, Roque.Redis">
-        <settings>
-          <setting key="host" value="localhost"/>
-        </settings>
-      </queue>
-      <queue name="kissmetrics3" type="Cinchcast.Roque.Redis.RedisQueue, Roque.Redis">
+      <!-- define your work queues -->
+      <queue name="main" type="Cinchcast.Roque.Redis.RedisQueue, Roque.Redis">
         <settings>
+          <!-- for RedisQueue available settings are host and port -->
           <setting key="host" value="localhost"/>
         </settings>
       </queue>
+      <!-- default event queue (only necessary on the broadcaster side) -->
       <queue name="_events" type="Cinchcast.Roque.Redis.RedisQueue, Roque.Redis">
         <settings>
           <setting key="host" value="localhost"/>
         </settings>
       </queue>
     </queues>
     <workers>
-      <worker name="main" queue="kissmetrics">
+      <!-- default your workers (on the consumer side) -->
+      <worker name="main" queue="main">
+        <!-- classes that subscribe to events (not necessary when consuming work queues) -->
         <subscribers>
           <subscriber type="Cinchcast.Roque.Common.PropertyChangeTracer, Roque.Common.Services"/>
         </subscribers>
       </worker>
     </workers>
   </roque>
   <castle>
+    <!-- implementations for work queue services (not necessary when consuming events) -->
     <components>
       <component service="Cinchcast.Roque.Common.ITrace" type="Cinchcast.Roque.Common.Trace, Roque.Common.Services"/>
-      <component service="Cinchcast.Btr.RoqueJobs.IKissMetrics" type="Cinchcast.Btr.RoqueJobs.KissMetrics, BTRRoqueJobs"/>
     </components>
   </castle>
   <system.diagnostics>
     <switches>
       <add name="roque" value="Verbose"/>
-      <add name="kissmetrics" value="Verbose"/>
     </switches>
     <trace autoflush="true">
       <listeners>
@@ -59,4 +50,4 @@
   <startup>
     <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/>
   </startup>
-</configuration>
+</configuration>