OpcLabs.MqttNet communication package: Difference between revisions
From OPC Labs Knowledge Base
| Line 150: | Line 150: | ||
|MqttClientTcpOptions.TlsOptions.Certificates | |MqttClientTcpOptions.TlsOptions.Certificates | ||
|System.List<System.Security.Cryptography.X509Certificates.X509Certificate> ''(.NET Framework)''<br/>System.List<System.Byte[]> ''(.NET Standard)'' | |System.List<System.Security.Cryptography.X509Certificates.X509Certificate> ''(.NET Framework)''<br/>System.List<System.Byte[]> ''(.NET Standard)'' | ||
|For " | |For "mqtts", "ssl" URL schemes, may get overwritten by hosting software. | ||
|- | |- | ||
|MqttClientTcpOptions.TlsOptions.CertificateValidationCallback | |MqttClientTcpOptions.TlsOptions.CertificateValidationCallback | ||
|System.Func<System.Security.Cryptography.X509Certificates.X509Certificate, System.Security.Cryptography.X509Certificates.X509Chain, System.Net.Security.SslPolicyErrors, MQTTnet.Client.Options.IMqttClientOptions, System.Boolean> | |System.Func<System.Security.Cryptography.X509Certificates.X509Certificate, System.Security.Cryptography.X509Certificates.X509Chain, System.Net.Security.SslPolicyErrors, MQTTnet.Client.Options.IMqttClientOptions, System.Boolean> | ||
|For " | |For "mqtts", "ssl" URL schemes, may get overwritten by hosting software. | ||
|- | |- | ||
|MqttClientTcpOptions.TlsOptions.IgnoreCertificateChainErrors | |MqttClientTcpOptions.TlsOptions.IgnoreCertificateChainErrors | ||
| Line 170: | Line 170: | ||
|MqttClientTcpOptions.TlsOptions.UseTls | |MqttClientTcpOptions.TlsOptions.UseTls | ||
|System.Boolean | |System.Boolean | ||
|Gets set to false for " | |Gets set to false for "mqtt", "tcp" URL schemes, gets set to true for "mqtts", "ssl" URL scheme. | ||
|- | |- | ||
|MqttClientWebSocketOptions | |MqttClientWebSocketOptions | ||
| Line 196: | Line 196: | ||
|For "ws", "wss" URL schemes, some sub-properties (described here) get overwritten. | |For "ws", "wss" URL schemes, some sub-properties (described here) get overwritten. | ||
|- | |- | ||
|MqttClientWebSocketOptions.TlsOptions. | |MqttClientWebSocketOptions.TlsOptions.AllowUntrustedCertificates | ||
|System.Boolean | |||
| | | | ||
|- | |||
|MqttClientWebSocketOptions.TlsOptions.Certificates | |||
|System.List<System.Security.Cryptography.X509Certificates.X509Certificate> ''(.NET Framework)''<br/>System.List<System.Byte[]> ''(.NET Standard)'' | |||
|For "wss" URL scheme, may get overwritten by hosting software. | |||
|- | |||
|MqttClientWebSocketOptions.TlsOptions.CertificateValidationCallback | |||
|System.Func<System.Security.Cryptography.X509Certificates.X509Certificate, System.Security.Cryptography.X509Certificates.X509Chain, System.Net.Security.SslPolicyErrors, MQTTnet.Client.Options.IMqttClientOptions, System.Boolean> | |||
|For "wss" URL scheme, may get overwritten by hosting software. | |||
|- | |||
|MqttClientWebSocketOptions.TlsOptions.IgnoreCertificateChainErrors | |||
|System.Boolean | |||
| | | | ||
|- | |||
|MqttClientWebSocketOptions.TlsOptions.IgnoreCertificateRevocationErrors | |||
|System.Boolean | |||
| | |||
|- | |||
|MqttClientWebSocketOptions.TlsOptions.SslProtocol | |||
|System.Security.Authentication.SslProtocols | |||
|Default is Tls12. | |||
|- | |||
|MqttClientWebSocketOptions.TlsOptions.UseTls | |||
|System.Boolean | |||
|Gets set to false for "ws" URL scheme, gets set to true for "wss" URL scheme. | |||
|- | |||
|- | |- | ||
|MqttClientWebSocketOptions.Uri | |MqttClientWebSocketOptions.Uri | ||
Revision as of 23:50, 12 December 2019
Configuring the communication package
| ClientWaitTimeout | System.Int32 | |
| ManagedMqttClientOptions | MQTTnet.Extensions.ManagedClient.ManagedMqttClientOptions | |
| ManagedMqttClientOptions.AutoReconnectDelay | System.TimeSpan | Default is 5 seconds. |
| ManagedMqttClientOptions.ClientOptions | MQTTnet.Client.Options.IMqttClientOptions | |
| ManagedMqttClientOptions.ConnectionCheckInterval | System.TimeSpan | Default is 1 second. |
| ManagedMqttClientOptions.MaxPendingMessages | System.Int32 | Default is 2^31-1. |
| ManagedMqttClientOptions.PendingMessagesOverflowStrategy | MQTTnet.Server.MqttPendingMessagesOverflowStrategy | Default is DropNewMessage. |
| ManagedMqttClientOptions.Storage | MQTTnet.Extensions.ManagedClient.IManagedMqttClientStorage | |
| MqttClientOptions | MQTTnet.Client.Options.MqttClientOptions | |
| MqttClientOptions.AuthenticationData | System.Byte[] | |
| MqttClientOptions.AuthenticationMethod | System.String | |
| MqttClientOptions.ChannelOptions | MQTTnet.Client.Options.IMqttClientChannelOptions | Default value is null. For known URL schemes, it gets overwritten by a value determined during URL resolution. For "mqtt", "mqtts", "ssl", "tcp" schemes, value from the MqttClientTcpOptions property is used. For "ws", "wss" schemes, value from the MqttClientWebSocketOptions is used. |
| MqttClientOptions.CleanSession | System.Boolean | Default is true. |
| MqttClientOptions.ClientId | System.String | Default value is null. |
| MqttClientOptions.Credentials | ||
| MqttClientOptions.CommunicationTimeout | System.Timespan | Default is 10 seconds. |
| MqttClientOptions.ExtendedAuthenticationExchangeHandler | MQTTnet.Client.ExtendedAuthenticationExchange.IMqttExtendedAuthenticationExchangeHandler | |
| MqttClientOptions.KeepAlivePeriod | System.Timespan | Default is 15 seconds. |
| MqttClientOptions.KeepAliveSendInterval | System.Nullable<System.TimeSpan> | |
| MqttClientOptions.MaximumPacketSize | System.Nullable<System.UInt32> | |
| MqttClientOptions.ProtocolVersion | MQTTnet.Formatter.MqttProtocolVersion | Default is V311. |
| MqttClientOptions.ReceiveMaximum | System.Nullable<UInt16> | |
| MqttClientOptions.RequestProblemInformation | System.Nullable<System.Boolean> | |
| MqttClientOptions.RequestResponseInformation | System.Nullable<System.Boolean> | |
| MqttClientOptions.SessionExpiryInterval | System.Nullable<System.UInt32> | |
| MqttClientOptions.TopicAliasMaximum | System.Nullable<System.UInt16> | |
| MqttClientOptions.WillDelayInterval | System.Nullable<System.UInt16> | |
| MqttClientTcpOptions | MQTTnet.Client.Options.MqttClientTcpOptions | |
| MqttClientTcpOptions.AddressFamily | System.Net.Sockets.AddressFamily | Default is Unspecified. |
| MqttClientTcpOptions.BufferSize | System.Int32 | Default is 65536. |
| MqttClientTcpOptions.DualMode | System.Nullable<System.Boolean> | |
| MqttClientTcpOptions.NoDelay | System.Boolean | |
| MqttClientTcpOptions.Port | System.Nullable<System.Int32> | |
| MqttClientTcpOptions.Server | System.String | |
| MqttClientTcpOptions.TlsOptions | MQTTnet.Client.Options.MqttClientTlsOptions | For "mqtt", "tcp", "mqtts", "ssl" URL schemes, some sub-properties (described here) get overwritten. |
| MqttClientTcpOptions.TlsOptions.AllowUntrustedCertificates | System.Boolean | |
| MqttClientTcpOptions.TlsOptions.Certificates | System.List<System.Security.Cryptography.X509Certificates.X509Certificate> (.NET Framework) System.List<System.Byte[]> (.NET Standard) |
For "mqtts", "ssl" URL schemes, may get overwritten by hosting software. |
| MqttClientTcpOptions.TlsOptions.CertificateValidationCallback | System.Func<System.Security.Cryptography.X509Certificates.X509Certificate, System.Security.Cryptography.X509Certificates.X509Chain, System.Net.Security.SslPolicyErrors, MQTTnet.Client.Options.IMqttClientOptions, System.Boolean> | For "mqtts", "ssl" URL schemes, may get overwritten by hosting software. |
| MqttClientTcpOptions.TlsOptions.IgnoreCertificateChainErrors | System.Boolean | |
| MqttClientTcpOptions.TlsOptions.IgnoreCertificateRevocationErrors | System.Boolean | |
| MqttClientTcpOptions.TlsOptions.SslProtocol | System.Security.Authentication.SslProtocols | Default is Tls12. |
| MqttClientTcpOptions.TlsOptions.UseTls | System.Boolean | Gets set to false for "mqtt", "tcp" URL schemes, gets set to true for "mqtts", "ssl" URL scheme. |
| MqttClientWebSocketOptions | MQTTnet.Client.Options.MqttClientWebSocketOptions | |
| MqttClientWebSocketOptions.CookieContainer | System.Net.CookieContainer | |
| MqttClientWebSocketOptions.ProxyOptions | MQTTnet.Client.Options.MqttClientWebSocketProxyOptions | |
| MqttClientWebSocketOptions.RequestHeaders | System.Collections.Generic.IDictionary<System.String, System.String> | |
| MqttClientWebSocketOptions.SubProtocols | System.Collections.Generic.ICollection<System.String> | Default is { "mqtt" }. |
| MqttClientWebSocketOptions.TlsOptions | MQTTnet.Client.Options.MqttClientTlsOptions | For "ws", "wss" URL schemes, some sub-properties (described here) get overwritten. |
| MqttClientWebSocketOptions.TlsOptions.AllowUntrustedCertificates | System.Boolean | |
| MqttClientWebSocketOptions.TlsOptions.Certificates | System.List<System.Security.Cryptography.X509Certificates.X509Certificate> (.NET Framework) System.List<System.Byte[]> (.NET Standard) |
For "wss" URL scheme, may get overwritten by hosting software. |
| MqttClientWebSocketOptions.TlsOptions.CertificateValidationCallback | System.Func<System.Security.Cryptography.X509Certificates.X509Certificate, System.Security.Cryptography.X509Certificates.X509Chain, System.Net.Security.SslPolicyErrors, MQTTnet.Client.Options.IMqttClientOptions, System.Boolean> | For "wss" URL scheme, may get overwritten by hosting software. |
| MqttClientWebSocketOptions.TlsOptions.IgnoreCertificateChainErrors | System.Boolean | |
| MqttClientWebSocketOptions.TlsOptions.IgnoreCertificateRevocationErrors | System.Boolean | |
| MqttClientWebSocketOptions.TlsOptions.SslProtocol | System.Security.Authentication.SslProtocols | Default is Tls12. |
| MqttClientWebSocketOptions.TlsOptions.UseTls | System.Boolean | Gets set to false for "ws" URL scheme, gets set to true for "wss" URL scheme. |
| MqttClientWebSocketOptions.Uri | System.String | For "ws", "wss" URL schemes, gets overwritten by the input URL string. |
