Class MqttClientConfigBuilder

Inheritance

System.Object

MqttClientConfigBuilder

Implements

IMqttClientConfigBuilder

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Silverback.Messaging.Configuration.Mqtt

Assembly: Silverback.Integration.MQTT.dll

Syntax

public class MqttClientConfigBuilder : IMqttClientConfigBuilder

Constructors

| Improve this doc View source

MqttClientConfigBuilder(MqttClientConfig, IServiceProvider)

Initializes a new instance of the MqttClientConfigBuilder class.

Declaration

public MqttClientConfigBuilder(MqttClientConfig baseConfig, IServiceProvider serviceProvider = null)

Parameters

Type	Name	Description
MqttClientConfig	baseConfig	The MqttClientConfig to be used to initialize the builder.
System.IServiceProvider	serviceProvider	The System.IServiceProvider to be used to resolve the required types (e.g. the MQTTnet.Client.IMqttExtendedAuthenticationExchangeHandler).

| Improve this doc View source

MqttClientConfigBuilder(IServiceProvider)

Initializes a new instance of the MqttClientConfigBuilder class.

Declaration

public MqttClientConfigBuilder(IServiceProvider serviceProvider = null)

Parameters

Type	Name	Description
System.IServiceProvider	serviceProvider	The System.IServiceProvider to be used to resolve the required types (e.g. the MQTTnet.Client.IMqttExtendedAuthenticationExchangeHandler).

Methods

| Improve this doc View source

AddUserProperty(String, String)

Declaration

public IMqttClientConfigBuilder AddUserProperty(string name, string value)

Parameters

Type	Name	Description
System.String	name
System.String	value

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

Build()

Builds the MqttClientConfig instance.

Declaration

public MqttClientConfig Build()

Returns

Type	Description
MqttClientConfig	The MqttClientConfig.

| Improve this doc View source

ConnectTo(String)

Declaration

[Obsolete("Use ConnectViaTcp or ConnectViaWebsocket.")]
public IMqttClientConfigBuilder ConnectTo(string uri)

Parameters

Type	Name	Description
System.String	uri

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

ConnectTo(Uri)

Declaration

[Obsolete("Use ConnectViaTcp or ConnectViaWebsocket.")]
public IMqttClientConfigBuilder ConnectTo(Uri uri)

Parameters

Type	Name	Description
System.Uri	uri

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

ConnectViaTcp(Action<MqttClientTcpOptions>)

Declaration

public IMqttClientConfigBuilder ConnectViaTcp(Action<MqttClientTcpOptions> optionsAction)

Parameters

Type	Name	Description
System.Action<MQTTnet.Client.MqttClientTcpOptions>	optionsAction

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

ConnectViaTcp(String, Nullable<Int32>, AddressFamily)

Declaration

public IMqttClientConfigBuilder ConnectViaTcp(string server, int? port = null, AddressFamily addressFamily = AddressFamily.Unspecified)

Parameters

Type	Name	Description
System.String	server
System.Nullable<System.Int32>	port
System.Net.Sockets.AddressFamily	addressFamily

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

ConnectViaWebSocket(Action<MqttClientWebSocketOptions>)

Declaration

[Obsolete("Use the overload with the builder as parameter.")]
public IMqttClientConfigBuilder ConnectViaWebSocket(Action<MqttClientWebSocketOptions> optionsAction)

Parameters

Type	Name	Description
System.Action<MQTTnet.Client.MqttClientWebSocketOptions>	optionsAction

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

ConnectViaWebSocket(Action<MqttClientWebSocketOptionsBuilder>)

Declaration

public IMqttClientConfigBuilder ConnectViaWebSocket(Action<MqttClientWebSocketOptionsBuilder> optionsAction)

Parameters

Type	Name	Description
System.Action<MQTTnet.Client.MqttClientWebSocketOptionsBuilder>	optionsAction

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

ConnectViaWebSocket(String, MqttClientOptionsBuilderWebSocketParameters)

Declaration

[Obsolete("Use the overload with the builder as parameter.")]
public IMqttClientConfigBuilder ConnectViaWebSocket(string uri, MqttClientOptionsBuilderWebSocketParameters parameters = null)

Parameters

Type	Name	Description
System.String	uri
MQTTnet.Client.MqttClientOptionsBuilderWebSocketParameters	parameters

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

ConnectViaWebSocket(String, Action<MqttClientOptionsBuilderWebSocketParameters>)

Declaration

[Obsolete("Use the overload with the builder as parameter.")]
public IMqttClientConfigBuilder ConnectViaWebSocket(string uri, Action<MqttClientOptionsBuilderWebSocketParameters> parametersAction)

Parameters

Type	Name	Description
System.String	uri
System.Action<MQTTnet.Client.MqttClientOptionsBuilderWebSocketParameters>	parametersAction

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

DisableKeepAlive()

Declaration

public IMqttClientConfigBuilder DisableKeepAlive()

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

DisableProblemInformation()

Declaration

public IMqttClientConfigBuilder DisableProblemInformation()

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

DisableResponseInformation()

Declaration

public IMqttClientConfigBuilder DisableResponseInformation()

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

DisableTls()

Declaration

public IMqttClientConfigBuilder DisableTls()

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

EnableTls()

Declaration

public IMqttClientConfigBuilder EnableTls()

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

EnableTls(MqttClientOptionsBuilderTlsParameters)

Declaration

[Obsolete("Use the overload with the new builder or model as parameter.")]
public IMqttClientConfigBuilder EnableTls(MqttClientOptionsBuilderTlsParameters parameters)

Parameters

Type	Name	Description
MQTTnet.Client.MqttClientOptionsBuilderTlsParameters	parameters

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

EnableTls(MqttClientTlsOptions)

Declaration

public IMqttClientConfigBuilder EnableTls(MqttClientTlsOptions options)

Parameters

Type	Name	Description
MQTTnet.Client.MqttClientTlsOptions	options

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

EnableTls(Action<MqttClientOptionsBuilderTlsParameters>)

Declaration

[Obsolete("Use the overload with the new builder or model as parameter.")]
public IMqttClientConfigBuilder EnableTls(Action<MqttClientOptionsBuilderTlsParameters> parametersAction)

Parameters

Type	Name	Description
System.Action<MQTTnet.Client.MqttClientOptionsBuilderTlsParameters>	parametersAction

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

EnableTls(Action<MqttClientTlsOptionsBuilder>)

Declaration

public IMqttClientConfigBuilder EnableTls(Action<MqttClientTlsOptionsBuilder> optionsAction)

Parameters

Type	Name	Description
System.Action<MQTTnet.Client.MqttClientTlsOptionsBuilder>	optionsAction

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

LimitPacketSize(UInt32)

Declaration

public IMqttClientConfigBuilder LimitPacketSize(uint maximumPacketSize)

Parameters

Type	Name	Description
System.UInt32	maximumPacketSize

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

LimitTopicAlias(Int32)

Declaration

public IMqttClientConfigBuilder LimitTopicAlias(int topicAliasMaximum)

Parameters

Type	Name	Description
System.Int32	topicAliasMaximum

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

LimitUnacknowledgedPublications(UInt16)

Declaration

public IMqttClientConfigBuilder LimitUnacknowledgedPublications(ushort receiveMaximum)

Parameters

Type	Name	Description
System.UInt16	receiveMaximum

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

RequestCleanSession()

Declaration

public IMqttClientConfigBuilder RequestCleanSession()

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

RequestPersistentSession()

Declaration

public IMqttClientConfigBuilder RequestPersistentSession()

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

RequestProblemInformation()

Declaration

public IMqttClientConfigBuilder RequestProblemInformation()

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

RequestResponseInformation()

Declaration

public IMqttClientConfigBuilder RequestResponseInformation()

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

SendKeepAlive(TimeSpan)

Declaration

public IMqttClientConfigBuilder SendKeepAlive(TimeSpan interval)

Parameters

Type	Name	Description
System.TimeSpan	interval

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

SendLastWillMessage(Action<IMqttLastWillMessageBuilder>)

Declaration

public IMqttClientConfigBuilder SendLastWillMessage(Action<IMqttLastWillMessageBuilder> lastWillBuilderAction)

Parameters

Type	Name	Description
System.Action<IMqttLastWillMessageBuilder>	lastWillBuilderAction

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

UseExtendedAuthenticationExchangeHandler(IMqttExtendedAuthenticationExchangeHandler)

Declaration

public IMqttClientConfigBuilder UseExtendedAuthenticationExchangeHandler(IMqttExtendedAuthenticationExchangeHandler handler)

Parameters

Type	Name	Description
MQTTnet.Client.IMqttExtendedAuthenticationExchangeHandler	handler

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

UseExtendedAuthenticationExchangeHandler(Type)

Declaration

public IMqttClientConfigBuilder UseExtendedAuthenticationExchangeHandler(Type handlerType)

Parameters

Type	Name	Description
System.Type	handlerType

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

UseExtendedAuthenticationExchangeHandler<THandler>()

Declaration

public IMqttClientConfigBuilder UseExtendedAuthenticationExchangeHandler<THandler>()

    where THandler : IMqttExtendedAuthenticationExchangeHandler

Returns

Type	Description
IMqttClientConfigBuilder

Type Parameters

Name	Description
THandler

| Improve this doc View source

UseProtocolVersion(MqttProtocolVersion)

Declaration

public IMqttClientConfigBuilder UseProtocolVersion(MqttProtocolVersion value)

Parameters

Type	Name	Description
MQTTnet.Formatter.MqttProtocolVersion	value

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

UseProxy(Action<MqttClientWebSocketProxyOptions>)

Declaration

[Obsolete("Configure proxy in ConnectViaWebSocket(...).")]
public IMqttClientConfigBuilder UseProxy(Action<MqttClientWebSocketProxyOptions> optionsAction)

Parameters

Type	Name	Description
System.Action<MQTTnet.Client.MqttClientWebSocketProxyOptions>	optionsAction

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

UseProxy(String, String, String, String, Boolean, String[])

Declaration

[Obsolete("Configure proxy in ConnectViaWebSocket(...).")]
public IMqttClientConfigBuilder UseProxy(string address, string username = null, string password = null, string domain = null, bool bypassOnLocal = false, string[] bypassList = null)

Parameters

Type	Name	Description
System.String	address
System.String	username
System.String	password
System.String	domain
System.Boolean	bypassOnLocal
System.String[]	bypassList

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

WithAuthentication(String, Byte[])

Declaration

public IMqttClientConfigBuilder WithAuthentication(string method, byte[] data)

Parameters

Type	Name	Description
System.String	method
System.Byte[]	data

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

WithClientId(String)

Declaration

public IMqttClientConfigBuilder WithClientId(string value)

Parameters

Type	Name	Description
System.String	value

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

WithCredentials(IMqttClientCredentialsProvider)

Declaration

public IMqttClientConfigBuilder WithCredentials(IMqttClientCredentialsProvider credentialsProvider)

Parameters

Type	Name	Description
MQTTnet.Client.IMqttClientCredentialsProvider	credentialsProvider

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

WithCredentials(String, Byte[])

Declaration

public IMqttClientConfigBuilder WithCredentials(string username, byte[] password = null)

Parameters

Type	Name	Description
System.String	username
System.Byte[]	password

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

WithCredentials(String, String)

Declaration

public IMqttClientConfigBuilder WithCredentials(string username, string password = null)

Parameters

Type	Name	Description
System.String	username
System.String	password

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

WithoutTryPrivate()

Declaration

public IMqttClientConfigBuilder WithoutTryPrivate()

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

WithSessionExpiration(TimeSpan)

Declaration

public IMqttClientConfigBuilder WithSessionExpiration(TimeSpan sessionExpiryInterval)

Parameters

Type	Name	Description
System.TimeSpan	sessionExpiryInterval

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

WithTimeout(TimeSpan)

Declaration

public IMqttClientConfigBuilder WithTimeout(TimeSpan timeout)

Parameters

Type	Name	Description
System.TimeSpan	timeout

Returns

Type	Description
IMqttClientConfigBuilder

| Improve this doc View source

WithTryPrivate()

Declaration

public IMqttClientConfigBuilder WithTryPrivate()

Returns

Type	Description
IMqttClientConfigBuilder

Implements

IMqttClientConfigBuilder