Class MqttClientWebSocketProxyConfigurationBuilder

Builds the MqttClientWebSocketProxyConfiguration.

Inheritance

object

MqttClientWebSocketProxyConfigurationBuilder

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Silverback.Messaging.Configuration.Mqtt

Assembly: Silverback.Integration.MQTT.dll

Syntax

public class MqttClientWebSocketProxyConfigurationBuilder

Constructors

MqttClientWebSocketProxyConfigurationBuilder()

Builds the MqttClientWebSocketProxyConfiguration.

Declaration

public MqttClientWebSocketProxyConfigurationBuilder()

Methods

Build()

Builds the MqttClientWebSocketProxyConfiguration instance.

Declaration

public MqttClientWebSocketProxyConfiguration Build()

Returns

Type	Description
MqttClientWebSocketProxyConfiguration	The MqttClientWebSocketProxyConfiguration.

DisableBypassOnLocal()

Disables bypassing the proxy for local addresses.

Declaration

public MqttClientWebSocketProxyConfigurationBuilder DisableBypassOnLocal()

Returns

Type	Description
MqttClientWebSocketProxyConfigurationBuilder	The MqttClientWebSocketProxyConfigurationBuilder so that additional calls can be chained.

EnableBypassOnLocal()

Enables bypassing the proxy for local addresses.

Declaration

public MqttClientWebSocketProxyConfigurationBuilder EnableBypassOnLocal()

Returns

Type	Description
MqttClientWebSocketProxyConfigurationBuilder	The MqttClientWebSocketProxyConfigurationBuilder so that additional calls can be chained.

UseDefaultCredentials()

Uses the default credentials for the proxy (e.g. DefaultCredentials).

Declaration

public MqttClientWebSocketProxyConfigurationBuilder UseDefaultCredentials()

Returns

Type	Description
MqttClientWebSocketProxyConfigurationBuilder	The MqttClientWebSocketProxyConfigurationBuilder so that additional calls can be chained.

WithAddress(string)

Sets the proxy address.

Declaration

public MqttClientWebSocketProxyConfigurationBuilder WithAddress(string address)

Parameters

Type	Name	Description
string	address	The proxy address (e.g. "http://proxy:8080").

Returns

Type	Description
MqttClientWebSocketProxyConfigurationBuilder	The MqttClientWebSocketProxyConfigurationBuilder so that additional calls can be chained.

WithBypassList(string[]?)

Sets the bypass list for the proxy.

Declaration

public MqttClientWebSocketProxyConfigurationBuilder WithBypassList(string[]? bypassList)

Parameters

Type	Name	Description
string[]	bypassList	The bypass list.

Returns

Type	Description
MqttClientWebSocketProxyConfigurationBuilder	The MqttClientWebSocketProxyConfigurationBuilder so that additional calls can be chained.

WithCredentials(string, string?)

Sets the credentials to be used to authenticate with the proxy.

Declaration

public MqttClientWebSocketProxyConfigurationBuilder WithCredentials(string username, string? password = null)

Parameters

Type	Name	Description
string	username	The username.
string	password	The password.

Returns

Type	Description
MqttClientWebSocketProxyConfigurationBuilder	The MqttClientWebSocketProxyConfigurationBuilder so that additional calls can be chained.

WithDomain(string?)

Sets the domain for proxy authentication.

Declaration

public MqttClientWebSocketProxyConfigurationBuilder WithDomain(string? domain)

Parameters

Type	Name	Description
string	domain	The user domain.

Returns

Type	Description
MqttClientWebSocketProxyConfigurationBuilder	The MqttClientWebSocketProxyConfigurationBuilder so that additional calls can be chained.