QueueClient QueueClient QueueClient Class

Definition

Represents the queue client object.

public abstract class QueueClient : Microsoft.ServiceBus.Messaging.ClientEntity
type QueueClient = class
    inherit ClientEntity
    interface IMessageSessionEntity
    interface IMessageClientEntity
    interface IMessageSender
    interface IMessageReceiver
    interface IMessageBrowser
Public MustInherit Class QueueClient
Inherits ClientEntity
Inheritance

Properties

IsClosed IsClosed IsClosed Inherited from ClientEntity
MessagingFactory MessagingFactory MessagingFactory

Gets or sets the messaging factory.

Mode Mode Mode

Gets the message receive mode when processing the received message.

Path Path Path

Gets or sets the full path name of the queue.

PrefetchCount PrefetchCount PrefetchCount

Gets or sets the number of messages that the queue receiver can simultaneously request.

RetryPolicy RetryPolicy RetryPolicy Inherited from ClientEntity
ThisLock ThisLock ThisLock Inherited from ClientEntity

Methods

Abandon(Guid) Abandon(Guid) Abandon(Guid)

Discards the message and relinquishes the message lock ownership.

Abandon(Guid, IDictionary<String,Object>) Abandon(Guid, IDictionary<String,Object>) Abandon(Guid, IDictionary<String,Object>)

Discards the message and relinquishes the message lock ownership.

AbandonAsync(Guid) AbandonAsync(Guid) AbandonAsync(Guid)

Asynchronously discards the message and relinquishes the message lock ownership.

AbandonAsync(Guid, IDictionary<String,Object>) AbandonAsync(Guid, IDictionary<String,Object>) AbandonAsync(Guid, IDictionary<String,Object>)

Asynchronously discards the message and relinquishes the message lock ownership.

Abort() Abort() Abort() Inherited from ClientEntity
AcceptMessageSession() AcceptMessageSession() AcceptMessageSession()

Accepts a message session that allows grouping of related messages for processing in a single transaction.

AcceptMessageSession(String) AcceptMessageSession(String) AcceptMessageSession(String)

Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier.

AcceptMessageSession(String, TimeSpan) AcceptMessageSession(String, TimeSpan) AcceptMessageSession(String, TimeSpan)

Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier and wait time.

AcceptMessageSession(TimeSpan) AcceptMessageSession(TimeSpan) AcceptMessageSession(TimeSpan)

Accepts a message session that allows grouping of related messages for processing in a single transaction using the specified server wait time.

AcceptMessageSessionAsync() AcceptMessageSessionAsync() AcceptMessageSessionAsync()

Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction.

AcceptMessageSessionAsync(String) AcceptMessageSessionAsync(String) AcceptMessageSessionAsync(String)

Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier.

AcceptMessageSessionAsync(String, TimeSpan) AcceptMessageSessionAsync(String, TimeSpan) AcceptMessageSessionAsync(String, TimeSpan)

Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier and wait time.

AcceptMessageSessionAsync(TimeSpan) AcceptMessageSessionAsync(TimeSpan) AcceptMessageSessionAsync(TimeSpan)

Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction using the specified server wait time.

CancelScheduledMessageAsync(Int64) CancelScheduledMessageAsync(Int64) CancelScheduledMessageAsync(Int64)

Cancels a scheduled message

Close() Close() Close() Inherited from ClientEntity
CloseAsync() CloseAsync() CloseAsync() Inherited from ClientEntity
Complete(Guid) Complete(Guid) Complete(Guid)

Completes processing of a message.

CompleteAsync(Guid) CompleteAsync(Guid) CompleteAsync(Guid)

Asynchronously completes processing of a message.

CompleteBatch(IEnumerable<Guid>) CompleteBatch(IEnumerable<Guid>) CompleteBatch(IEnumerable<Guid>)

Completes processing of a message batch.

CompleteBatchAsync(IEnumerable<Guid>) CompleteBatchAsync(IEnumerable<Guid>) CompleteBatchAsync(IEnumerable<Guid>)

Asynchronously completes processing of a message batch.

Create(String) Create(String) Create(String)

Creates a new copy of QueueClient with specified path.

Create(String, ReceiveMode) Create(String, ReceiveMode) Create(String, ReceiveMode)

Creates a new copy of QueueClient with specified path and mode.

CreateFromConnectionString(String) CreateFromConnectionString(String) CreateFromConnectionString(String)

Creates a new instance of QueueClient using the specified connection string.

CreateFromConnectionString(String, ReceiveMode) CreateFromConnectionString(String, ReceiveMode) CreateFromConnectionString(String, ReceiveMode)

Creates a new instance of QueueClient using the specified connection string and receiving mode.

CreateFromConnectionString(String, String) CreateFromConnectionString(String, String) CreateFromConnectionString(String, String)

Creates a new copy of QueueClient from a connection string with the specified queue path. Use this overload only when the connection string does not use the EntityPath property.

CreateFromConnectionString(String, String, ReceiveMode) CreateFromConnectionString(String, String, ReceiveMode) CreateFromConnectionString(String, String, ReceiveMode)

Creates a new instance of QueueClient from a connection string with the specified path and mode. Use this overload only when the connection string does not use the EntityPath property.

DeadLetter(Guid) DeadLetter(Guid) DeadLetter(Guid)

Moves the undelivered message to the dead letter queue.

DeadLetter(Guid, IDictionary<String,Object>) DeadLetter(Guid, IDictionary<String,Object>) DeadLetter(Guid, IDictionary<String,Object>)

Moves the undelivered message to the dead letter queue.

DeadLetter(Guid, String, String) DeadLetter(Guid, String, String) DeadLetter(Guid, String, String)

Moves the undelivered message to the dead letter queue.

DeadLetterAsync(Guid) DeadLetterAsync(Guid) DeadLetterAsync(Guid)

Asynchronously moves the undelivered message to the dead letter queue.

DeadLetterAsync(Guid, IDictionary<String,Object>) DeadLetterAsync(Guid, IDictionary<String,Object>) DeadLetterAsync(Guid, IDictionary<String,Object>)

Asynchronously moves the undelivered message to the dead letter queue.

DeadLetterAsync(Guid, String, String) DeadLetterAsync(Guid, String, String) DeadLetterAsync(Guid, String, String)

Asynchronously moves the undelivered message to the dead letter queue.

Defer(Guid) Defer(Guid) Defer(Guid)

Suspends the processing of a message.

Defer(Guid, IDictionary<String,Object>) Defer(Guid, IDictionary<String,Object>) Defer(Guid, IDictionary<String,Object>)

Suspends the processing of a message.

DeferAsync(Guid) DeferAsync(Guid) DeferAsync(Guid)

Asynchronously suspends the processing of a message.

DeferAsync(Guid, IDictionary<String,Object>) DeferAsync(Guid, IDictionary<String,Object>) DeferAsync(Guid, IDictionary<String,Object>)

Asynchronously suspends the processing of a message.

Fault() Fault() Fault() Inherited from ClientEntity
FormatDeadLetterPath(String) FormatDeadLetterPath(String) FormatDeadLetterPath(String)

Builds a format name from the specified dead letter queue path.

FormatTransferDeadLetterPath(String) FormatTransferDeadLetterPath(String) FormatTransferDeadLetterPath(String)
GetMessageSessions() GetMessageSessions() GetMessageSessions()

Gets the message sessions, enabling you to browse sessions on queues.

GetMessageSessions(DateTime) GetMessageSessions(DateTime) GetMessageSessions(DateTime)

Retrieves all message sessions whose session state was updated since lastUpdatedTime.

GetMessageSessionsAsync() GetMessageSessionsAsync() GetMessageSessionsAsync()

Asynchronously gets the message sessions, enabling you to browse sessions on queues.

GetMessageSessionsAsync(DateTime) GetMessageSessionsAsync(DateTime) GetMessageSessionsAsync(DateTime)

Asynchronously retrieves all message sessions whose session state was updated since lastUpdatedTime.

OnAbort() OnAbort() OnAbort()

Executes upon calling the Abort event.

OnBeginAcceptMessageSession(String, ReceiveMode, Int32, TimeSpan, TimeSpan, AsyncCallback, Object) OnBeginAcceptMessageSession(String, ReceiveMode, Int32, TimeSpan, TimeSpan, AsyncCallback, Object) OnBeginAcceptMessageSession(String, ReceiveMode, Int32, TimeSpan, TimeSpan, AsyncCallback, Object)
OnBeginClose(TimeSpan, AsyncCallback, Object) OnBeginClose(TimeSpan, AsyncCallback, Object) OnBeginClose(TimeSpan, AsyncCallback, Object)

Executes when the Close operation is called.

OnBeginCreateReceiver(ReceiveMode, TimeSpan, AsyncCallback, Object) OnBeginCreateReceiver(ReceiveMode, TimeSpan, AsyncCallback, Object) OnBeginCreateReceiver(ReceiveMode, TimeSpan, AsyncCallback, Object)

Executes the begin create receiver action.

OnBeginCreateReceiver(String, ReceiveMode, TimeSpan, AsyncCallback, Object) OnBeginCreateReceiver(String, ReceiveMode, TimeSpan, AsyncCallback, Object) OnBeginCreateReceiver(String, ReceiveMode, TimeSpan, AsyncCallback, Object)

Executes the begin create receiver action.

OnBeginCreateSender(TimeSpan, AsyncCallback, Object) OnBeginCreateSender(TimeSpan, AsyncCallback, Object) OnBeginCreateSender(TimeSpan, AsyncCallback, Object)

Executes the begin create sender action.

OnBeginGetMessageSessions(DateTime, AsyncCallback, Object) OnBeginGetMessageSessions(DateTime, AsyncCallback, Object) OnBeginGetMessageSessions(DateTime, AsyncCallback, Object)

Executes the BeginGetMessageSessions action.

OnBeginOpen(TimeSpan, AsyncCallback, Object) OnBeginOpen(TimeSpan, AsyncCallback, Object) OnBeginOpen(TimeSpan, AsyncCallback, Object) Inherited from ClientEntity
OnClose(TimeSpan) OnClose(TimeSpan) OnClose(TimeSpan)

Executes upon calling the Close action.

OnClosed() OnClosed() OnClosed() Inherited from ClientEntity
OnEndAcceptMessageSession(IAsyncResult) OnEndAcceptMessageSession(IAsyncResult) OnEndAcceptMessageSession(IAsyncResult)

Executes upon calling the EndAcceptMessageSession operation.

OnEndClose(IAsyncResult) OnEndClose(IAsyncResult) OnEndClose(IAsyncResult)

Executes the end close action.

OnEndCreateReceiver(IAsyncResult) OnEndCreateReceiver(IAsyncResult) OnEndCreateReceiver(IAsyncResult)

Executes the end create receiver action.

OnEndCreateSender(IAsyncResult) OnEndCreateSender(IAsyncResult) OnEndCreateSender(IAsyncResult)

Executes the end create sender action.

OnEndGetMessageSessions(IAsyncResult) OnEndGetMessageSessions(IAsyncResult) OnEndGetMessageSessions(IAsyncResult)

Executes the end get message action.

OnEndOpen(IAsyncResult) OnEndOpen(IAsyncResult) OnEndOpen(IAsyncResult) Inherited from ClientEntity
OnFaulted() OnFaulted() OnFaulted() Inherited from ClientEntity
OnMessage(Action<BrokeredMessage>) OnMessage(Action<BrokeredMessage>) OnMessage(Action<BrokeredMessage>)

Processes a message in an event-driven message pump.

OnMessage(Action<BrokeredMessage>, OnMessageOptions) OnMessage(Action<BrokeredMessage>, OnMessageOptions) OnMessage(Action<BrokeredMessage>, OnMessageOptions)

Processes a message in an event-driven message pump, with the given set of OnMessageOptions options.

OnMessageAsync(Func<BrokeredMessage,Task>) OnMessageAsync(Func<BrokeredMessage,Task>) OnMessageAsync(Func<BrokeredMessage,Task>)

Asynchronously processes a message.

OnMessageAsync(Func<BrokeredMessage,Task>, OnMessageOptions) OnMessageAsync(Func<BrokeredMessage,Task>, OnMessageOptions) OnMessageAsync(Func<BrokeredMessage,Task>, OnMessageOptions)

Asynchronously processes a message.

OnOpen(TimeSpan) OnOpen(TimeSpan) OnOpen(TimeSpan) Inherited from ClientEntity
OnOpened() OnOpened() OnOpened() Inherited from ClientEntity
Peek() Peek() Peek()

Returns without removing the first message in the queue.

Peek(Int64) Peek(Int64) Peek(Int64)

Returns without removing the first message in the queue.

PeekAsync() PeekAsync() PeekAsync()

Asynchronously returns without removing the first message in the queue.

PeekAsync(Int64) PeekAsync(Int64) PeekAsync(Int64)

Asynchronously returns without removing the first message in the queue.

PeekBatch(Int32) PeekBatch(Int32) PeekBatch(Int32)

Peeks a batch of messages.

PeekBatch(Int64, Int32) PeekBatch(Int64, Int32) PeekBatch(Int64, Int32)

Peeks a batch of messages.

PeekBatchAsync(Int32) PeekBatchAsync(Int32) PeekBatchAsync(Int32)

Asynchronously peeks a batch of message.

PeekBatchAsync(Int64, Int32) PeekBatchAsync(Int64, Int32) PeekBatchAsync(Int64, Int32)

Asynchronously peeks a batch of message.

Receive() Receive() Receive()

Receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

Receive(Int64) Receive(Int64) Receive(Int64)

Receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

Receive(TimeSpan) Receive(TimeSpan) Receive(TimeSpan)

Receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

ReceiveAsync() ReceiveAsync() ReceiveAsync()

Asynchronously receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

ReceiveAsync(Int64) ReceiveAsync(Int64) ReceiveAsync(Int64)

Asynchronously receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

ReceiveAsync(TimeSpan) ReceiveAsync(TimeSpan) ReceiveAsync(TimeSpan)

Asynchronously receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver.

ReceiveBatch(IEnumerable<Int64>) ReceiveBatch(IEnumerable<Int64>) ReceiveBatch(IEnumerable<Int64>)

Receives a message batch.

ReceiveBatch(Int32) ReceiveBatch(Int32) ReceiveBatch(Int32)

Receives a message batch.

ReceiveBatch(Int32, TimeSpan) ReceiveBatch(Int32, TimeSpan) ReceiveBatch(Int32, TimeSpan)

Receives a message batch.

ReceiveBatchAsync(IEnumerable<Int64>) ReceiveBatchAsync(IEnumerable<Int64>) ReceiveBatchAsync(IEnumerable<Int64>)

Asynchronously receives a message batch.

ReceiveBatchAsync(Int32) ReceiveBatchAsync(Int32) ReceiveBatchAsync(Int32)

Asynchronously receives a message batch.

ReceiveBatchAsync(Int32, TimeSpan) ReceiveBatchAsync(Int32, TimeSpan) ReceiveBatchAsync(Int32, TimeSpan)

Asynchronously receives a message batch.

RegisterSessionHandler(Type) RegisterSessionHandler(Type) RegisterSessionHandler(Type)

Registers the session handler with specific type.

RegisterSessionHandler(Type, SessionHandlerOptions) RegisterSessionHandler(Type, SessionHandlerOptions) RegisterSessionHandler(Type, SessionHandlerOptions)

Registers the session handler with specific type and handler options.

RegisterSessionHandlerAsync(Type) RegisterSessionHandlerAsync(Type) RegisterSessionHandlerAsync(Type)

Asynchronously registers the session handler with specific type.

RegisterSessionHandlerAsync(Type, SessionHandlerOptions) RegisterSessionHandlerAsync(Type, SessionHandlerOptions) RegisterSessionHandlerAsync(Type, SessionHandlerOptions)

Asynchronously registers the session handler with specific type and handler options.

RegisterSessionHandlerFactory(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions) RegisterSessionHandlerFactory(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions) RegisterSessionHandlerFactory(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions)

Registers a message session handler factory with specified options.

RegisterSessionHandlerFactory(IMessageSessionHandlerFactory, SessionHandlerOptions) RegisterSessionHandlerFactory(IMessageSessionHandlerFactory, SessionHandlerOptions) RegisterSessionHandlerFactory(IMessageSessionHandlerFactory, SessionHandlerOptions)

Registers a message session handler factory with specified options.

RegisterSessionHandlerFactoryAsync(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions) RegisterSessionHandlerFactoryAsync(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions) RegisterSessionHandlerFactoryAsync(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions)

Asynchronously registers a message session handler factory.

RegisterSessionHandlerFactoryAsync(IMessageSessionHandlerFactory, SessionHandlerOptions) RegisterSessionHandlerFactoryAsync(IMessageSessionHandlerFactory, SessionHandlerOptions) RegisterSessionHandlerFactoryAsync(IMessageSessionHandlerFactory, SessionHandlerOptions)

Asynchronously registers a message session handler factory.

RenewMessageLock(Guid) RenewMessageLock(Guid) RenewMessageLock(Guid)
RenewMessageLockAsync(Guid) RenewMessageLockAsync(Guid) RenewMessageLockAsync(Guid)
ScheduleMessageAsync(BrokeredMessage, DateTimeOffset) ScheduleMessageAsync(BrokeredMessage, DateTimeOffset) ScheduleMessageAsync(BrokeredMessage, DateTimeOffset)

Sends a scheduled message

Send(BrokeredMessage) Send(BrokeredMessage) Send(BrokeredMessage)

Sends a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalSender.

SendAsync(BrokeredMessage) SendAsync(BrokeredMessage) SendAsync(BrokeredMessage)

Asynchronously sends a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalSender.

SendBatch(IEnumerable<BrokeredMessage>) SendBatch(IEnumerable<BrokeredMessage>) SendBatch(IEnumerable<BrokeredMessage>)

Sends a set of brokered messages (for batch processing).

SendBatchAsync(IEnumerable<BrokeredMessage>) SendBatchAsync(IEnumerable<BrokeredMessage>) SendBatchAsync(IEnumerable<BrokeredMessage>)

Asynchronously sends a set of brokered messages (for batch processing).

ThrowIfClosed() ThrowIfClosed() ThrowIfClosed() Inherited from ClientEntity
ThrowIfDisposed() ThrowIfDisposed() ThrowIfDisposed() Inherited from ClientEntity
ThrowIfDisposedOrImmutable() ThrowIfDisposedOrImmutable() ThrowIfDisposedOrImmutable() Inherited from ClientEntity
ThrowIfDisposedOrNotOpen() ThrowIfDisposedOrNotOpen() ThrowIfDisposedOrNotOpen() Inherited from ClientEntity
ThrowIfFaulted() ThrowIfFaulted() ThrowIfFaulted() Inherited from ClientEntity

Extension Methods

IsDefined(Object) IsDefined(Object) IsDefined(Object)

Determines if a certain property is defined or not.

IsNull(Object) IsNull(Object) IsNull(Object)

Determines if a certain property is null or not.

IsPrimitive(Object) IsPrimitive(Object) IsPrimitive(Object)

Determines if a certain property is of premitive JSON type.

Applies to