Class MqttClientWebSocketOptions

Namespace

Azure.Iot.Operations.Protocol.Models

Assembly

Azure.Iot.Operations.Protocol.dll

public sealed class MqttClientWebSocketOptions : IMqttClientChannelOptions

Inheritance

object

MqttClientWebSocketOptions

Implements

IMqttClientChannelOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Properties

CookieContainer

public CookieContainer? CookieContainer { get; set; }

Property Value

CookieContainer

Credentials

public ICredentials? Credentials { get; set; }

Property Value

ICredentials

KeepAliveInterval

Gets or sets the keep alive interval for the Web Socket connection. This is not related to the keep alive interval for the MQTT protocol.

public TimeSpan KeepAliveInterval { get; set; }

Property Value

TimeSpan

ProxyOptions

public MqttClientWebSocketProxyOptions? ProxyOptions { get; set; }

Property Value

MqttClientWebSocketProxyOptions

RequestHeaders

public IDictionary<string, string> RequestHeaders { get; set; }

Property Value

IDictionary<string, string>

SubProtocols

public ICollection<string> SubProtocols { get; set; }

Property Value

ICollection<string>

TlsOptions

public MqttClientTlsOptions TlsOptions { get; set; }

Property Value

MqttClientTlsOptions

Uri

public required string Uri { get; set; }

Property Value

string

UseDefaultCredentials

Gets or sets whether the default (system) credentials should be used when connecting via Web Socket connection. This is not related to the credentials which are used for the MQTT protocol.

public bool UseDefaultCredentials { get; set; }

Property Value

bool

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.