Class MqttClientWebSocketConfiguration

Namespace

Silverback.Messaging.Configuration.Mqtt

Assembly

Silverback.Integration.MQTT.dll

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

public record MqttClientWebSocketConfiguration : MqttClientChannelConfiguration, IValidatableSettings, IEquatable<MqttClientChannelConfiguration>, IEquatable<MqttClientWebSocketConfiguration>

Inheritance

object

MqttClientChannelConfiguration

MqttClientWebSocketConfiguration

Implements

IValidatableSettings

IEquatable<MqttClientChannelConfiguration>

IEquatable<MqttClientWebSocketConfiguration>

Inherited Members

MqttClientChannelConfiguration.Tls

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

MqttClientWebSocketConfiguration()

public MqttClientWebSocketConfiguration()

MqttClientWebSocketConfiguration(MqttClientWebSocketConfiguration)

protected MqttClientWebSocketConfiguration(MqttClientWebSocketConfiguration original)

Parameters

original MqttClientWebSocketConfiguration

Properties

CookieContainer

Gets the cookies associated with the request.

public CookieContainer? CookieContainer { get; init; }

Property Value

CookieContainer

Credentials

Gets the credentials to be used.

public ICredentials? Credentials { get; init; }

Property Value

ICredentials

DangerousDeflateOptions

Gets the WebSocketDeflateOptions.

public WebSocketDeflateOptions? DangerousDeflateOptions { get; init; }

Property Value

WebSocketDeflateOptions

EqualityContract

protected override Type EqualityContract { get; }

Property Value

Type

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.

public TimeSpan KeepAliveInterval { get; init; }

Property Value

TimeSpan

Proxy

Gets the proxy configuration.

public MqttClientWebSocketProxyConfiguration? Proxy { get; init; }

Property Value

MqttClientWebSocketProxyConfiguration

RequestHeaders

Gets the request headers.

public IDictionary<string, string>? RequestHeaders { get; init; }

Property Value

IDictionary<string, string>

SubProtocols

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

public ICollection<string>? SubProtocols { get; init; }

Property Value

ICollection<string>

Uri

Gets the server URI.

public string? Uri { get; init; }

Property Value

string

UseDefaultCredentials

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

public bool UseDefaultCredentials { get; init; }

Property Value

bool

Methods

Equals(MqttClientChannelConfiguration?)

public override sealed bool Equals(MqttClientChannelConfiguration? other)

Parameters

other MqttClientChannelConfiguration

Returns

bool

Equals(MqttClientWebSocketConfiguration?)

public virtual bool Equals(MqttClientWebSocketConfiguration? other)

Parameters

other MqttClientWebSocketConfiguration

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected override bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Validate()

Throws a SilverbackConfigurationException if the configuration is not valid.

public override void Validate()

Operators

operator ==(MqttClientWebSocketConfiguration?, MqttClientWebSocketConfiguration?)

public static bool operator ==(MqttClientWebSocketConfiguration? left, MqttClientWebSocketConfiguration? right)

Parameters

left MqttClientWebSocketConfiguration

right MqttClientWebSocketConfiguration

Returns

bool

operator !=(MqttClientWebSocketConfiguration?, MqttClientWebSocketConfiguration?)

public static bool operator !=(MqttClientWebSocketConfiguration? left, MqttClientWebSocketConfiguration? right)

Parameters

left MqttClientWebSocketConfiguration

right MqttClientWebSocketConfiguration

Returns

bool