Class MqttServerOptionsBuilder

Namespace

MQTTnet.Server

Assembly

MQTTnet.dll

public class MqttServerOptionsBuilder

Inheritance

object

MqttServerOptionsBuilder

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MqttServerOptionsBuilder()

public MqttServerOptionsBuilder()

Methods

Build()

public MqttServerOptions Build()

Returns

MqttServerOptions

WithClientCertificate(RemoteCertificateValidationCallback, bool)

public MqttServerOptionsBuilder WithClientCertificate(RemoteCertificateValidationCallback validationCallback = null, bool checkCertificateRevocation = false)

Parameters

validationCallback RemoteCertificateValidationCallback

checkCertificateRevocation bool

Returns

MqttServerOptionsBuilder

WithConnectionBacklog(int)

public MqttServerOptionsBuilder WithConnectionBacklog(int value)

Parameters

value int

Returns

MqttServerOptionsBuilder

WithDefaultCommunicationTimeout(TimeSpan)

public MqttServerOptionsBuilder WithDefaultCommunicationTimeout(TimeSpan value)

Parameters

value TimeSpan

Returns

MqttServerOptionsBuilder

WithDefaultEndpoint()

public MqttServerOptionsBuilder WithDefaultEndpoint()

Returns

MqttServerOptionsBuilder

WithDefaultEndpointBoundIPAddress(IPAddress)

public MqttServerOptionsBuilder WithDefaultEndpointBoundIPAddress(IPAddress value)

Parameters

value IPAddress

Returns

MqttServerOptionsBuilder

WithDefaultEndpointBoundIPV6Address(IPAddress)

public MqttServerOptionsBuilder WithDefaultEndpointBoundIPV6Address(IPAddress value)

Parameters

value IPAddress

Returns

MqttServerOptionsBuilder

WithDefaultEndpointPort(int)

public MqttServerOptionsBuilder WithDefaultEndpointPort(int value)

Parameters

value int

Returns

MqttServerOptionsBuilder

WithDefaultEndpointReuseAddress()

public MqttServerOptionsBuilder WithDefaultEndpointReuseAddress()

Returns

MqttServerOptionsBuilder

WithEncryptedEndpoint()

public MqttServerOptionsBuilder WithEncryptedEndpoint()

Returns

MqttServerOptionsBuilder

WithEncryptedEndpointBoundIPAddress(IPAddress)

public MqttServerOptionsBuilder WithEncryptedEndpointBoundIPAddress(IPAddress value)

Parameters

value IPAddress

Returns

MqttServerOptionsBuilder

WithEncryptedEndpointBoundIPV6Address(IPAddress)

public MqttServerOptionsBuilder WithEncryptedEndpointBoundIPV6Address(IPAddress value)

Parameters

value IPAddress

Returns

MqttServerOptionsBuilder

WithEncryptedEndpointPort(int)

public MqttServerOptionsBuilder WithEncryptedEndpointPort(int value)

Parameters

value int

Returns

MqttServerOptionsBuilder

WithEncryptionCertificate(ICertificateProvider)

public MqttServerOptionsBuilder WithEncryptionCertificate(ICertificateProvider certificateProvider)

Parameters

certificateProvider ICertificateProvider

Returns

MqttServerOptionsBuilder

WithEncryptionCertificate(byte[], IMqttServerCertificateCredentials)

public MqttServerOptionsBuilder WithEncryptionCertificate(byte[] value, IMqttServerCertificateCredentials credentials = null)

Parameters

value byte[]

credentials IMqttServerCertificateCredentials

Returns

MqttServerOptionsBuilder

WithEncryptionCertificate(X509Certificate2)

public MqttServerOptionsBuilder WithEncryptionCertificate(X509Certificate2 certificate)

Parameters

certificate X509Certificate2

Returns

MqttServerOptionsBuilder

WithEncryptionSslProtocol(SslProtocols)

public MqttServerOptionsBuilder WithEncryptionSslProtocol(SslProtocols value)

Parameters

value SslProtocols

Returns

MqttServerOptionsBuilder

WithKeepAlive()

public MqttServerOptionsBuilder WithKeepAlive()

Returns

MqttServerOptionsBuilder

WithMaxPendingMessagesPerClient(int)

public MqttServerOptionsBuilder WithMaxPendingMessagesPerClient(int value)

Parameters

value int

Returns

MqttServerOptionsBuilder

WithPersistentSessions(bool)

public MqttServerOptionsBuilder WithPersistentSessions(bool value = true)

Parameters

value bool

Returns

MqttServerOptionsBuilder

WithRemoteCertificateValidationCallback(RemoteCertificateValidationCallback)

public MqttServerOptionsBuilder WithRemoteCertificateValidationCallback(RemoteCertificateValidationCallback value)

Parameters

value RemoteCertificateValidationCallback

Returns

MqttServerOptionsBuilder

WithTcpKeepAliveInterval(int)

public MqttServerOptionsBuilder WithTcpKeepAliveInterval(int value)

Parameters

value int

Returns

MqttServerOptionsBuilder

WithTcpKeepAliveRetryCount(int)

public MqttServerOptionsBuilder WithTcpKeepAliveRetryCount(int value)

Parameters

value int

Returns

MqttServerOptionsBuilder

WithTcpKeepAliveTime(int)

public MqttServerOptionsBuilder WithTcpKeepAliveTime(int value)

Parameters

value int

Returns

MqttServerOptionsBuilder

WithTlsEndpointReuseAddress()

public MqttServerOptionsBuilder WithTlsEndpointReuseAddress()

Returns

MqttServerOptionsBuilder

WithoutDefaultEndpoint()

public MqttServerOptionsBuilder WithoutDefaultEndpoint()

Returns

MqttServerOptionsBuilder

WithoutEncryptedEndpoint()

public MqttServerOptionsBuilder WithoutEncryptedEndpoint()

Returns

MqttServerOptionsBuilder

WithoutPacketFragmentation()

Usually the MQTT packets can be send partially to improve memory allocations. This is done by using multiple TCP packets or WebSocket frames etc. Unfortunately not all clients do support this and will close the connection when receiving partial packets.

public MqttServerOptionsBuilder WithoutPacketFragmentation()

Returns

MqttServerOptionsBuilder