Interface IConsumer

Broker-backed message receiver exposing core, transport-agnostic operations for consuming messages and managing destinations.

Namespace: CodersRealm.NmsAmqpClient
Assembly: CodersRealm.NmsAmqpClient.dll
Syntax
public interface IConsumer
Remarks

Acknowledgement and transaction controls are omitted; use TryAs/AsXxx helpers to acquire those capabilities when available.

Properties

AcknowledgementMode

The acknowledgement mode configured for this message receiver.

Declaration
AcknowledgementMode AcknowledgementMode { get; }
Property Value
Type Description
AcknowledgementMode

IsDisposed

Gets a value indicating whether this has been disposed and is no longer usable.

Declaration
bool IsDisposed { get; }
Property Value
Type Description
bool

IsRunning

Gets a value indicating whether currently running.

Declaration
bool IsRunning { get; }
Property Value
Type Description
bool

Tag

A unique identifier for this message receiver instance.

Declaration
Guid Tag { get; }
Property Value
Type Description
Guid

Methods

CreateTemporaryQueueAsync()

Create a temporary queue bound to the underlying connection/session.

Declaration
Task<ITemporaryQueue?> CreateTemporaryQueueAsync()
Returns
Type Description
Task<ITemporaryQueue>

The created Apache.NMS.ITemporaryQueue or null if creation failed.

CreateTemporaryTopicAsync()

Create a temporary topic bound to the underlying connection/session.

Declaration
Task<ITemporaryTopic?> CreateTemporaryTopicAsync()
Returns
Type Description
Task<ITemporaryTopic>

The created Apache.NMS.ITemporaryTopic or null if creation failed.

GetQueueAsync(string)

Resolve a named queue on the broker and return an Apache.NMS.IQueue reference.

Declaration
Task<IQueue?> GetQueueAsync(string queueName)
Parameters
Type Name Description
string queueName

The name of the queue to resolve.
Returns
Type Description
Task<IQueue>

The resolved Apache.NMS.IQueue or null if not found.
Exceptions
Type Condition
ArgumentException

Thrown when queueName is null or empty.

GetTopicAsync(string)

Resolve a named topic on the broker and return an Apache.NMS.ITopic reference.

Declaration
Task<ITopic?> GetTopicAsync(string topicName)
Parameters
Type Name Description
string topicName

The name of the topic to resolve.
Returns
Type Description
Task<ITopic>

The resolved Apache.NMS.ITopic or null if not found.
Exceptions
Type Condition
ArgumentException

Thrown when topicName is null or empty.

Extension Methods