Struct MessageBrokerQueuePendingMessage

Namespace

LfrlAnvil.MessageBroker.Server

Assembly

LfrlAnvil.MessageBroker.Server.dll

Represents a snapshot of a pending message stored by a MessageBrokerQueue.

public readonly struct MessageBrokerQueuePendingMessage

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

Listener

MessageBrokerChannelListenerBinding that handles this message.

public MessageBrokerChannelListenerBinding Listener { get; }

Property Value

MessageBrokerChannelListenerBinding

Publisher

IMessageBrokerMessagePublisher that pushed this message.

public IMessageBrokerMessagePublisher Publisher { get; }

Property Value

IMessageBrokerMessagePublisher

StoreKey

Stream store key of this message.

public int StoreKey { get; }

Property Value

int

Methods

ToString()

Returns a string representation of this MessageBrokerQueuePendingMessage instance.

[Pure]
public override string ToString()

Returns

string

String representation.

TryGetMessage(bool)

Attempts to retrieve a message from the stream store by the StoreKey.

[Pure]
public MessageBrokerStreamMessage? TryGetMessage(bool includeData = false)

Parameters

includeData bool

Specifies whether to include a copy of binary data. Equal to false by default.

Returns

MessageBrokerStreamMessage?

MessageBrokerStreamMessage instance associated with the StoreKey or null if such a message doesn't exist.