QueueClient Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents the queue client object.
public abstract class QueueClient : Microsoft.ServiceBus.Messaging.MessagingEntityClienttype QueueClient = class
inherit MessagingEntityClientPublic MustInherit Class QueueClient
Inherits MessagingEntityClient- Inheritance
Properties
| IsClosed | (Inherited from ClientEntity) |
| MessagingFactory |
Gets or sets the messaging factory. |
| Mode |
Gets the message receive mode when processing the received message. |
| Path |
Gets the queue's, topic's, or subscription's path relative to the MessagingFactory base address. (Inherited from MessagingEntityClient) |
| PrefetchCount |
Gets or sets the number of messages that the queue receiver can simultaneously request. |
| RetryPolicy | (Inherited from ClientEntity) |
| ThisLock | (Inherited from ClientEntity) |
Methods
| Abandon(Guid) |
Discards the message and relinquishes the message lock ownership. |
| Abandon(Guid, IDictionary<String,Object>) |
Discards the message and relinquishes the message lock ownership. |
| AbandonAsync(Guid) |
Asynchronously discards the message and relinquishes the message lock ownership. |
| AbandonAsync(Guid, IDictionary<String,Object>) |
Asynchronously discards the message and relinquishes the message lock ownership. |
| Abort() |
Performs abort functionality on the messaging entity. (Inherited from ClientEntity) |
| AcceptMessageSession() |
Accepts a message session that allows grouping of related messages for processing in a single transaction. |
| AcceptMessageSession(Boolean) |
Accepts a message session that allows grouping of related messages for processing in a single transaction ith whether in exclusive mode. |
| AcceptMessageSession(Boolean, TimeSpan) |
Accepts a message session that allows grouping of related messages for processing in a single transaction ith whether in exclusive mode. |
| 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, Boolean) |
Accepts a message session that allows grouping of related messages for processing in a single transaction with whether in exclusive mode. |
| AcceptMessageSession(String, Boolean, TimeSpan) |
Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier with whether in exclusive mode. |
| AcceptMessageSession(String, Guid) |
Accepts a message non-exclusive locked session that allows grouping of related messages for processing in a single transaction using the given session identifier and session lock token. |
| AcceptMessageSession(String, Guid, TimeSpan) |
Accepts a message non-exclusive locked session that allows grouping of related messages for processing in a single transaction using the given session identifier and session lock token. |
| 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) |
Accepts a message session that allows grouping of related messages for processing in a single transaction using the specified server wait time. |
| AcceptMessageSessionAsync() |
Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction. |
| AcceptMessageSessionAsync(Boolean) |
Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction with whether in exclusive mode and wait time. |
| AcceptMessageSessionAsync(Boolean, TimeSpan) |
Asynchronously accepts a message session that allows grouping of related messages for processing in a single transaction with whether in exclusive mode and wait time. |
| 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, Boolean) |
Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier with whether in exclusive mode. |
| AcceptMessageSessionAsync(String, Boolean, TimeSpan) |
Accepts a message session that allows grouping of related messages for processing in a single transaction using the given session identifier with whether in exclusive mode. |
| AcceptMessageSessionAsync(String, Guid) |
Accepts a message non-exclusive locked session that allows grouping of related messages for processing in a single transaction using the given session identifier and session lock token. |
| AcceptMessageSessionAsync(String, Guid, TimeSpan) |
Accepts a message non-exclusive locked session that allows grouping of related messages for processing in a single transaction using the given session identifier and session lock token. |
| 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) |
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) |
Cancels a scheduled message |
| Close() |
Sends a cleanup message to Service Bus to signal the completion of the usage of an entity. (Inherited from ClientEntity) |
| CloseAsync() |
Sends a cleanup message asynchronously to Service Bus to signal the completion of the usage of an entity. (Inherited from ClientEntity) |
| Complete(Guid) |
Completes processing of a message. |
| CompleteAsync(Guid) |
Asynchronously completes processing of a message. |
| CompleteBatch(IEnumerable<Guid>) |
Completes processing of a message batch. |
| CompleteBatchAsync(IEnumerable<Guid>) |
Asynchronously completes processing of a message batch. |
| Create(String) |
Creates a new copy of QueueClient with specified path. |
| Create(String, ReceiveMode) |
Creates a new copy of QueueClient with specified path and mode. |
| CreateFromConnectionString(String) |
Creates a new instance of QueueClient using the specified connection string. |
| CreateFromConnectionString(String, ReceiveMode) |
Creates a new instance of QueueClient using the specified connection string and receiving mode. |
| 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) |
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. |
| CreateWithAzureActiveDirectory(Uri, String, AzureActiveDirectoryTokenProvider+AuthenticationCallback, String, ReceiveMode, Nullable<TimeSpan>, TransportType) |
Creates a new instance of the QueueClient by using Azure Active Directory authentication context. |
| CreateWithManagedIdentity(Uri, String, ReceiveMode, Nullable<TimeSpan>, TransportType) |
Creates a new instance of the QueueClient by using Azure Managed Identity authentication. |
| DeadLetter(Guid) |
Moves the undelivered message to the dead letter queue. |
| DeadLetter(Guid, IDictionary<String,Object>) |
Moves the undelivered message to the dead letter queue. |
| DeadLetter(Guid, String, String) |
Moves the undelivered message to the dead letter queue. |
| DeadLetterAsync(Guid) |
Asynchronously moves the undelivered message to the dead letter queue. |
| DeadLetterAsync(Guid, IDictionary<String,Object>) |
Asynchronously moves the undelivered message to the dead letter queue. |
| DeadLetterAsync(Guid, String, String) |
Asynchronously moves the undelivered message to the dead letter queue. |
| Defer(Guid) |
Suspends the processing of a message. |
| Defer(Guid, IDictionary<String,Object>) |
Suspends the processing of a message. |
| DeferAsync(Guid) |
Asynchronously suspends the processing of a message. |
| DeferAsync(Guid, IDictionary<String,Object>) |
Asynchronously suspends the processing of a message. |
| Fault() |
For internal use only. Do not inherit from this class. (Inherited from ClientEntity) |
| FormatDeadLetterPath(String) |
Builds a format name from the specified dead letter queue path. |
| FormatTransferDeadLetterPath(String) | |
| GetMessageSessions() |
Gets the message sessions, enabling you to browse sessions on queues. Only sessions with active messages in the queue are returned. The sessions on the deadletter queue or sessions having a SessionState as 'active' and no messages are not returned with this call. |
| GetMessageSessions(DateTime) |
Retrieves all message sessions whose session state was updated since |
| GetMessageSessionsAsync() |
Asynchronously gets the message sessions, enabling you to browse sessions on queues. Only sessions with active messages in the queue are returned. The sessions on the deadletter queue or sessions having a SessionState as 'active' and no messages are not returned with this call. |
| GetMessageSessionsAsync(DateTime) |
Asynchronously retrieves all message sessions whose session state was updated since |
| OnAbort() |
Executes upon calling the Abort event. |
| OnBeginAcceptMessageSession(String, ReceiveMode, Int32, Boolean, Nullable<Guid>, TimeSpan, TimeSpan, AsyncCallback, Object) | |
| OnBeginClose(TimeSpan, AsyncCallback, Object) |
Executes when the Close operation is called. |
| OnBeginCreateReceiver(ReceiveMode, TimeSpan, AsyncCallback, Object) |
Executes the begin create receiver action. |
| OnBeginCreateReceiver(String, ReceiveMode, TimeSpan, AsyncCallback, Object) |
Executes the begin create receiver action. |
| OnBeginCreateSender(TimeSpan, AsyncCallback, Object) |
Executes the begin create sender action. |
| OnBeginGetMessageSessions(DateTime, AsyncCallback, Object) |
Executes the BeginGetMessageSessions action. |
| OnBeginOpen(TimeSpan, AsyncCallback, Object) | (Inherited from ClientEntity) |
| OnClose(TimeSpan) |
Executes upon calling the Close action. |
| OnClosed() | (Inherited from ClientEntity) |
| OnEndAcceptMessageSession(IAsyncResult) |
Executes upon calling the EndAcceptMessageSession operation. |
| OnEndClose(IAsyncResult) |
Executes the end close action. |
| OnEndCreateReceiver(IAsyncResult) |
Executes the end create receiver action. |
| OnEndCreateSender(IAsyncResult) |
Executes the end create sender action. |
| OnEndGetMessageSessions(IAsyncResult) |
Executes the end get message action. |
| OnEndOpen(IAsyncResult) | (Inherited from ClientEntity) |
| OnFaulted() | (Inherited from ClientEntity) |
| OnMessage(Action<BrokeredMessage>) |
Processes a message in an event-driven message pump. |
| OnMessage(Action<BrokeredMessage>, OnMessageOptions) |
Processes a message in an event-driven message pump, with the given set of OnMessageOptions options. |
| OnMessageAsync(Func<BrokeredMessage,Task>) |
Asynchronously processes a message. |
| OnMessageAsync(Func<BrokeredMessage,Task>, OnMessageOptions) |
Asynchronously processes a message. |
| OnOpen(TimeSpan) | (Inherited from ClientEntity) |
| OnOpened() | (Inherited from ClientEntity) |
| Peek() |
Returns without removing the first message in the queue. |
| Peek(Int64) |
Returns without removing the first message in the queue. |
| PeekAsync() |
Asynchronously returns without removing the first message in the queue. |
| PeekAsync(Int64) |
Asynchronously returns without removing the first message in the queue. |
| PeekBatch(Int32) |
Peeks a batch of messages. |
| PeekBatch(Int64, Int32) |
Peeks a batch of messages. |
| PeekBatchAsync(Int32) |
Asynchronously peeks a batch of message. |
| PeekBatchAsync(Int64, Int32) |
Asynchronously peeks a batch of message. |
| Receive() |
Receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver. |
| Receive(Int64) |
Receives a deferred message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver. This method only works for deferred message, not regular one. |
| Receive(TimeSpan) |
Receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver. |
| ReceiveAsync() |
Asynchronously receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver. |
| ReceiveAsync(Int64) |
Asynchronously receives a deferred message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver. This method only works for deferred message, not regular one. |
| ReceiveAsync(TimeSpan) |
Asynchronously receives a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver. |
| ReceiveBatch(IEnumerable<Int64>) |
Receives a message batch. |
| ReceiveBatch(Int32) |
Receives a message batch. |
| ReceiveBatch(Int32, TimeSpan) |
Receives a message batch. |
| ReceiveBatchAsync(IEnumerable<Int64>) |
Asynchronously receives a message batch. |
| ReceiveBatchAsync(Int32) |
Asynchronously receives a message batch. |
| ReceiveBatchAsync(Int32, TimeSpan) |
Asynchronously receives a message batch. |
| RegisterSessionHandler(Type) |
Registers the session handler with specific type. |
| RegisterSessionHandler(Type, SessionHandlerOptions) |
Registers the session handler with specific type and handler options. |
| RegisterSessionHandlerAsync(Type) |
Asynchronously registers the session handler with specific type. |
| RegisterSessionHandlerAsync(Type, SessionHandlerOptions) |
Asynchronously registers the session handler with specific type and handler options. |
| RegisterSessionHandlerFactory(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions) |
Registers a message session handler factory with specified options. |
| RegisterSessionHandlerFactory(IMessageSessionHandlerFactory, SessionHandlerOptions) |
Registers a message session handler factory with specified options. |
| RegisterSessionHandlerFactoryAsync(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions) |
Asynchronously registers a message session handler factory. |
| RegisterSessionHandlerFactoryAsync(IMessageSessionHandlerFactory, SessionHandlerOptions) |
Asynchronously registers a message session handler factory. |
| RenewMessageLock(Guid) | |
| RenewMessageLockAsync(Guid) | |
| ScheduleMessageAsync(BrokeredMessage, DateTimeOffset) |
Sends a scheduled message |
| Send(BrokeredMessage) |
Sends a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalSender. |
| SendAsync(BrokeredMessage) |
Asynchronously sends a message using the Microsoft.ServiceBus.Messaging.QueueClient.InternalSender. |
| SendBatch(IEnumerable<BrokeredMessage>) |
Sends a set of brokered messages (for batch processing). |
| SendBatchAsync(IEnumerable<BrokeredMessage>) |
Asynchronously sends a set of brokered messages (for batch processing). |
| ThrowIfClosed() | (Inherited from ClientEntity) |
| ThrowIfDisposed() | (Inherited from ClientEntity) |
| ThrowIfDisposedOrImmutable() | (Inherited from ClientEntity) |
| ThrowIfDisposedOrNotOpen() | (Inherited from ClientEntity) |
| ThrowIfFaulted() | (Inherited from ClientEntity) |
Applies to
Azure SDK for .NET