Stream State initial implementation

docs/api-reference/csharp/App.GetStateManager().md

@@ -0,0 +1,13 @@
+#### [QuixStreams.Streaming](index.md 'index')
+### [QuixStreams.Streaming](QuixStreams.Streaming.md 'QuixStreams.Streaming').[App](App.md 'QuixStreams.Streaming.App')
+
+## App.GetStateManager() Method
+
+Retrieves the state manager for the application
+
+```csharp
+public static QuixStreams.Streaming.States.AppStateManager GetStateManager();
+```
+
+#### Returns
+[AppStateManager](AppStateManager.md 'QuixStreams.Streaming.States.AppStateManager')

docs/api-reference/csharp/App.SetStateStorage(IStateStorage).md

@@ -0,0 +1,17 @@
+#### [QuixStreams.Streaming](index.md 'index')
+### [QuixStreams.Streaming](QuixStreams.Streaming.md 'QuixStreams.Streaming').[App](App.md 'QuixStreams.Streaming.App')
+
+## App.SetStateStorage(IStateStorage) Method
+
+Sets the state storage for the app
+
+```csharp
+public static void SetStateStorage(QuixStreams.State.Storage.IStateStorage stateStorage);
+```
+#### Parameters
+
+<a name='QuixStreams.Streaming.App.SetStateStorage(QuixStreams.State.Storage.IStateStorage).stateStorage'></a>
+
+`stateStorage` [QuixStreams.State.Storage.IStateStorage](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.State.Storage.IStateStorage 'QuixStreams.State.Storage.IStateStorage')
+
+The state storage to use for app's state manager

docs/api-reference/csharp/App.md

@@ -13,4 +13,6 @@ 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. |
+| [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/AppStateManager.AppStateManager(IStateStorage,ILoggerFactory).md

@@ -0,0 +1,23 @@
+#### [QuixStreams.Streaming](index.md 'index')
+### [QuixStreams.Streaming.States](QuixStreams.Streaming.States.md 'QuixStreams.Streaming.States').[AppStateManager](AppStateManager.md 'QuixStreams.Streaming.States.AppStateManager')
+
+## AppStateManager(IStateStorage, ILoggerFactory) Constructor
+
+Initializes a new instance of the AppStateManager class.
+
+```csharp
+public AppStateManager(QuixStreams.State.Storage.IStateStorage storage, Microsoft.Extensions.Logging.ILoggerFactory loggerFactory=null);
+```
+#### Parameters
+
+<a name='QuixStreams.Streaming.States.AppStateManager.AppStateManager(QuixStreams.State.Storage.IStateStorage,Microsoft.Extensions.Logging.ILoggerFactory).storage'></a>
+
+`storage` [QuixStreams.State.Storage.IStateStorage](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.State.Storage.IStateStorage 'QuixStreams.State.Storage.IStateStorage')
+
+The state storage the use for the application state
+
+<a name='QuixStreams.Streaming.States.AppStateManager.AppStateManager(QuixStreams.State.Storage.IStateStorage,Microsoft.Extensions.Logging.ILoggerFactory).loggerFactory'></a>
+
+`loggerFactory` [Microsoft.Extensions.Logging.ILoggerFactory](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.Logging.ILoggerFactory 'Microsoft.Extensions.Logging.ILoggerFactory')
+
+The logger factory to use

docs/api-reference/csharp/AppStateManager.DeleteTopicState(string).md

@@ -0,0 +1,19 @@
+#### [QuixStreams.Streaming](index.md 'index')
+### [QuixStreams.Streaming.States](QuixStreams.Streaming.States.md 'QuixStreams.Streaming.States').[AppStateManager](AppStateManager.md 'QuixStreams.Streaming.States.AppStateManager')
+
+## AppStateManager.DeleteTopicState(string) Method
+
+Deletes the topic state with the specified name
+
+```csharp
+public bool DeleteTopicState(string topicName);
+```
+#### Parameters
+
+<a name='QuixStreams.Streaming.States.AppStateManager.DeleteTopicState(string).topicName'></a>
+
+`topicName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+#### Returns
+[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')  
+Whether the topic state was deleted

docs/api-reference/csharp/AppStateManager.DeleteTopicStates().md

@@ -0,0 +1,14 @@
+#### [QuixStreams.Streaming](index.md 'index')
+### [QuixStreams.Streaming.States](QuixStreams.Streaming.States.md 'QuixStreams.Streaming.States').[AppStateManager](AppStateManager.md 'QuixStreams.Streaming.States.AppStateManager')
+
+## AppStateManager.DeleteTopicStates() Method
+
+Deletes all topic states for the current app.
+
+```csharp
+public int DeleteTopicStates();
+```
+
+#### Returns
+[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32')  
+The number of topic states that were deleted.

docs/api-reference/csharp/AppStateManager.GetTopicStateManager(string).md

@@ -0,0 +1,21 @@
+#### [QuixStreams.Streaming](index.md 'index')
+### [QuixStreams.Streaming.States](QuixStreams.Streaming.States.md 'QuixStreams.Streaming.States').[AppStateManager](AppStateManager.md 'QuixStreams.Streaming.States.AppStateManager')
+
+## AppStateManager.GetTopicStateManager(string) Method
+
+Gets an instance of the [TopicStateManager](TopicStateManager.md 'QuixStreams.Streaming.States.TopicStateManager') class for the specified [topicName](AppStateManager.GetTopicStateManager(string).md#QuixStreams.Streaming.States.AppStateManager.GetTopicStateManager(string).topicName 'QuixStreams.Streaming.States.AppStateManager.GetTopicStateManager(string).topicName').
+
+```csharp
+public QuixStreams.Streaming.States.TopicStateManager GetTopicStateManager(string topicName);
+```
+#### Parameters
+
+<a name='QuixStreams.Streaming.States.AppStateManager.GetTopicStateManager(string).topicName'></a>
+
+`topicName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+The topic name
+
+#### Returns
+[TopicStateManager](TopicStateManager.md 'QuixStreams.Streaming.States.TopicStateManager')  
+The newly created [TopicStateManager](TopicStateManager.md 'QuixStreams.Streaming.States.TopicStateManager') instance.

docs/api-reference/csharp/AppStateManager.GetTopicStates().md

@@ -0,0 +1,14 @@
+#### [QuixStreams.Streaming](index.md 'index')
+### [QuixStreams.Streaming.States](QuixStreams.Streaming.States.md 'QuixStreams.Streaming.States').[AppStateManager](AppStateManager.md 'QuixStreams.Streaming.States.AppStateManager')
+
+## AppStateManager.GetTopicStates() Method
+
+Returns an enumerable collection of all available topic states for the current app.
+
+```csharp
+public System.Collections.Generic.IEnumerable<string> GetTopicStates();
+```
+
+#### Returns
+[System.Collections.Generic.IEnumerable&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')  
+An enumerable collection of string values representing the topic state names.

docs/api-reference/csharp/AppStateManager.md

@@ -0,0 +1,23 @@
+#### [QuixStreams.Streaming](index.md 'index')
+### [QuixStreams.Streaming.States](QuixStreams.Streaming.States.md 'QuixStreams.Streaming.States')
+
+## AppStateManager Class
+
+Manages the states of a app.
+
+```csharp
+public class AppStateManager
+```
+
+Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') 🡒 AppStateManager
+
+| Constructors | |
+| :--- | :--- |
+| [AppStateManager(IStateStorage, ILoggerFactory)](AppStateManager.AppStateManager(IStateStorage,ILoggerFactory).md 'QuixStreams.Streaming.States.AppStateManager.AppStateManager(QuixStreams.State.Storage.IStateStorage, Microsoft.Extensions.Logging.ILoggerFactory)') | Initializes a new instance of the AppStateManager class. |
+
+| Methods | |
+| :--- | :--- |
+| [DeleteTopicState(string)](AppStateManager.DeleteTopicState(string).md 'QuixStreams.Streaming.States.AppStateManager.DeleteTopicState(string)') | Deletes the topic state with the specified name |
+| [DeleteTopicStates()](AppStateManager.DeleteTopicStates().md 'QuixStreams.Streaming.States.AppStateManager.DeleteTopicStates()') | Deletes all topic states for the current app. |
+| [GetTopicStateManager(string)](AppStateManager.GetTopicStateManager(string).md 'QuixStreams.Streaming.States.AppStateManager.GetTopicStateManager(string)') | Gets an instance of the [TopicStateManager](TopicStateManager.md 'QuixStreams.Streaming.States.TopicStateManager') class for the specified [topicName](AppStateManager.GetTopicStateManager(string).md#QuixStreams.Streaming.States.AppStateManager.GetTopicStateManager(string).topicName 'QuixStreams.Streaming.States.AppStateManager.GetTopicStateManager(string).topicName'). |
+| [GetTopicStates()](AppStateManager.GetTopicStates().md 'QuixStreams.Streaming.States.AppStateManager.GetTopicStates()') | Returns an enumerable collection of all available topic states for the current app. |

docs/api-reference/csharp/IKafkaStreamingClient.GetRawTopicConsumer(string,string,Nullable_AutoOffsetReset_).md

@@ -0,0 +1,33 @@
+#### [QuixStreams.Streaming](index.md 'index')
+### [QuixStreams.Streaming](QuixStreams.Streaming.md 'QuixStreams.Streaming').[IKafkaStreamingClient](IKafkaStreamingClient.md 'QuixStreams.Streaming.IKafkaStreamingClient')
+
+## IKafkaStreamingClient.GetRawTopicConsumer(string, string, Nullable<AutoOffsetReset>) Method
+
+Gets a topic consumer capable of subscribing to receive non-quixstreams incoming messages.
+
+```csharp
+QuixStreams.Streaming.Raw.IRawTopicConsumer GetRawTopicConsumer(string topic, string consumerGroup=null, System.Nullable<QuixStreams.Telemetry.Kafka.AutoOffsetReset> autoOffset=null);
+```
+#### Parameters
+
+<a name='QuixStreams.Streaming.IKafkaStreamingClient.GetRawTopicConsumer(string,string,System.Nullable_QuixStreams.Telemetry.Kafka.AutoOffsetReset_).topic'></a>
+
+`topic` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+Name of the topic.
+
+<a name='QuixStreams.Streaming.IKafkaStreamingClient.GetRawTopicConsumer(string,string,System.Nullable_QuixStreams.Telemetry.Kafka.AutoOffsetReset_).consumerGroup'></a>
+
+`consumerGroup` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+The consumer group id to use for consuming messages. If null, consumer group is not used and only consuming new messages.
+
+<a name='QuixStreams.Streaming.IKafkaStreamingClient.GetRawTopicConsumer(string,string,System.Nullable_QuixStreams.Telemetry.Kafka.AutoOffsetReset_).autoOffset'></a>
+
+`autoOffset` [System.Nullable&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[QuixStreams.Telemetry.Kafka.AutoOffsetReset](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Telemetry.Kafka.AutoOffsetReset 'QuixStreams.Telemetry.Kafka.AutoOffsetReset')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')
+
+The offset to use when there is no saved offset for the consumer group.
+
+#### Returns
+[IRawTopicConsumer](IRawTopicConsumer.md 'QuixStreams.Streaming.Raw.IRawTopicConsumer')  
+Instance of [IRawTopicConsumer](IRawTopicConsumer.md 'QuixStreams.Streaming.Raw.IRawTopicConsumer')

docs/api-reference/csharp/IKafkaStreamingClient.GetRawTopicProducer(string).md

@@ -0,0 +1,21 @@
+#### [QuixStreams.Streaming](index.md 'index')
+### [QuixStreams.Streaming](QuixStreams.Streaming.md 'QuixStreams.Streaming').[IKafkaStreamingClient](IKafkaStreamingClient.md 'QuixStreams.Streaming.IKafkaStreamingClient')
+
+## IKafkaStreamingClient.GetRawTopicProducer(string) Method
+
+Gets a topic producer capable of publishing non-quixstreams messages.
+
+```csharp
+QuixStreams.Streaming.Raw.IRawTopicProducer GetRawTopicProducer(string topic);
+```
+#### Parameters
+
+<a name='QuixStreams.Streaming.IKafkaStreamingClient.GetRawTopicProducer(string).topic'></a>
+
+`topic` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+Name of the topic.
+
+#### Returns
+[IRawTopicProducer](IRawTopicProducer.md 'QuixStreams.Streaming.Raw.IRawTopicProducer')  
+Instance of [IRawTopicProducer](IRawTopicProducer.md 'QuixStreams.Streaming.Raw.IRawTopicProducer')

docs/api-reference/csharp/IKafkaStreamingClient.GetTopicConsumer(string,string,CommitOptions,AutoOffsetReset).md

@@ -0,0 +1,39 @@
+#### [QuixStreams.Streaming](index.md 'index')
+### [QuixStreams.Streaming](QuixStreams.Streaming.md 'QuixStreams.Streaming').[IKafkaStreamingClient](IKafkaStreamingClient.md 'QuixStreams.Streaming.IKafkaStreamingClient')
+
+## IKafkaStreamingClient.GetTopicConsumer(string, string, CommitOptions, AutoOffsetReset) Method
+
+Gets a topic consumer capable of subscribing to receive incoming streams.
+
+```csharp
+QuixStreams.Streaming.ITopicConsumer GetTopicConsumer(string topic, string consumerGroup=null, QuixStreams.Transport.Fw.CommitOptions options=null, QuixStreams.Telemetry.Kafka.AutoOffsetReset autoOffset=QuixStreams.Telemetry.Kafka.AutoOffsetReset.Latest);
+```
+#### Parameters
+
+<a name='QuixStreams.Streaming.IKafkaStreamingClient.GetTopicConsumer(string,string,QuixStreams.Transport.Fw.CommitOptions,QuixStreams.Telemetry.Kafka.AutoOffsetReset).topic'></a>
+
+`topic` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+Name of the topic.
+
+<a name='QuixStreams.Streaming.IKafkaStreamingClient.GetTopicConsumer(string,string,QuixStreams.Transport.Fw.CommitOptions,QuixStreams.Telemetry.Kafka.AutoOffsetReset).consumerGroup'></a>
+
+`consumerGroup` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+The consumer group id to use for consuming messages. If null, consumer group is not used and only consuming new messages.
+
+<a name='QuixStreams.Streaming.IKafkaStreamingClient.GetTopicConsumer(string,string,QuixStreams.Transport.Fw.CommitOptions,QuixStreams.Telemetry.Kafka.AutoOffsetReset).options'></a>
+
+`options` [QuixStreams.Transport.Fw.CommitOptions](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Transport.Fw.CommitOptions 'QuixStreams.Transport.Fw.CommitOptions')
+
+The settings to use for committing
+
+<a name='QuixStreams.Streaming.IKafkaStreamingClient.GetTopicConsumer(string,string,QuixStreams.Transport.Fw.CommitOptions,QuixStreams.Telemetry.Kafka.AutoOffsetReset).autoOffset'></a>
+
+`autoOffset` [QuixStreams.Telemetry.Kafka.AutoOffsetReset](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Telemetry.Kafka.AutoOffsetReset 'QuixStreams.Telemetry.Kafka.AutoOffsetReset')
+
+The offset to use when there is no saved offset for the consumer group.
+
+#### Returns
+[ITopicConsumer](ITopicConsumer.md 'QuixStreams.Streaming.ITopicConsumer')  
+Instance of [ITopicConsumer](ITopicConsumer.md 'QuixStreams.Streaming.ITopicConsumer')

docs/api-reference/csharp/IKafkaStreamingClient.GetTopicProducer(string).md

@@ -0,0 +1,21 @@
+#### [QuixStreams.Streaming](index.md 'index')
+### [QuixStreams.Streaming](QuixStreams.Streaming.md 'QuixStreams.Streaming').[IKafkaStreamingClient](IKafkaStreamingClient.md 'QuixStreams.Streaming.IKafkaStreamingClient')
+
+## IKafkaStreamingClient.GetTopicProducer(string) Method
+
+Gets a topic producer capable of publishing stream messages.
+
+```csharp
+QuixStreams.Streaming.ITopicProducer GetTopicProducer(string topic);
+```
+#### Parameters
+
+<a name='QuixStreams.Streaming.IKafkaStreamingClient.GetTopicProducer(string).topic'></a>
+
+`topic` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+Name of the topic.
+
+#### Returns
+[ITopicProducer](ITopicProducer.md 'QuixStreams.Streaming.ITopicProducer')  
+Instance of [ITopicProducer](ITopicProducer.md 'QuixStreams.Streaming.ITopicProducer')

docs/api-reference/csharp/IKafkaStreamingClient.md

@@ -0,0 +1,18 @@
+#### [QuixStreams.Streaming](index.md 'index')
+### [QuixStreams.Streaming](QuixStreams.Streaming.md 'QuixStreams.Streaming')
+
+## IKafkaStreamingClient Interface
+
+```csharp
+public interface IKafkaStreamingClient
+```
+
+Derived  
+↳ [KafkaStreamingClient](KafkaStreamingClient.md 'QuixStreams.Streaming.KafkaStreamingClient')
+
+| Methods | |
+| :--- | :--- |
+| [GetRawTopicConsumer(string, string, Nullable&lt;AutoOffsetReset&gt;)](IKafkaStreamingClient.GetRawTopicConsumer(string,string,Nullable_AutoOffsetReset_).md 'QuixStreams.Streaming.IKafkaStreamingClient.GetRawTopicConsumer(string, string, System.Nullable<QuixStreams.Telemetry.Kafka.AutoOffsetReset>)') | Gets a topic consumer capable of subscribing to receive non-quixstreams incoming messages. |
+| [GetRawTopicProducer(string)](IKafkaStreamingClient.GetRawTopicProducer(string).md 'QuixStreams.Streaming.IKafkaStreamingClient.GetRawTopicProducer(string)') | Gets a topic producer capable of publishing non-quixstreams messages. |
+| [GetTopicConsumer(string, string, CommitOptions, AutoOffsetReset)](IKafkaStreamingClient.GetTopicConsumer(string,string,CommitOptions,AutoOffsetReset).md 'QuixStreams.Streaming.IKafkaStreamingClient.GetTopicConsumer(string, string, QuixStreams.Transport.Fw.CommitOptions, QuixStreams.Telemetry.Kafka.AutoOffsetReset)') | Gets a topic consumer capable of subscribing to receive incoming streams. |
+| [GetTopicProducer(string)](IKafkaStreamingClient.GetTopicProducer(string).md 'QuixStreams.Streaming.IKafkaStreamingClient.GetTopicProducer(string)') | Gets a topic producer capable of publishing stream messages. |

docs/api-reference/csharp/IQuixStreamingClient.GetRawTopicConsumer(string,string,Nullable_AutoOffsetReset_).md

@@ -0,0 +1,33 @@
+#### [QuixStreams.Streaming](index.md 'index')
+### [QuixStreams.Streaming](QuixStreams.Streaming.md 'QuixStreams.Streaming').[IQuixStreamingClient](IQuixStreamingClient.md 'QuixStreams.Streaming.IQuixStreamingClient')
+
+## IQuixStreamingClient.GetRawTopicConsumer(string, string, Nullable<AutoOffsetReset>) Method
+
+Gets a topic consumer capable of subscribing to receive non-quixstreams incoming messages.
+
+```csharp
+QuixStreams.Streaming.Raw.IRawTopicConsumer GetRawTopicConsumer(string topicIdOrName, string consumerGroup=null, System.Nullable<QuixStreams.Telemetry.Kafka.AutoOffsetReset> autoOffset=null);
+```
+#### Parameters
+
+<a name='QuixStreams.Streaming.IQuixStreamingClient.GetRawTopicConsumer(string,string,System.Nullable_QuixStreams.Telemetry.Kafka.AutoOffsetReset_).topicIdOrName'></a>
+
+`topicIdOrName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+Id or name of the topic. If name is provided, workspace will be derived from environment variable or token, in that order
+
+<a name='QuixStreams.Streaming.IQuixStreamingClient.GetRawTopicConsumer(string,string,System.Nullable_QuixStreams.Telemetry.Kafka.AutoOffsetReset_).consumerGroup'></a>
+
+`consumerGroup` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
+
+The consumer group id to use for consuming messages. If null, consumer group is not used and only consuming new messages.
+
+<a name='QuixStreams.Streaming.IQuixStreamingClient.GetRawTopicConsumer(string,string,System.Nullable_QuixStreams.Telemetry.Kafka.AutoOffsetReset_).autoOffset'></a>
+
+`autoOffset` [System.Nullable&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')[QuixStreams.Telemetry.Kafka.AutoOffsetReset](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Telemetry.Kafka.AutoOffsetReset 'QuixStreams.Telemetry.Kafka.AutoOffsetReset')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable`1')
+
+The offset to use when there is no saved offset for the consumer group.
+
+#### Returns
+[IRawTopicConsumer](IRawTopicConsumer.md 'QuixStreams.Streaming.Raw.IRawTopicConsumer')  
+Instance of [IRawTopicConsumer](IRawTopicConsumer.md 'QuixStreams.Streaming.Raw.IRawTopicConsumer')