你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

QueueClient 类

定义

表示队列客户端对象。

public abstract class QueueClient : Microsoft.ServiceBus.Messaging.MessagingEntityClient
type QueueClient = class
    inherit MessagingEntityClient
Public MustInherit Class QueueClient
Inherits MessagingEntityClient
继承

属性

IsClosed

表示队列客户端对象。

(继承自 ClientEntity)
MessagingFactory

获取或设置消息工厂。

Mode

获取处理收到的消息时的消息接收模式。

Path

获取队列、主题或订阅相对于 MessagingFactory 基址的路径。

(继承自 MessagingEntityClient)
PrefetchCount

获取或设置队列接收方可以同时请求的消息数。

RetryPolicy

表示队列客户端对象。

(继承自 ClientEntity)
ThisLock

表示队列客户端对象。

(继承自 ClientEntity)

方法

Abandon(Guid)

放弃消息并放弃消息锁的所有权。

Abandon(Guid, IDictionary<String,Object>)

放弃消息并放弃消息锁的所有权。

AbandonAsync(Guid)

异步放弃消息并放弃消息锁所有权。

AbandonAsync(Guid, IDictionary<String,Object>)

异步放弃消息并放弃消息锁所有权。

Abort()

对消息传送实体执行中止功能。

(继承自 ClientEntity)
AcceptMessageSession()

接受一个消息会话,该会话允许对相关消息进行分组,以便在单个事务中进行处理。

AcceptMessageSession(Boolean)

接受一个消息会话,该会话允许对相关消息进行分组,以便在单个事务中进行处理,无论是否处于独占模式。

AcceptMessageSession(Boolean, TimeSpan)

接受一个消息会话,该会话允许对相关消息进行分组,以便在单个事务中进行处理,无论是否处于独占模式。

AcceptMessageSession(String)

接受允许使用给定会话标识符在单个事务中处理的相关消息分组的消息会话。

AcceptMessageSession(String, Boolean)

接受一个消息会话,该会话允许对相关消息进行分组,以便在单个事务中进行处理,无论是否处于独占模式。

AcceptMessageSession(String, Boolean, TimeSpan)

接受一个消息会话,该会话允许使用给定会话标识符在单个事务中对相关消息进行分组处理,无论是否处于独占模式。

AcceptMessageSession(String, Guid)

接受一个消息非独占锁定会话,该会话允许使用给定会话标识符和会话锁令牌在单个事务中对相关消息进行分组处理。

AcceptMessageSession(String, Guid, TimeSpan)

接受一个消息非独占锁定会话,该会话允许使用给定会话标识符和会话锁令牌在单个事务中对相关消息进行分组处理。

AcceptMessageSession(String, TimeSpan)

接受一个消息会话,该会话允许使用给定的会话标识符和等待时间对相关消息进行分组,以便在单个事务中进行处理。

AcceptMessageSession(TimeSpan)

接受一个消息会话,该会话允许使用指定的服务器等待时间对相关消息进行分组,以便在单个事务中进行处理。

AcceptMessageSessionAsync()

异步接受一个消息会话,该会话允许对相关消息进行分组,以便在单个事务中进行处理。

AcceptMessageSessionAsync(Boolean)

异步接受一个消息会话,该会话允许对相关消息进行分组,以便在单个事务中进行处理,无论是否处于独占模式和等待时间。

AcceptMessageSessionAsync(Boolean, TimeSpan)

异步接受一个消息会话,该会话允许对相关消息进行分组,以便在单个事务中进行处理,无论是否处于独占模式和等待时间。

AcceptMessageSessionAsync(String)

异步接受一个消息会话,该会话允许使用给定会话标识符在单个事务中对相关消息进行分组处理。

AcceptMessageSessionAsync(String, Boolean)

接受一个消息会话,该会话允许使用给定会话标识符在单个事务中对相关消息进行分组处理,无论是否处于独占模式。

AcceptMessageSessionAsync(String, Boolean, TimeSpan)

接受一个消息会话,该会话允许使用给定会话标识符在单个事务中对相关消息进行分组处理,无论是否处于独占模式。

AcceptMessageSessionAsync(String, Guid)

接受一个消息非独占锁定会话,该会话允许使用给定会话标识符和会话锁令牌在单个事务中对相关消息进行分组处理。

AcceptMessageSessionAsync(String, Guid, TimeSpan)

接受一个消息非独占锁定会话,该会话允许使用给定会话标识符和会话锁令牌在单个事务中对相关消息进行分组处理。

AcceptMessageSessionAsync(String, TimeSpan)

异步接受一个消息会话,该会话允许使用给定会话标识符和等待时间对相关消息进行分组,以便在单个事务中进行处理。

AcceptMessageSessionAsync(TimeSpan)

异步接受一个消息会话,该会话允许使用指定的服务器等待时间对相关消息进行分组,以便在单个事务中进行处理。

CancelScheduledMessageAsync(Int64)

取消计划邮件

Close()

向服务总线发送清理消息,以指示实体的使用完成。

(继承自 ClientEntity)
CloseAsync()

以异步方式将清理消息发送到服务总线,以指示实体的使用完成。

(继承自 ClientEntity)
Complete(Guid)

完成消息的处理。

CompleteAsync(Guid)

异步完成消息的处理。

CompleteBatch(IEnumerable<Guid>)

完成消息批处理的处理。

CompleteBatchAsync(IEnumerable<Guid>)

异步完成消息批处理的处理。

Create(String)

使用指定路径创建 的新 QueueClient 副本。

Create(String, ReceiveMode)

使用指定的路径和模式创建 的新 QueueClient 副本。

CreateFromConnectionString(String)

使用指定的连接字符串创建 的新 QueueClient 实例。

CreateFromConnectionString(String, ReceiveMode)

使用指定的连接字符串和接收模式创建 的新 QueueClient 实例。

CreateFromConnectionString(String, String)

从具有指定队列路径的 QueueClient 连接字符串创建 的新副本。 仅当连接字符串不使用 属性时, EntityPath 才使用此重载。

CreateFromConnectionString(String, String, ReceiveMode)

从具有指定路径和模式的连接字符串创建 的新实例 QueueClient 。 仅当连接字符串不使用 属性时, EntityPath 才使用此重载。

CreateWithAzureActiveDirectory(Uri, String, AzureActiveDirectoryTokenProvider+AuthenticationCallback, String, ReceiveMode, Nullable<TimeSpan>, TransportType)

使用 Azure Active Directory 身份验证上下文创建 的新实例 QueueClient

CreateWithManagedIdentity(Uri, String, ReceiveMode, Nullable<TimeSpan>, TransportType)

使用 Azure 托管标识身份验证创建 的新 QueueClient 实例。

DeadLetter(Guid)

将未传递的消息移动到死信队列。

DeadLetter(Guid, IDictionary<String,Object>)

将未传递的消息移动到死信队列。

DeadLetter(Guid, String, String)

将未传递的消息移动到死信队列。

DeadLetterAsync(Guid)

异步将未传递的消息移动到死信队列。

DeadLetterAsync(Guid, IDictionary<String,Object>)

异步将未传递的消息移动到死信队列。

DeadLetterAsync(Guid, String, String)

异步将未传递的消息移动到死信队列。

Defer(Guid)

暂停消息的处理。

Defer(Guid, IDictionary<String,Object>)

暂停消息的处理。

DeferAsync(Guid)

异步挂起消息的处理。

DeferAsync(Guid, IDictionary<String,Object>)

异步挂起消息的处理。

Fault()

仅限内部使用。 请勿从此类继承。

(继承自 ClientEntity)
FormatDeadLetterPath(String)

从指定的死信队列路径生成格式名称。

FormatTransferDeadLetterPath(String)

表示队列客户端对象。

GetMessageSessions()

获取消息会话,使你能够浏览队列上的会话。 仅返回队列中具有活动消息的会话。 死信队列上的会话或会话的 SessionState 为“活动”,并且此调用不会返回任何消息。

GetMessageSessions(DateTime)

检索自 以来 lastUpdatedTime会话状态已更新的所有消息会话。

GetMessageSessionsAsync()

异步获取消息会话,使你能够浏览队列上的会话。 仅返回队列中具有活动消息的会话。 死信队列上的会话或会话的 SessionState 为“活动”,并且此调用不会返回任何消息。

GetMessageSessionsAsync(DateTime)

异步检索自 以来 lastUpdatedTime会话状态已更新的所有消息会话。

OnAbort()

调用中止事件时执行。

OnBeginAcceptMessageSession(String, ReceiveMode, Int32, Boolean, Nullable<Guid>, TimeSpan, TimeSpan, AsyncCallback, Object)

表示队列客户端对象。

OnBeginClose(TimeSpan, AsyncCallback, Object)

在调用 Close 操作时执行。

OnBeginCreateReceiver(ReceiveMode, TimeSpan, AsyncCallback, Object)

执行开始创建接收器操作。

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

执行开始创建接收器操作。

OnBeginCreateSender(TimeSpan, AsyncCallback, Object)

执行开始创建发件人操作。

OnBeginGetMessageSessions(DateTime, AsyncCallback, Object)

执行 BeginGetMessageSessions 操作。

OnBeginOpen(TimeSpan, AsyncCallback, Object)

表示队列客户端对象。

(继承自 ClientEntity)
OnClose(TimeSpan)

调用 Close 操作时执行。

OnClosed()

表示队列客户端对象。

(继承自 ClientEntity)
OnEndAcceptMessageSession(IAsyncResult)

调用 EndAcceptMessageSession 操作时执行。

OnEndClose(IAsyncResult)

执行结束关闭操作。

OnEndCreateReceiver(IAsyncResult)

执行结束创建接收器操作。

OnEndCreateSender(IAsyncResult)

执行结束创建发件人操作。

OnEndGetMessageSessions(IAsyncResult)

执行结束获取消息操作。

OnEndOpen(IAsyncResult)

表示队列客户端对象。

(继承自 ClientEntity)
OnFaulted()

表示队列客户端对象。

(继承自 ClientEntity)
OnMessage(Action<BrokeredMessage>)

在事件驱动的消息泵中处理消息。

OnMessage(Action<BrokeredMessage>, OnMessageOptions)

使用给定的一组 OnMessageOptions 选项在事件驱动的消息泵中处理消息。

OnMessageAsync(Func<BrokeredMessage,Task>)

异步处理消息。

OnMessageAsync(Func<BrokeredMessage,Task>, OnMessageOptions)

异步处理消息。

OnOpen(TimeSpan)

表示队列客户端对象。

(继承自 ClientEntity)
OnOpened()

表示队列客户端对象。

(继承自 ClientEntity)
Peek()

返回 ,但不删除队列中的第一条消息。

Peek(Int64)

返回 ,但不删除队列中的第一条消息。

PeekAsync()

在不删除队列中的第一条消息的情况下异步返回。

PeekAsync(Int64)

在不删除队列中的第一条消息的情况下异步返回。

PeekBatch(Int32)

速览一批消息。

PeekBatch(Int64, Int32)

速览一批消息。

PeekBatchAsync(Int32)

异步速览一批消息。

PeekBatchAsync(Int64, Int32)

异步速览一批消息。

Receive()

使用 Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver接收消息。

Receive(Int64)

使用 Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver接收延迟消息。 此方法仅适用于延迟消息,不适用于常规消息。

Receive(TimeSpan)

使用 Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver接收消息。

ReceiveAsync()

使用 Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver异步接收消息。

ReceiveAsync(Int64)

使用 Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver异步接收延迟的消息。 此方法仅适用于延迟消息,不适用于常规消息。

ReceiveAsync(TimeSpan)

使用 Microsoft.ServiceBus.Messaging.QueueClient.InternalReceiver异步接收消息。

ReceiveBatch(IEnumerable<Int64>)

接收消息批。

ReceiveBatch(Int32)

接收消息批。

ReceiveBatch(Int32, TimeSpan)

接收消息批。

ReceiveBatchAsync(IEnumerable<Int64>)

异步接收消息批。

ReceiveBatchAsync(Int32)

异步接收消息批。

ReceiveBatchAsync(Int32, TimeSpan)

异步接收消息批。

RegisterSessionHandler(Type)

使用特定类型注册会话处理程序。

RegisterSessionHandler(Type, SessionHandlerOptions)

使用特定类型和处理程序选项注册会话处理程序。

RegisterSessionHandlerAsync(Type)

使用特定类型异步注册会话处理程序。

RegisterSessionHandlerAsync(Type, SessionHandlerOptions)

使用特定类型和处理程序选项异步注册会话处理程序。

RegisterSessionHandlerFactory(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions)

使用指定选项注册消息会话处理程序工厂。

RegisterSessionHandlerFactory(IMessageSessionHandlerFactory, SessionHandlerOptions)

使用指定选项注册消息会话处理程序工厂。

RegisterSessionHandlerFactoryAsync(IMessageSessionAsyncHandlerFactory, SessionHandlerOptions)

异步注册消息会话处理程序工厂。

RegisterSessionHandlerFactoryAsync(IMessageSessionHandlerFactory, SessionHandlerOptions)

异步注册消息会话处理程序工厂。

RenewMessageLock(Guid)

表示队列客户端对象。

RenewMessageLockAsync(Guid)

表示队列客户端对象。

ScheduleMessageAsync(BrokeredMessage, DateTimeOffset)

发送计划的消息

Send(BrokeredMessage)

使用 Microsoft.ServiceBus.Messaging.QueueClient.InternalSender发送消息。

SendAsync(BrokeredMessage)

使用 Microsoft.ServiceBus.Messaging.QueueClient.InternalSender异步发送消息。

SendBatch(IEnumerable<BrokeredMessage>)

发送一组中转消息 (进行批处理) 。

SendBatchAsync(IEnumerable<BrokeredMessage>)

异步发送一组中转消息 (进行批处理) 。

ThrowIfClosed()

表示队列客户端对象。

(继承自 ClientEntity)
ThrowIfDisposed()

表示队列客户端对象。

(继承自 ClientEntity)
ThrowIfDisposedOrImmutable()

表示队列客户端对象。

(继承自 ClientEntity)
ThrowIfDisposedOrNotOpen()

表示队列客户端对象。

(继承自 ClientEntity)
ThrowIfFaulted()

表示队列客户端对象。

(继承自 ClientEntity)

适用于