Skip to content

Commit 89b7f21

Browse files
harisboticPeter Nagy
andauthored
Add JSON serialization support (#94)
* Add an option to switch between json and protobuff serialization, default to json * Create an easy build.py for docs and updated docs --------- Co-authored-by: Peter Nagy <[email protected]>
1 parent 482cd10 commit 89b7f21

38 files changed

+15054
-14684
lines changed
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#### [QuixStreams.Streaming](index.md 'index')
2+
### [QuixStreams.Streaming.Utils](QuixStreams.Streaming.Utils.md 'QuixStreams.Streaming.Utils').[CodecSettings](CodecSettings.md 'QuixStreams.Streaming.Utils.CodecSettings')
3+
4+
## CodecSettings.CurrentCodec Field
5+
6+
The currently configured codec
7+
8+
```csharp
9+
public static CodecType CurrentCodec;
10+
```
11+
12+
#### Field Value
13+
[QuixStreams.Telemetry.Models.CodecType](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Telemetry.Models.CodecType 'QuixStreams.Telemetry.Models.CodecType')
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#### [QuixStreams.Streaming](index.md 'index')
2+
### [QuixStreams.Streaming.Utils](QuixStreams.Streaming.Utils.md 'QuixStreams.Streaming.Utils').[CodecSettings](CodecSettings.md 'QuixStreams.Streaming.Utils.CodecSettings')
3+
4+
## CodecSettings.SetGlobalCodecType(CodecType) Method
5+
6+
Sets the codec type to be used by producers and transfer package value serialization
7+
8+
```csharp
9+
public static void SetGlobalCodecType(QuixStreams.Telemetry.Models.CodecType codecType);
10+
```
11+
#### Parameters
12+
13+
<a name='QuixStreams.Streaming.Utils.CodecSettings.SetGlobalCodecType(QuixStreams.Telemetry.Models.CodecType).codecType'></a>
14+
15+
`codecType` [QuixStreams.Telemetry.Models.CodecType](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Telemetry.Models.CodecType 'QuixStreams.Telemetry.Models.CodecType')
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
#### [QuixStreams.Streaming](index.md 'index')
2+
### [QuixStreams.Streaming.Utils](QuixStreams.Streaming.Utils.md 'QuixStreams.Streaming.Utils')
3+
4+
## CodecSettings Class
5+
6+
Global Codec settings for streams.
7+
8+
```csharp
9+
public static class CodecSettings
10+
```
11+
12+
Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; CodecSettings
13+
14+
| Fields | |
15+
| :--- | :--- |
16+
| [CurrentCodec](CodecSettings.CurrentCodec.md 'QuixStreams.Streaming.Utils.CodecSettings.CurrentCodec') | The currently configured codec |
17+
18+
| Methods | |
19+
| :--- | :--- |
20+
| [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 |

docs/api-reference/csharp/EventData.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.O
1313
1414
| Constructors | |
1515
| :--- | :--- |
16-
| [EventData(string, long, string)](EventData.EventData(string,long,string).md 'QuixStreams.Streaming.Models.EventData.EventData(string, long, string)') | Create a new empty Event Data instance |
1716
| [EventData(string, DateTime, string)](EventData.EventData(string,DateTime,string).md 'QuixStreams.Streaming.Models.EventData.EventData(string, System.DateTime, string)') | Create a new empty Event Data instance |
1817
| [EventData(string, TimeSpan, string)](EventData.EventData(string,TimeSpan,string).md 'QuixStreams.Streaming.Models.EventData.EventData(string, System.TimeSpan, string)') | Create a new empty Event Data instance |
18+
| [EventData(string, long, string)](EventData.EventData(string,long,string).md 'QuixStreams.Streaming.Models.EventData.EventData(string, long, string)') | Create a new empty Event Data instance |
1919

2020
| Properties | |
2121
| :--- | :--- |

docs/api-reference/csharp/KafkaStreamingClient.KafkaStreamingClient(string,SecurityOptions,IDictionary_string,string_,bool).md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ Additional broker properties
3232

3333
`debug` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')
3434

35-
Whether debugging should enabled
35+
Whether debugging should be enabled

docs/api-reference/csharp/QuixStreams.Streaming.Utils.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44

55
| Classes | |
66
| :--- | :--- |
7+
| [CodecSettings](CodecSettings.md 'QuixStreams.Streaming.Utils.CodecSettings') | Global Codec settings for streams. |
78
| [QuixUtils](QuixUtils.md 'QuixStreams.Streaming.Utils.QuixUtils') | Quix extension methods used across the library |
89

910
| Structs | |
1011
| :--- | :--- |
11-
| [TimeseriesDataTimestamps](TimeseriesDataTimestamps.md 'QuixStreams.Streaming.Utils.TimeseriesDataTimestamps') | Enumerable which returns the Timestamps of the current [QuixStreams.Streaming.Utils.TimeseriesDataTimestamps.TimeseriesData](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Streaming.Utils.TimeseriesDataTimestamps.TimeseriesData 'QuixStreams.Streaming.Utils.TimeseriesDataTimestamps.TimeseriesData') |
1212
| [TimeseriesDataTimestampTags](TimeseriesDataTimestampTags.md 'QuixStreams.Streaming.Utils.TimeseriesDataTimestampTags') | ReadOnlyDictionary which returns the Tags of the current Timestamp |
13+
| [TimeseriesDataTimestamps](TimeseriesDataTimestamps.md 'QuixStreams.Streaming.Utils.TimeseriesDataTimestamps') | Enumerable which returns the Timestamps of the current [QuixStreams.Streaming.Utils.TimeseriesDataTimestamps.TimeseriesData](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Streaming.Utils.TimeseriesDataTimestamps.TimeseriesData 'QuixStreams.Streaming.Utils.TimeseriesDataTimestamps.TimeseriesData') |

docs/api-reference/csharp/RawMessage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.O
1313
1414
| Constructors | |
1515
| :--- | :--- |
16-
| [RawMessage(byte[], byte[])](RawMessage.RawMessage(byte[],byte[]).md 'QuixStreams.Streaming.Raw.RawMessage.RawMessage(byte[], byte[])') | Initializes a new instance of [RawMessage](RawMessage.md 'QuixStreams.Streaming.Raw.RawMessage') |
1716
| [RawMessage(byte[])](RawMessage.RawMessage(byte[]).md 'QuixStreams.Streaming.Raw.RawMessage.RawMessage(byte[])') | Initializes a new instance of [RawMessage](RawMessage.md 'QuixStreams.Streaming.Raw.RawMessage') without a Key |
17+
| [RawMessage(byte[], byte[])](RawMessage.RawMessage(byte[],byte[]).md 'QuixStreams.Streaming.Raw.RawMessage.RawMessage(byte[], byte[])') | Initializes a new instance of [RawMessage](RawMessage.md 'QuixStreams.Streaming.Raw.RawMessage') |
1818

1919
| Fields | |
2020
| :--- | :--- |

docs/api-reference/csharp/SecurityOptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,6 @@ Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.O
2121
| [Password](SecurityOptions.Password.md 'QuixStreams.Streaming.Configuration.SecurityOptions.Password') | The password for SASL authentication |
2222
| [SaslMechanism](SecurityOptions.SaslMechanism.md 'QuixStreams.Streaming.Configuration.SecurityOptions.SaslMechanism') | The SASL mechanism to use. |
2323
| [SslCertificates](SecurityOptions.SslCertificates.md 'QuixStreams.Streaming.Configuration.SecurityOptions.SslCertificates') | The path to the folder or file containing the certificate authority certificate(s) to validate the ssl connection. |
24-
| [Username](SecurityOptions.Username.md 'QuixStreams.Streaming.Configuration.SecurityOptions.Username') | The username for SASL authentication. |
2524
| [UseSasl](SecurityOptions.UseSasl.md 'QuixStreams.Streaming.Configuration.SecurityOptions.UseSasl') | Use authentication |
2625
| [UseSsl](SecurityOptions.UseSsl.md 'QuixStreams.Streaming.Configuration.SecurityOptions.UseSsl') | Use SSL |
26+
| [Username](SecurityOptions.Username.md 'QuixStreams.Streaming.Configuration.SecurityOptions.Username') | The username for SASL authentication. |

docs/api-reference/csharp/TimeseriesData.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.O
1313
1414
| Constructors | |
1515
| :--- | :--- |
16-
| [TimeseriesData(int)](TimeseriesData.TimeseriesData(int).md 'QuixStreams.Streaming.Models.TimeseriesData.TimeseriesData(int)') | Create a new empty Timeseries Data instance to allow create new timestamps and parameters values from scratch |
1716
| [TimeseriesData(TimeseriesDataRaw, string[], bool, bool)](TimeseriesData.TimeseriesData(TimeseriesDataRaw,string[],bool,bool).md 'QuixStreams.Streaming.Models.TimeseriesData.TimeseriesData(QuixStreams.Telemetry.Models.TimeseriesDataRaw, string[], bool, bool)') | Creates a new instance of [TimeseriesData](TimeseriesData.md 'QuixStreams.Streaming.Models.TimeseriesData') based on a [QuixStreams.Telemetry.Models.TimeseriesDataRaw](https://docs.microsoft.com/en-us/dotnet/api/QuixStreams.Telemetry.Models.TimeseriesDataRaw 'QuixStreams.Telemetry.Models.TimeseriesDataRaw') instance |
1817
| [TimeseriesData(List&lt;TimeseriesDataTimestamp&gt;, bool, bool)](TimeseriesData.TimeseriesData(List_TimeseriesDataTimestamp_,bool,bool).md 'QuixStreams.Streaming.Models.TimeseriesData.TimeseriesData(System.Collections.Generic.List<QuixStreams.Streaming.Models.TimeseriesDataTimestamp>, bool, bool)') | Creates a new instance of [TimeseriesData](TimeseriesData.md 'QuixStreams.Streaming.Models.TimeseriesData') with the provided timestamps |
18+
| [TimeseriesData(int)](TimeseriesData.TimeseriesData(int).md 'QuixStreams.Streaming.Models.TimeseriesData.TimeseriesData(int)') | Create a new empty Timeseries Data instance to allow create new timestamps and parameters values from scratch |
1919

2020
| Properties | |
2121
| :--- | :--- |

docs/api-reference/csharp/TimeseriesDataTimestamp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ public readonly struct TimeseriesDataTimestamp
2222
| :--- | :--- |
2323
| [AddTag(string, string)](TimeseriesDataTimestamp.AddTag(string,string).md 'QuixStreams.Streaming.Models.TimeseriesDataTimestamp.AddTag(string, string)') | Adds a tag to the values |
2424
| [AddTags(IEnumerable&lt;KeyValuePair&lt;string,string&gt;&gt;)](TimeseriesDataTimestamp.AddTags(IEnumerable_KeyValuePair_string,string__).md 'QuixStreams.Streaming.Models.TimeseriesDataTimestamp.AddTags(System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string,string>>)') | Copies the tags from the specified dictionary.<br/>Conflicting tags will be overwritten |
25+
| [AddValue(string, ParameterValue)](TimeseriesDataTimestamp.AddValue(string,ParameterValue).md 'QuixStreams.Streaming.Models.TimeseriesDataTimestamp.AddValue(string, QuixStreams.Streaming.Models.ParameterValue)') | Adds a new value. |
2526
| [AddValue(string, byte[])](TimeseriesDataTimestamp.AddValue(string,byte[]).md 'QuixStreams.Streaming.Models.TimeseriesDataTimestamp.AddValue(string, byte[])') | Adds a new binary value. |
2627
| [AddValue(string, double)](TimeseriesDataTimestamp.AddValue(string,double).md 'QuixStreams.Streaming.Models.TimeseriesDataTimestamp.AddValue(string, double)') | Adds a new numeric value. |
27-
| [AddValue(string, ParameterValue)](TimeseriesDataTimestamp.AddValue(string,ParameterValue).md 'QuixStreams.Streaming.Models.TimeseriesDataTimestamp.AddValue(string, QuixStreams.Streaming.Models.ParameterValue)') | Adds a new value. |
2828
| [AddValue(string, string)](TimeseriesDataTimestamp.AddValue(string,string).md 'QuixStreams.Streaming.Models.TimeseriesDataTimestamp.AddValue(string, string)') | Adds a new string value. |
2929
| [RemoveTag(string)](TimeseriesDataTimestamp.RemoveTag(string).md 'QuixStreams.Streaming.Models.TimeseriesDataTimestamp.RemoveTag(string)') | Removes a tag from the values |
3030
| [RemoveValue(string)](TimeseriesDataTimestamp.RemoveValue(string).md 'QuixStreams.Streaming.Models.TimeseriesDataTimestamp.RemoveValue(string)') | Removes a parameter value. |

0 commit comments

Comments
 (0)