Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 4 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,10 @@ extra:
link: 'https://www.youtube.com/channel/UCrijXvbQg67m9-le28c7rPA'
analytics:
provider: google-tag-manager
property: GTM-55L66N3 #UA-173360929-3 ignored, using GTM instead of universal analytics
property: GTM-55L66N3
posthog:
host: https://eu.posthog.com
key: phc_UyQcafs2J7OUQEwJrmejeb0vCIdA9i9vYz66suPshix
hotjar:
id: 2437577

Expand Down
8 changes: 8 additions & 0 deletions overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','{{ config.extra.analytics.property }}');</script>
<!-- End Google Tag Manager -->

<!-- POSTHOG -->
<script>
!function(t,e){var o,n,p,r;e.__SV||(window.posthog=e,e._i=[],e.init=function(i,s,a){function g(t,e){var o=e.split(".");2==o.length&&(t=t[o[0]],e=o[1]),t[e]=function(){t.push([e].concat(Array.prototype.slice.call(arguments,0)))}}(p=t.createElement("script")).type="text/javascript",p.async=!0,p.src=s.api_host+"/static/array.js",(r=t.getElementsByTagName("script")[0]).parentNode.insertBefore(p,r);var u=e;for(void 0!==a?u=e[a]=[]:a="posthog",u.people=u.people||[],u.toString=function(t){var e="posthog";return"posthog"!==a&&(e+="."+a),t||(e+=" (stub)"),e},u.people.toString=function(){return u.toString(1)+".people (stub)"},o="capture identify alias people.set people.set_once set_config register register_once unregister opt_out_capturing has_opted_out_capturing opt_in_capturing reset isFeatureEnabled onFeatureFlags".split(" "),n=0;n<o.length;n++)g(u,o[n]);e._i.push([i,s,a])},e.__SV=1)}(document,window.posthog||[]);
posthog.init('{{ config.extra.posthog.key }}', {api_host: '{{ config.extra.posthog.host }}'})
</script>
<!-- End POSTHOG -->

{{ super }}
{% endblock %}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming](QuixStreams.Streaming.md 'QuixStreams.Streaming').[App](App.md 'QuixStreams.Streaming.App')

## App.Run(CancellationToken, Action) 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.

```csharp
public static void Run(System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), System.Action beforeShutdown=null);
```
#### Parameters

<a name='QuixStreams.Streaming.App.Run(System.Threading.CancellationToken,System.Action).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>

`beforeShutdown` [System.Action](https://docs.microsoft.com/en-us/dotnet/api/System.Action 'System.Action')

The callback to invoke before shutting down
16 changes: 16 additions & 0 deletions temp_dir/client-library/api-reference/csharp/App.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming](QuixStreams.Streaming.md 'QuixStreams.Streaming')

## App Class

Provides utilities to handle default streaming behaviors and automatic resource cleanup on shutdown.

```csharp
public static class App
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; App

| Methods | |
| :--- | :--- |
| [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. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming.Utils](QuixStreams.Streaming.Utils.md 'QuixStreams.Streaming.Utils').[CodecSettings](CodecSettings.md 'QuixStreams.Streaming.Utils.CodecSettings')

## CodecSettings.CurrentCodec Field

The currently configured codec

```csharp
public static CodecType CurrentCodec;
```

#### Field Value
[QuixStreams.Telemetry.Models.CodecType](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Telemetry.Models.CodecType 'QuixStreams.Telemetry.Models.CodecType')
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming.Utils](QuixStreams.Streaming.Utils.md 'QuixStreams.Streaming.Utils').[CodecSettings](CodecSettings.md 'QuixStreams.Streaming.Utils.CodecSettings')

## CodecSettings.SetGlobalCodecType(CodecType) Method

Sets the codec type to be used by producers and transfer package value serialization

```csharp
public static void SetGlobalCodecType(QuixStreams.Telemetry.Models.CodecType codecType);
```
#### Parameters

<a name='QuixStreams.Streaming.Utils.CodecSettings.SetGlobalCodecType(QuixStreams.Telemetry.Models.CodecType).codecType'></a>

`codecType` [QuixStreams.Telemetry.Models.CodecType](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Telemetry.Models.CodecType 'QuixStreams.Telemetry.Models.CodecType')
20 changes: 20 additions & 0 deletions temp_dir/client-library/api-reference/csharp/CodecSettings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming.Utils](QuixStreams.Streaming.Utils.md 'QuixStreams.Streaming.Utils')

## CodecSettings Class

Global Codec settings for streams.

```csharp
public static class CodecSettings
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; CodecSettings

| Fields | |
| :--- | :--- |
| [CurrentCodec](CodecSettings.CurrentCodec.md 'QuixStreams.Streaming.Utils.CodecSettings.CurrentCodec') | The currently configured codec |

| Methods | |
| :--- | :--- |
| [SetGlobalCodecType(CodecType)](CodecSettings.SetGlobalCodecType(CodecType).md 'QuixStreams.Streaming.Utils.CodecSettings.SetGlobalCodecType(QuixStreams.Telemetry.Models.CodecType)') | Sets the codec type to be used by producers and transfer package value serialization |
23 changes: 23 additions & 0 deletions temp_dir/client-library/api-reference/csharp/CommitMode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming.Models](QuixStreams.Streaming.Models.md 'QuixStreams.Streaming.Models')

## CommitMode Enum

The mode for committing packages

```csharp
public enum CommitMode
```
### Fields

<a name='QuixStreams.Streaming.Models.CommitMode.Automatic'></a>

`Automatic` 0

The default automatic commit strategy

<a name='QuixStreams.Streaming.Models.CommitMode.Manual'></a>

`Manual` 1

Automatic commit is disabled
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming.Models](QuixStreams.Streaming.Models.md 'QuixStreams.Streaming.Models').[EventData](EventData.md 'QuixStreams.Streaming.Models.EventData')

## EventData.AddTag(string, string) Method

Add a new Tag to the event

```csharp
public QuixStreams.Streaming.Models.EventData AddTag(string tagId, string tagValue);
```
#### Parameters

<a name='QuixStreams.Streaming.Models.EventData.AddTag(string,string).tagId'></a>

`tagId` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')

Tag name

<a name='QuixStreams.Streaming.Models.EventData.AddTag(string,string).tagValue'></a>

`tagValue` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')

Tag value

#### Returns
[EventData](EventData.md 'QuixStreams.Streaming.Models.EventData')
This instance
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming.Models](QuixStreams.Streaming.Models.md 'QuixStreams.Streaming.Models').[EventData](EventData.md 'QuixStreams.Streaming.Models.EventData')

## EventData.AddTags(IEnumerable<KeyValuePair<string,string>>) Method

Copies the tags from the specified dictionary.
Conflicting tags will be overwritten

```csharp
public QuixStreams.Streaming.Models.EventData AddTags(System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,string>> tags);
```
#### Parameters

<a name='QuixStreams.Streaming.Models.EventData.AddTags(System.Collections.Generic.IEnumerable_System.Collections.Generic.KeyValuePair_string,string__).tags'></a>

`tags` [System.Collections.Generic.IEnumerable&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[System.Collections.Generic.KeyValuePair&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.KeyValuePair-2 'System.Collections.Generic.KeyValuePair`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.KeyValuePair-2 'System.Collections.Generic.KeyValuePair`2')[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.KeyValuePair-2 'System.Collections.Generic.KeyValuePair`2')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')

The tags to copy

#### Returns
[EventData](EventData.md 'QuixStreams.Streaming.Models.EventData')
This instance
14 changes: 14 additions & 0 deletions temp_dir/client-library/api-reference/csharp/EventData.Clone().md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming.Models](QuixStreams.Streaming.Models.md 'QuixStreams.Streaming.Models').[EventData](EventData.md 'QuixStreams.Streaming.Models.EventData')

## EventData.Clone() Method

Clones the [EventData](EventData.md 'QuixStreams.Streaming.Models.EventData')

```csharp
public QuixStreams.Streaming.Models.EventData Clone();
```

#### Returns
[EventData](EventData.md 'QuixStreams.Streaming.Models.EventData')
Cloned data
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming.Models](QuixStreams.Streaming.Models.md 'QuixStreams.Streaming.Models').[EventData](EventData.md 'QuixStreams.Streaming.Models.EventData')

## EventData(string, DateTime, string) Constructor

Create a new empty Event Data instance

```csharp
public EventData(string eventId, System.DateTime timestamp, string eventValue);
```
#### Parameters

<a name='QuixStreams.Streaming.Models.EventData.EventData(string,System.DateTime,string).eventId'></a>

`eventId` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')

<a name='QuixStreams.Streaming.Models.EventData.EventData(string,System.DateTime,string).timestamp'></a>

`timestamp` [System.DateTime](https://docs.microsoft.com/en-us/dotnet/api/System.DateTime 'System.DateTime')

<a name='QuixStreams.Streaming.Models.EventData.EventData(string,System.DateTime,string).eventValue'></a>

`eventValue` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming.Models](QuixStreams.Streaming.Models.md 'QuixStreams.Streaming.Models').[EventData](EventData.md 'QuixStreams.Streaming.Models.EventData')

## EventData(string, TimeSpan, string) Constructor

Create a new empty Event Data instance

```csharp
public EventData(string eventId, System.TimeSpan timestamp, string eventValue);
```
#### Parameters

<a name='QuixStreams.Streaming.Models.EventData.EventData(string,System.TimeSpan,string).eventId'></a>

`eventId` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')

<a name='QuixStreams.Streaming.Models.EventData.EventData(string,System.TimeSpan,string).timestamp'></a>

`timestamp` [System.TimeSpan](https://docs.microsoft.com/en-us/dotnet/api/System.TimeSpan 'System.TimeSpan')

<a name='QuixStreams.Streaming.Models.EventData.EventData(string,System.TimeSpan,string).eventValue'></a>

`eventValue` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming.Models](QuixStreams.Streaming.Models.md 'QuixStreams.Streaming.Models').[EventData](EventData.md 'QuixStreams.Streaming.Models.EventData')

## EventData(string, long, string) Constructor

Create a new empty Event Data instance

```csharp
public EventData(string eventId, long timestampNanoseconds, string eventValue);
```
#### Parameters

<a name='QuixStreams.Streaming.Models.EventData.EventData(string,long,string).eventId'></a>

`eventId` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')

<a name='QuixStreams.Streaming.Models.EventData.EventData(string,long,string).timestampNanoseconds'></a>

`timestampNanoseconds` [System.Int64](https://docs.microsoft.com/en-us/dotnet/api/System.Int64 'System.Int64')

<a name='QuixStreams.Streaming.Models.EventData.EventData(string,long,string).eventValue'></a>

`eventValue` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
13 changes: 13 additions & 0 deletions temp_dir/client-library/api-reference/csharp/EventData.Id.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming.Models](QuixStreams.Streaming.Models.md 'QuixStreams.Streaming.Models').[EventData](EventData.md 'QuixStreams.Streaming.Models.EventData')

## EventData.Id Property

The globally unique identifier of the event

```csharp
public string Id { get; set; }
```

#### Property Value
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming.Models](QuixStreams.Streaming.Models.md 'QuixStreams.Streaming.Models').[EventData](EventData.md 'QuixStreams.Streaming.Models.EventData')

## EventData.RemoveTag(string) Method

Remove a Tag from the event

```csharp
public QuixStreams.Streaming.Models.EventData RemoveTag(string tagId);
```
#### Parameters

<a name='QuixStreams.Streaming.Models.EventData.RemoveTag(string).tagId'></a>

`tagId` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')

Tag name

#### Returns
[EventData](EventData.md 'QuixStreams.Streaming.Models.EventData')
This instance
13 changes: 13 additions & 0 deletions temp_dir/client-library/api-reference/csharp/EventData.Tags.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming.Models](QuixStreams.Streaming.Models.md 'QuixStreams.Streaming.Models').[EventData](EventData.md 'QuixStreams.Streaming.Models.EventData')

## EventData.Tags Property

Tags for the timestamp. If key is not found return null

```csharp
public System.Collections.Generic.IDictionary<string,string> Tags { get; set; }
```

#### Property Value
[System.Collections.Generic.IDictionary&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[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.IDictionary-2 'System.Collections.Generic.IDictionary`2')
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming.Models](QuixStreams.Streaming.Models.md 'QuixStreams.Streaming.Models').[EventData](EventData.md 'QuixStreams.Streaming.Models.EventData')

## EventData.Timestamp Property

Gets the timestamp in [System.DateTime](https://docs.microsoft.com/en-us/dotnet/api/System.DateTime 'System.DateTime') format

```csharp
public System.DateTime Timestamp { get; }
```

#### Property Value
[System.DateTime](https://docs.microsoft.com/en-us/dotnet/api/System.DateTime 'System.DateTime')
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming.Models](QuixStreams.Streaming.Models.md 'QuixStreams.Streaming.Models').[EventData](EventData.md 'QuixStreams.Streaming.Models.EventData')

## EventData.TimestampAsTimeSpan Property

Gets the timestamp in [System.TimeSpan](https://docs.microsoft.com/en-us/dotnet/api/System.TimeSpan 'System.TimeSpan') format

```csharp
public System.TimeSpan TimestampAsTimeSpan { get; }
```

#### Property Value
[System.TimeSpan](https://docs.microsoft.com/en-us/dotnet/api/System.TimeSpan 'System.TimeSpan')
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#### [QuixStreams.Streaming](index.md 'index')
### [QuixStreams.Streaming.Models](QuixStreams.Streaming.Models.md 'QuixStreams.Streaming.Models').[EventData](EventData.md 'QuixStreams.Streaming.Models.EventData')

## EventData.TimestampMilliseconds Property

Gets the timestamp in milliseconds

```csharp
public long TimestampMilliseconds { get; }
```

#### Property Value
[System.Int64](https://docs.microsoft.com/en-us/dotnet/api/System.Int64 'System.Int64')
Loading