Class MqttUserProperty

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.

Inheritance

object

MqttUserProperty

Implements

IValidatableSettings

IEquatable<MqttUserProperty>

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace: Silverback.Messaging.Configuration.Mqtt

Assembly: Silverback.Integration.MQTT.dll

Syntax

public record MqttUserProperty : IValidatableSettings, IEquatable<MqttUserProperty>

Constructors

MqttUserProperty(MqttUserProperty)

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.

Declaration

protected MqttUserProperty(MqttUserProperty original)

Parameters

Type	Name	Description
MqttUserProperty	original

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.

Declaration

public MqttUserProperty(string Name, string? Value)

Parameters

Type	Name	Description
string	Name
string	Value

Properties

EqualityContract

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.

Declaration

protected virtual Type EqualityContract { get; }

Property Value

Type	Description
Type

Name

Gets the property name.

Declaration

public string Name { get; }

Property Value

Type	Description
string

Value

Gets the property value.

Declaration

public string? Value { get; }

Property Value

Type	Description
string

Methods

Deconstruct(out string, out 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.

Declaration

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

Parameters

Type	Name	Description
string	Name
string	Value

Equals(MqttUserProperty?)

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.

Declaration

public virtual bool Equals(MqttUserProperty? other)

Parameters

Type	Name	Description
MqttUserProperty	other

Returns

Type	Description
bool

Equals(object?)

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.

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

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.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

PrintMembers(StringBuilder)

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.

Declaration

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

Type	Name	Description
StringBuilder	builder

Returns

Type	Description
bool

ToString()

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.

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

Validate()

Throws a SilverbackConfigurationException if the configuration is not valid.

Declaration

public void Validate()

Operators

operator ==(MqttUserProperty?, MqttUserProperty?)

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.

Declaration

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

Parameters

Type	Name	Description
MqttUserProperty	left
MqttUserProperty	right

Returns

Type	Description
bool

operator !=(MqttUserProperty?, MqttUserProperty?)

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.

Declaration

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

Parameters

Type	Name	Description
MqttUserProperty	left
MqttUserProperty	right

Returns

Type	Description
bool

Implements

IValidatableSettings

IEquatable<T>