Create leading edge buffer where tag is not part of the key (#180)

* Add new leading edge buffer  that does not treat tags as part of the key
* Regen docs

Author: peter-quix

docs/api-reference/csharp/App.Run(CancellationToken,Action).md renamed to docs/api-reference/csharp/App.Run(CancellationToken,Action,bool).md

@@ -1,24 +1,29 @@
 #### [QuixStreams.Streaming](index.md 'index')
 ### [QuixStreams.Streaming](QuixStreams.Streaming.md 'QuixStreams.Streaming').[App](App.md 'QuixStreams.Streaming.App')
 
-## App.Run(CancellationToken, Action) Method
+## App.Run(CancellationToken, Action, bool) Method
 
-Helper method to handle default streaming behaviors and handle automatic resource cleanup on shutdown  
-It also ensures topic consumers defined at the time of invocation are subscribed to receive messages.
+Helper method to handle default streaming behaviors and handle automatic resource cleanup on shutdown
 
 ```csharp
-public static void Run(System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), System.Action beforeShutdown=null);
+public static void Run(System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), System.Action beforeShutdown=null, bool subscribe=true);
 ```
 #### Parameters
 
-<a name='QuixStreams.Streaming.App.Run(System.Threading.CancellationToken,System.Action).cancellationToken'></a>
+<a name='QuixStreams.Streaming.App.Run(System.Threading.CancellationToken,System.Action,bool).cancellationToken'></a>
 
 `cancellationToken` [System.Threading.CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.CancellationToken 'System.Threading.CancellationToken')
 
 The cancellation token to abort. Use when you wish to manually stop streaming for other reason that shutdown.
 
-<a name='QuixStreams.Streaming.App.Run(System.Threading.CancellationToken,System.Action).beforeShutdown'></a>
+<a name='QuixStreams.Streaming.App.Run(System.Threading.CancellationToken,System.Action,bool).beforeShutdown'></a>
 
 `beforeShutdown` [System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action')
 
-The callback to invoke before shutting down
+The callback to invoke before shutting down
+
+<a name='QuixStreams.Streaming.App.Run(System.Threading.CancellationToken,System.Action,bool).subscribe'></a>
+
+`subscribe` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')
+
+Whether the consumer defined should be automatically subscribed to start receiving messages

docs/api-reference/csharp/App.md

@@ -14,5 +14,5 @@ Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.O
 | Methods | |
 | :--- | :--- |
 | [GetStateManager()](App.GetStateManager().md 'QuixStreams.Streaming.App.GetStateManager()') | Retrieves the state manager for the application |
-| [Run(CancellationToken, Action)](App.Run(CancellationToken,Action).md 'QuixStreams.Streaming.App.Run(System.Threading.CancellationToken, System.Action)') | Helper method to handle default streaming behaviors and handle automatic resource cleanup on shutdown<br/>It also ensures topic consumers defined at the time of invocation are subscribed to receive messages. |
+| [Run(CancellationToken, Action, bool)](App.Run(CancellationToken,Action,bool).md 'QuixStreams.Streaming.App.Run(System.Threading.CancellationToken, System.Action, bool)') | Helper method to handle default streaming behaviors and handle automatic resource cleanup on shutdown |
 | [SetStateStorage(IStateStorage)](App.SetStateStorage(IStateStorage).md 'QuixStreams.Streaming.App.SetStateStorage(QuixStreams.State.Storage.IStateStorage)') | Sets the state storage for the app |

docs/api-reference/csharp/IRawTopicConsumer.Subscribe().md

@@ -3,7 +3,7 @@
 
 ## IRawTopicConsumer.Subscribe() Method
 
-Start reading streams.  
+Start reading data from the topic.  
 Use 'OnMessageReceived' event to read messages after executing this method
 
 ```csharp

docs/api-reference/csharp/IRawTopicConsumer.Unsubscribe().md

@@ -0,0 +1,10 @@
+#### [QuixStreams.Streaming](index.md 'index')
+### [QuixStreams.Streaming.Raw](QuixStreams.Streaming.Raw.md 'QuixStreams.Streaming.Raw').[IRawTopicConsumer](IRawTopicConsumer.md 'QuixStreams.Streaming.Raw.IRawTopicConsumer')
+
+## IRawTopicConsumer.Unsubscribe() Method
+
+Stops reading data from the topic.
+
+```csharp
+void Unsubscribe();
+```

docs/api-reference/csharp/IRawTopicConsumer.md

@@ -17,7 +17,8 @@ Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/Syst
 
 | Methods | |
 | :--- | :--- |
-| [Subscribe()](IRawTopicConsumer.Subscribe().md 'QuixStreams.Streaming.Raw.IRawTopicConsumer.Subscribe()') | Start reading streams.<br/>Use 'OnMessageReceived' event to read messages after executing this method |
+| [Subscribe()](IRawTopicConsumer.Subscribe().md 'QuixStreams.Streaming.Raw.IRawTopicConsumer.Subscribe()') | Start reading data from the topic.<br/>Use 'OnMessageReceived' event to read messages after executing this method |
+| [Unsubscribe()](IRawTopicConsumer.Unsubscribe().md 'QuixStreams.Streaming.Raw.IRawTopicConsumer.Unsubscribe()') | Stops reading data from the topic. |
 
 | Events | |
 | :--- | :--- |

docs/api-reference/csharp/ITopicConsumer.Unsubscribe().md

@@ -0,0 +1,10 @@
+#### [QuixStreams.Streaming](index.md 'index')
+### [QuixStreams.Streaming](QuixStreams.Streaming.md 'QuixStreams.Streaming').[ITopicConsumer](ITopicConsumer.md 'QuixStreams.Streaming.ITopicConsumer')
+
+## ITopicConsumer.Unsubscribe() Method
+
+Stops subscribing to streams.
+
+```csharp
+void Unsubscribe();
+```

docs/api-reference/csharp/ITopicConsumer.md

@@ -20,6 +20,7 @@ Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/Syst
 | [Commit()](ITopicConsumer.Commit().md 'QuixStreams.Streaming.ITopicConsumer.Commit()') | Commit packages read up until now |
 | [GetStateManager()](ITopicConsumer.GetStateManager().md 'QuixStreams.Streaming.ITopicConsumer.GetStateManager()') | Gets the manager for the topic states |
 | [Subscribe()](ITopicConsumer.Subscribe().md 'QuixStreams.Streaming.ITopicConsumer.Subscribe()') | Start subscribing to streams.<br/>Use 'OnStreamReceived' event to read stream after executing this method |
+| [Unsubscribe()](ITopicConsumer.Unsubscribe().md 'QuixStreams.Streaming.ITopicConsumer.Unsubscribe()') | Stops subscribing to streams. |
 
 | Events | |
 | :--- | :--- |

docs/api-reference/csharp/LeadingEdgeBuffer.GetOrCreateTimestamp(long,Dictionary_string,string_).md

@@ -6,7 +6,7 @@
 Gets an already buffered row based on timestamp and tags that can be modified or creates a new one if it doesn't exist.
 
 ```csharp
-public QuixStreams.Streaming.Models.LeadingEdgeTimestamp GetOrCreateTimestamp(long timestampInNanoseconds, System.Collections.Generic.Dictionary<string,string> tags=null);
+public QuixStreams.Streaming.Models.LeadingEdgeRow GetOrCreateTimestamp(long timestampInNanoseconds, System.Collections.Generic.Dictionary<string,string> tags=null);
 ```
 #### Parameters
 
@@ -23,4 +23,4 @@ Timestamp in nanoseconds
 Optional Tags
 
 #### Returns
-[LeadingEdgeTimestamp](LeadingEdgeTimestamp.md 'QuixStreams.Streaming.Models.LeadingEdgeTimestamp')
+[LeadingEdgeRow](LeadingEdgeRow.md 'QuixStreams.Streaming.Models.LeadingEdgeRow')

docs/api-reference/csharp/LeadingEdgeBuffer.md

@@ -3,6 +3,8 @@
 
 ## LeadingEdgeBuffer Class
 
+Leading edge buffer where time and tag are treated as a compound key
+
 ```csharp
 public class LeadingEdgeBuffer
 ```

docs/api-reference/csharp/LeadingEdgeTimestamp.AddValue(string,byte[],bool).md renamed to docs/api-reference/csharp/LeadingEdgeRow.AddValue(string,byte[],bool).md

@@ -1,33 +1,33 @@
 #### [QuixStreams.Streaming](index.md 'index')
-### [QuixStreams.Streaming.Models](QuixStreams.Streaming.Models.md 'QuixStreams.Streaming.Models').[LeadingEdgeTimestamp](LeadingEdgeTimestamp.md 'QuixStreams.Streaming.Models.LeadingEdgeTimestamp')
+### [QuixStreams.Streaming.Models](QuixStreams.Streaming.Models.md 'QuixStreams.Streaming.Models').[LeadingEdgeRow](LeadingEdgeRow.md 'QuixStreams.Streaming.Models.LeadingEdgeRow')
 
-## LeadingEdgeTimestamp.AddValue(string, byte[], bool) Method
+## LeadingEdgeRow.AddValue(string, byte[], bool) Method
 
 Adds a value to the row
 
 ```csharp
-public QuixStreams.Streaming.Models.LeadingEdgeTimestamp AddValue(string parameter, byte[] value, bool overwrite=false);
+public QuixStreams.Streaming.Models.LeadingEdgeRow AddValue(string parameter, byte[] value, bool overwrite=false);
 ```
 #### Parameters
 
-<a name='QuixStreams.Streaming.Models.LeadingEdgeTimestamp.AddValue(string,byte[],bool).parameter'></a>
+<a name='QuixStreams.Streaming.Models.LeadingEdgeRow.AddValue(string,byte[],bool).parameter'></a>
 
 `parameter` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
 
 Parameter name
 
-<a name='QuixStreams.Streaming.Models.LeadingEdgeTimestamp.AddValue(string,byte[],bool).value'></a>
+<a name='QuixStreams.Streaming.Models.LeadingEdgeRow.AddValue(string,byte[],bool).value'></a>
 
 `value` [System.Byte](https://docs.microsoft.com/en-us/dotnet/api/System.Byte 'System.Byte')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array')
 
 Value of the parameter
 
-<a name='QuixStreams.Streaming.Models.LeadingEdgeTimestamp.AddValue(string,byte[],bool).overwrite'></a>
+<a name='QuixStreams.Streaming.Models.LeadingEdgeRow.AddValue(string,byte[],bool).overwrite'></a>
 
 `overwrite` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')
 
 If set to true, it will overwrite an existing value for the specified parameter if one already exists.  
             If set to false and a value for the specified parameter already exists, the method ignore the new value and just return the current LeadingEdgeTimestamp instance.
 
 #### Returns
-[LeadingEdgeTimestamp](LeadingEdgeTimestamp.md 'QuixStreams.Streaming.Models.LeadingEdgeTimestamp')
+[LeadingEdgeRow](LeadingEdgeRow.md 'QuixStreams.Streaming.Models.LeadingEdgeRow')