Class MqttClientWebSocketConfiguration

The configuration of the websocket connection to the MQTT message broker.

Inheritance
object
MqttClientChannelConfiguration
MqttClientWebSocketConfiguration
Inherited Members
Namespace: Silverback.Messaging.Configuration.Mqtt
Assembly: Silverback.Integration.MQTT.dll
Syntax
public record MqttClientWebSocketConfiguration : MqttClientChannelConfiguration, IValidatableSettings, IEquatable<MqttClientChannelConfiguration>, IEquatable<MqttClientWebSocketConfiguration>

Constructors

MqttClientWebSocketConfiguration()

The configuration of the websocket connection to the MQTT message broker.

Declaration
public MqttClientWebSocketConfiguration()

MqttClientWebSocketConfiguration(MqttClientWebSocketConfiguration)

The configuration of the websocket connection to the MQTT message broker.

Declaration
protected MqttClientWebSocketConfiguration(MqttClientWebSocketConfiguration original)
Parameters
Type Name Description
MqttClientWebSocketConfiguration original

Properties

CookieContainer

Gets the cookies associated with the request.

Declaration
public CookieContainer? CookieContainer { get; init; }
Property Value
Type Description
CookieContainer

Credentials

Gets the credentials to be used.

Declaration
public ICredentials? Credentials { get; init; }
Property Value
Type Description
ICredentials

DangerousDeflateOptions

Gets the WebSocketDeflateOptions.

Declaration
public WebSocketDeflateOptions? DangerousDeflateOptions { get; init; }
Property Value
Type Description
WebSocketDeflateOptions

EqualityContract

The configuration of the websocket connection to the MQTT message broker.

Declaration
protected override Type EqualityContract { get; }
Property Value
Type Description
Type
Overrides

KeepAliveInterval

Gets the keep alive interval for the web socket connection. This is not related to the keep alive interval for the MQTT protocol. The default is DefaultKeepAliveInterval.

Declaration
public TimeSpan KeepAliveInterval { get; init; }
Property Value
Type Description
TimeSpan

Proxy

Gets the proxy configuration.

Declaration
public MqttClientWebSocketProxyConfiguration? Proxy { get; init; }
Property Value
Type Description
MqttClientWebSocketProxyConfiguration

RequestHeaders

Gets the request headers.

Declaration
public IDictionary<string, string>? RequestHeaders { get; init; }
Property Value
Type Description
IDictionary<string, string>

SubProtocols

Gets the sub-protocols to be negotiated during the WebSocket connection handshake.

Declaration
public ICollection<string>? SubProtocols { get; init; }
Property Value
Type Description
ICollection<string>

Uri

Gets the server URI.

Declaration
public string? Uri { get; init; }
Property Value
Type Description
string

UseDefaultCredentials

Gets a value indicating whether the default (system) credentials should be used. The default is false.

Declaration
public bool UseDefaultCredentials { get; init; }
Property Value
Type Description
bool

Methods

Equals(MqttClientChannelConfiguration?)

The configuration of the websocket connection to the MQTT message broker.

Declaration
public override sealed bool Equals(MqttClientChannelConfiguration? other)
Parameters
Type Name Description
MqttClientChannelConfiguration other
Returns
Type Description
bool
Overrides

Equals(MqttClientWebSocketConfiguration?)

The configuration of the websocket connection to the MQTT message broker.

Declaration
public virtual bool Equals(MqttClientWebSocketConfiguration? other)
Parameters
Type Name Description
MqttClientWebSocketConfiguration other
Returns
Type Description
bool

Equals(object?)

The configuration of the websocket connection to the MQTT message broker.

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides

GetHashCode()

The configuration of the websocket connection to the MQTT message broker.

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides

PrintMembers(StringBuilder)

The configuration of the websocket connection to the MQTT message broker.

Declaration
protected override bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
StringBuilder builder
Returns
Type Description
bool
Overrides

ToString()

The configuration of the websocket connection to the MQTT message broker.

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Validate()

Throws a SilverbackConfigurationException if the configuration is not valid.

Declaration
public override void Validate()
Overrides

Operators

operator ==(MqttClientWebSocketConfiguration?, MqttClientWebSocketConfiguration?)

The configuration of the websocket connection to the MQTT message broker.

Declaration
public static bool operator ==(MqttClientWebSocketConfiguration? left, MqttClientWebSocketConfiguration? right)
Parameters
Type Name Description
MqttClientWebSocketConfiguration left
MqttClientWebSocketConfiguration right
Returns
Type Description
bool

operator !=(MqttClientWebSocketConfiguration?, MqttClientWebSocketConfiguration?)

The configuration of the websocket connection to the MQTT message broker.

Declaration
public static bool operator !=(MqttClientWebSocketConfiguration? left, MqttClientWebSocketConfiguration? right)
Parameters
Type Name Description
MqttClientWebSocketConfiguration left
MqttClientWebSocketConfiguration right
Returns
Type Description
bool

Implements