IQueueClient Interface

Definition

QueueClient can be used for all basic interactions with a Service Bus Queue.

public interface IQueueClient : Microsoft.Azure.ServiceBus.Core.IReceiverClient, Microsoft.Azure.ServiceBus.Core.ISenderClient
Derived
Implements

Examples

Create a new QueueClient

IQueueClient queueClient = new QueueClient(
    namespaceConnectionString,
    queueName,
    ReceiveMode.PeekLock,
    RetryExponential);

Send a message to the queue:

byte[] data = GetData();
await queueClient.SendAsync(data);

Register a message handler which will be invoked every time a message is received.

queueClient.RegisterMessageHandler(
       async (message, token) =>
       {
           // Process the message
           Console.WriteLine($"Received message: SequenceNumber:{message.SystemProperties.SequenceNumber} Body:{Encoding.UTF8.GetString(message.Body)}");

           // Complete the message so that it is not received again.
           // This can be done only if the queueClient is opened in ReceiveMode.PeekLock mode.
           await queueClient.CompleteAsync(message.SystemProperties.LockToken);
       },
       async (exceptionEvent) =>
       {
           // Process the exception
           Console.WriteLine("Exception = " + exceptionEvent.Exception);
           return Task.CompletedTask;
       });

Remarks

Use IMessageSender or IMessageReceiver for advanced set of functionality.

Properties

ClientId

Gets the ID to identify this client. This can be used to correlate logs and exceptions.

(Inherited from IClientEntity)
IsClosedOrClosing

Returns true if the client is closed or closing.

(Inherited from IClientEntity)
OperationTimeout

Duration after which individual operations will timeout.

(Inherited from IClientEntity)
OwnsConnection

Returns true if connection is owned and false if connection is shared.

(Inherited from IClientEntity)
Path

Gets the entity path.

(Inherited from IClientEntity)
PrefetchCount

Prefetch speeds up the message flow by aiming to have a message readily available for local retrieval when and before the application asks for one using Receive. Setting a non-zero value prefetches PrefetchCount number of messages. Setting the value to zero turns prefetch off. Defaults to 0.

(Inherited from IReceiverClient)
QueueName

Gets the name of the queue.

ReceiveMode

Gets the ReceiveMode of the current receiver.

(Inherited from IReceiverClient)
RegisteredPlugins

Gets a list of currently registered plugins for this client.

(Inherited from IClientEntity)
ServiceBusConnection

Connection object to the service bus namespace.

(Inherited from IClientEntity)

Methods

AbandonAsync(String, IDictionary<String,Object>)

Abandons a Message using a lock token. This will make the message available again for processing.

(Inherited from IReceiverClient)
CancelScheduledMessageAsync(Int64)

Cancels a message that was scheduled.

(Inherited from ISenderClient)
CloseAsync()

Closes the Client. Closes the connections opened by it.

(Inherited from IClientEntity)
CompleteAsync(String)

Completes a Message using its lock token. This will delete the message from the queue.

(Inherited from IReceiverClient)
DeadLetterAsync(String, IDictionary<String,Object>)

Moves a message to the deadletter sub-queue.

(Inherited from IReceiverClient)
DeadLetterAsync(String, String, String)

Moves a message to the deadletter sub-queue.

(Inherited from IReceiverClient)
RegisterMessageHandler(Func<Message,CancellationToken,Task>, Func<ExceptionReceivedEventArgs,Task>)

Receive messages continuously from the entity. Registers a message handler and begins a new thread to receive messages. This handler(Func<T1,T2,TResult>) is awaited on every time a new message is received by the receiver.

(Inherited from IReceiverClient)
RegisterMessageHandler(Func<Message,CancellationToken,Task>, MessageHandlerOptions)

Receive messages continuously from the entity. Registers a message handler and begins a new thread to receive messages. This handler(Func<T1,T2,TResult>) is awaited on every time a new message is received by the receiver.

(Inherited from IReceiverClient)
RegisterPlugin(ServiceBusPlugin)

Registers a ServiceBusPlugin to be used with this client.

(Inherited from IClientEntity)
RegisterSessionHandler(Func<IMessageSession,Message,CancellationToken,Task>, Func<ExceptionReceivedEventArgs,Task>)

Receive session messages continuously from the queue. Registers a message handler and begins a new thread to receive session-messages. This handler(Func<T1,T2,T3,TResult>) is awaited on every time a new message is received by the queue client.

RegisterSessionHandler(Func<IMessageSession,Message,CancellationToken,Task>, SessionHandlerOptions)

Receive session messages continuously from the queue. Registers a message handler and begins a new thread to receive session-messages. This handler(Func<T1,T2,T3,TResult>) is awaited on every time a new message is received by the queue client.

ScheduleMessageAsync(Message, DateTimeOffset)

Schedules a message to appear on Service Bus.

(Inherited from ISenderClient)
SendAsync(IList<Message>)

Sends a list of messages to Service Bus. When called on partitioned entities, messages meant for different partitions cannot be batched together.

(Inherited from ISenderClient)
SendAsync(Message)

Sends a message to Service Bus.

(Inherited from ISenderClient)
UnregisterMessageHandlerAsync(TimeSpan)

Unregister message handler from the receiver if there is an active message handler registered. This operation waits for the completion of inflight receive and message handling operations to finish and unregisters future receives on the message handler which previously registered.

(Inherited from IReceiverClient)
UnregisterPlugin(String)

Unregisters a ServiceBusPlugin.

(Inherited from IClientEntity)
UnregisterSessionHandlerAsync(TimeSpan)

Unregister session handler from the receiver if there is an active session handler registered. This operation waits for the completion of inflight receive and session handling operations to finish and unregisters future receives on the session handler which previously registered.

Applies to

See also