Class MqttMessageIdentifier

Namespace

Silverback.Messaging.Broker

Assembly

Silverback.Integration.MQTT.dll

The MQTT broker doesn't provide any message identifier, so this is a client-side generated identifier (GUID).

public sealed record MqttMessageIdentifier : IBrokerMessageIdentifier, IEquatable<IBrokerMessageIdentifier>, IEquatable<MqttMessageIdentifier>

Inheritance

object

MqttMessageIdentifier

Implements

IBrokerMessageIdentifier

IEquatable<IBrokerMessageIdentifier>

IEquatable<MqttMessageIdentifier>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Remarks

Generating the identifier client-side might prevent some Silverback features to work properly (e.g. MaxFailedAttempts).

Constructors

MqttMessageIdentifier(string, string)

Initializes a new instance of the MqttMessageIdentifier class.

public MqttMessageIdentifier(string clientId, string messageId)

Parameters

clientId string

The client identifier.

messageId string

The message identifier.

Properties

ClientId

Gets the client identifier.

public string ClientId { get; }

Property Value

string

MessageId

Gets the client-side generated message identifier.

public string MessageId { get; }

Property Value

string

Methods

Equals(IBrokerMessageIdentifier?)

public bool Equals(IBrokerMessageIdentifier? other)

Parameters

other IBrokerMessageIdentifier

Returns

bool

Equals(MqttMessageIdentifier?)

public bool Equals(MqttMessageIdentifier? other)

Parameters

other MqttMessageIdentifier

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToLogString()

Gets a string that can be used to log the identifier/offset value.

public string ToLogString()

Returns

string

A string representing the identifier/offset value.

Remarks

This string should contain all identifiers except the endpoint name.

ToString()

public override string ToString()

Returns

string

ToVerboseLogString()

Gets a string that can be used to log the identifier/offset value.

public string ToVerboseLogString()

Returns

string

A string representing the identifier/offset value.

Remarks

This string must include the endpoint name, if the identifier value isn't unique across different endpoints.

Operators

operator ==(MqttMessageIdentifier?, MqttMessageIdentifier?)

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

Parameters

left MqttMessageIdentifier

right MqttMessageIdentifier

Returns

bool

operator !=(MqttMessageIdentifier?, MqttMessageIdentifier?)

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

Parameters

left MqttMessageIdentifier

right MqttMessageIdentifier

Returns

bool