Class MqttConnectionSettings

Namespace

Azure.Iot.Operations.Protocol.Connection

Assembly

Azure.Iot.Operations.Protocol.dll

public class MqttConnectionSettings

Inheritance

object

MqttConnectionSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

MqttConnectionSettings(IDictionary<string, string>, bool, bool)

protected MqttConnectionSettings(IDictionary<string, string> connectionSettings, bool validateOptionalSettings, bool isSettingFromConnStr = false)

Parameters

connectionSettings IDictionary<string, string>

validateOptionalSettings bool

isSettingFromConnStr bool

MqttConnectionSettings(string, string)

public MqttConnectionSettings(string hostname, string clientId)

Parameters

hostname string

clientId string

Properties

CaFile

public string? CaFile { get; set; }

Property Value

string

CertFile

public string? CertFile { get; set; }

Property Value

string

CleanStart

public bool CleanStart { get; set; }

Property Value

bool

ClientCertificate

public X509Certificate2? ClientCertificate { get; set; }

Property Value

X509Certificate2

ClientId

public string ClientId { get; set; }

Property Value

string

HostName

public string HostName { get; set; }

Property Value

string

KeepAlive

public TimeSpan KeepAlive { get; set; }

Property Value

TimeSpan

KeyFile

public string? KeyFile { get; set; }

Property Value

string

KeyPasswordFile

public string? KeyPasswordFile { get; set; }

Property Value

string

ModelId

public string? ModelId { get; set; }

Property Value

string

PasswordFile

public string? PasswordFile { get; set; }

Property Value

string

ReceiveMaximum

public ushort? ReceiveMaximum { get; set; }

Property Value

ushort?

SatAuthFile

public string? SatAuthFile { get; set; }

Property Value

string

SessionExpiry

public TimeSpan SessionExpiry { get; set; }

Property Value

TimeSpan

TcpPort

public int TcpPort { get; set; }

Property Value

int

TrustChain

public X509Certificate2Collection? TrustChain { get; set; }

Property Value

X509Certificate2Collection

UseTls

public bool UseTls { get; set; }

Property Value

bool

Username

public string? Username { get; set; }

Property Value

string

Methods

FromConnectionString(string)

public static MqttConnectionSettings FromConnectionString(string connectionString)

Parameters

connectionString string

Returns

MqttConnectionSettings

FromEnvVars()

public static MqttConnectionSettings FromEnvVars()

Returns

MqttConnectionSettings

FromFileMount()

Construct an instance from the configuration files mounted by the Akri Operator.

public static MqttConnectionSettings FromFileMount()

Returns

MqttConnectionSettings

Remarks

This method is only usable for connector applications deployed as a kubernetes pod.

GetBooleanValue(IDictionary<string, string>, string, bool)

protected static bool GetBooleanValue(IDictionary<string, string> dict, string propertyName, bool defaultValue = false)

Parameters

dict IDictionary<string, string>

propertyName string

defaultValue bool

Returns

bool

GetPositiveIntValueOrDefault(IDictionary<string, string>, string, int)

protected static int GetPositiveIntValueOrDefault(IDictionary<string, string> dict, string propertyName, int defaultValue = 0)

Parameters

dict IDictionary<string, string>

propertyName string

defaultValue int

Returns

int

GetStringValue(IDictionary<string, string>, string)

protected static string? GetStringValue(IDictionary<string, string> dict, string propertyName)

Parameters

dict IDictionary<string, string>

propertyName string

Returns

string

GetTimeSpanValue(IDictionary<string, string>, string, TimeSpan)

protected static TimeSpan GetTimeSpanValue(IDictionary<string, string> dict, string propertyName, TimeSpan defaultValue = default)

Parameters

dict IDictionary<string, string>

propertyName string

defaultValue TimeSpan

Returns

TimeSpan

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

ValidateMqttSettings(bool)

protected void ValidateMqttSettings(bool validateOptionalSettings)

Parameters

validateOptionalSettings bool