Class MqttClientWebSocketProxyConfiguration

The proxy configuration.

Inheritance

object

MqttClientWebSocketProxyConfiguration

Implements

IValidatableSettings

IEquatable<MqttClientWebSocketProxyConfiguration>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace: Silverback.Messaging.Configuration.Mqtt

Assembly: Silverback.Integration.MQTT.dll

Syntax

public record MqttClientWebSocketProxyConfiguration : IValidatableSettings, IEquatable<MqttClientWebSocketProxyConfiguration>

Constructors

MqttClientWebSocketProxyConfiguration()

The proxy configuration.

Declaration

public MqttClientWebSocketProxyConfiguration()

MqttClientWebSocketProxyConfiguration(MqttClientWebSocketProxyConfiguration)

The proxy configuration.

Declaration

protected MqttClientWebSocketProxyConfiguration(MqttClientWebSocketProxyConfiguration original)

Parameters

Type	Name	Description
MqttClientWebSocketProxyConfiguration	original

Properties

Address

Gets the proxy address.

Declaration

public string? Address { get; init; }

Property Value

Type	Description
string

BypassList

Gets the bypass list.

Declaration

public string[]? BypassList { get; init; }

Property Value

Type	Description
string[]

BypassOnLocal

Gets a value indicating whether the proxy should be bypassed for local calls.

Declaration

public bool BypassOnLocal { get; init; }

Property Value

Type	Description
bool

Domain

Gets proxy server domain.

Declaration

public string? Domain { get; init; }

Property Value

Type	Description
string

EqualityContract

The proxy configuration.

Declaration

protected virtual Type EqualityContract { get; }

Property Value

Type	Description
Type

Password

Gets the password to be used to authenticate with the proxy server.

Declaration

public string? Password { get; init; }

Property Value

Type	Description
string

UseDefaultCredentials

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

Declaration

public bool UseDefaultCredentials { get; init; }

Property Value

Type	Description
bool

Username

Gets the username to be used to authenticate with the proxy server.

Declaration

public string? Username { get; init; }

Property Value

Type	Description
string

Methods

Equals(MqttClientWebSocketProxyConfiguration?)

The proxy configuration.

Declaration

public virtual bool Equals(MqttClientWebSocketProxyConfiguration? other)

Parameters

Type	Name	Description
MqttClientWebSocketProxyConfiguration	other

Returns

Type	Description
bool

Equals(object?)

The proxy configuration.

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

The proxy configuration.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

PrintMembers(StringBuilder)

The proxy configuration.

Declaration

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

Type	Name	Description
StringBuilder	builder

Returns

Type	Description
bool

ToString()

The proxy configuration.

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

Validate()

Throws a SilverbackConfigurationException if the configuration is not valid.

Declaration

public void Validate()

Operators

operator ==(MqttClientWebSocketProxyConfiguration?, MqttClientWebSocketProxyConfiguration?)

The proxy configuration.

Declaration

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

Parameters

Type	Name	Description
MqttClientWebSocketProxyConfiguration	left
MqttClientWebSocketProxyConfiguration	right

Returns

Type	Description
bool

operator !=(MqttClientWebSocketProxyConfiguration?, MqttClientWebSocketProxyConfiguration?)

The proxy configuration.

Declaration

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

Parameters

Type	Name	Description
MqttClientWebSocketProxyConfiguration	left
MqttClientWebSocketProxyConfiguration	right

Returns

Type	Description
bool

Implements

IValidatableSettings

IEquatable<T>