Class MqttUserProperty

Namespace

Silverback.Messaging.Configuration.Mqtt

Assembly

Silverback.Integration.MQTT.dll

A user property to be sent with the CONNECT packet. It can be used to send connection related properties from the client to the server.

public record MqttUserProperty : IValidatableSettings, IEquatable<MqttUserProperty>

Inheritance

object

MqttUserProperty

Implements

IValidatableSettings

IEquatable<MqttUserProperty>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

MqttUserProperty(MqttUserProperty)

protected MqttUserProperty(MqttUserProperty original)

Parameters

original MqttUserProperty

MqttUserProperty(string, string?)

A user property to be sent with the CONNECT packet. It can be used to send connection related properties from the client to the server.

public MqttUserProperty(string Name, string? Value)

Parameters

Name string

Value string

Properties

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

Name

Gets the property name.

public string Name { get; }

Property Value

string

Value

Gets the property value.

public string? Value { get; }

Property Value

string

Methods

Deconstruct(out string, out string?)

public void Deconstruct(out string Name, out string? Value)

Parameters

Name string

Value string

Equals(MqttUserProperty?)

public virtual bool Equals(MqttUserProperty? other)

Parameters

other MqttUserProperty

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Validate()

Throws a SilverbackConfigurationException if the configuration is not valid.

public void Validate()

Operators

operator ==(MqttUserProperty?, MqttUserProperty?)

public static bool operator ==(MqttUserProperty? left, MqttUserProperty? right)

Parameters

left MqttUserProperty

right MqttUserProperty

Returns

bool

operator !=(MqttUserProperty?, MqttUserProperty?)

public static bool operator !=(MqttUserProperty? left, MqttUserProperty? right)

Parameters

left MqttUserProperty

right MqttUserProperty

Returns

bool