导出 (0) 打印
全部展开

SubscriptionClient 类

注:本页面内容可能不完全适用中国大陆地区运营的 Windows Azure服务。如要了解不同地区 Windows Azure 服务的差异, 请参考本网站.

代表与主题订阅相关的运行时操作中使用的定位点类。

命名空间:  Microsoft.ServiceBus.Messaging
程序集:  Microsoft.ServiceBus(在 Microsoft.ServiceBus.dll 中)

public abstract class SubscriptionClient : MessageClientEntity

SubscriptionClient 类型公开以下成员。

  名称说明
公共属性IsClosed (从 ClientEntity 继承。)
公共属性MessagingFactory获取用于创建此订阅客户端的消息工厂。
公共属性Mode获取处理收到的消息时的消息接收模式。
公共属性Name获取订阅的名称。
公共属性PrefetchCount获取或设置消息接收器可同时请求的消息数。
公共属性RetryPolicy (从 ClientEntity 继承。)
受保护属性ThisLock (从 ClientEntity 继承。)
公共属性TopicPath获取主题的完整路径名。
页首

  名称说明
公共方法Abandon(Guid)丢弃消息并放弃消息锁所有权。
公共方法Abandon(Guid, IDictionary<(Of <<'(String, Object>)>>))丢弃消息并放弃消息锁所有权。
公共方法AbandonAsync(Guid)异步丢弃消息并放弃消息锁所有权。
公共方法AbandonAsync(Guid, IDictionary<(Of <<'(String, Object>)>>))异步丢弃消息并放弃消息锁所有权。
公共方法AbortPerforms abort functionality on the messaging entity. (从 ClientEntity 继承。)
公共方法AcceptMessageSession()()()()接受一个消息会话,该会话允许将相关消息分组以便在单个事务中处理。
公共方法AcceptMessageSession(String)接受一个消息会话,该会话允许将相关消息分组,以便使用给定的会话标识符在单个事务中处理。
公共方法AcceptMessageSession(TimeSpan)接受一个消息会话,该会话允许将相关消息分组,以便使用指定的服务器等待时间在单个事务中处理。
公共方法AcceptMessageSession(String, TimeSpan)接受一个消息会话,该会话允许将相关消息分组,以便使用给定的会话标识符和等待时间在单个事务中处理。
公共方法AcceptMessageSessionAsync()()()()异步接受一个消息会话,该会话允许将相关消息分组,以便使用指定的服务器等待时间在单个事务中处理。
公共方法AcceptMessageSessionAsync(String)异步接受一个消息会话,该会话允许将相关消息分组,以便使用指定的服务器等待时间在单个事务中处理。
公共方法AcceptMessageSessionAsync(TimeSpan)异步接受一个消息会话,该会话允许将相关消息分组,以便使用指定的服务器等待时间在单个事务中处理。
公共方法AcceptMessageSessionAsync(String, TimeSpan)异步接受一个消息会话,该会话允许将相关消息分组,以便使用指定的服务器等待时间在单个事务中处理。
公共方法AddRule(RuleDescription)使用指定的规则描述将新规则添加到 Subscription
公共方法AddRule(String, Filter)使用指定的名称和筛选器表达式将规则添加到当前订阅。
公共方法AddRuleAsync(RuleDescription)使用指定的规则描述将新规则异步添加到 Subscription
公共方法AddRuleAsync(String, Filter)使用指定的名称和筛选器表达式将规则异步添加到当前订阅。
公共方法BeginAbandon(Guid, AsyncCallback, Object)开始用于放弃消息及其锁的异步操作。
公共方法BeginAbandon(Guid, IDictionary<(Of <<'(String, Object>)>>), AsyncCallback, Object)开始用于放弃消息及其锁的异步操作。
公共方法BeginAcceptMessageSession(AsyncCallback, Object)开始用于接受消息会话的异步操作。
公共方法BeginAcceptMessageSession(String, AsyncCallback, Object)开始用于接受消息会话的异步操作。
公共方法BeginAcceptMessageSession(TimeSpan, AsyncCallback, Object)开始用于接受消息会话的异步操作。
公共方法BeginAcceptMessageSession(String, TimeSpan, AsyncCallback, Object)开始用于接受消息会话的异步操作。
公共方法BeginAddRule(RuleDescription, AsyncCallback, Object)开始用于向订阅添加新规则的异步操作。
公共方法BeginAddRule(String, Filter, AsyncCallback, Object)开始用于向订阅添加新规则的异步操作。
公共方法BeginClose开始用于关闭消息客户端实体的异步操作。 (从 MessageClientEntity 继承。)
公共方法BeginComplete开始用于完成消息处理的异步操作。
公共方法BeginCompleteBatch开始用于完成消息处理的异步操作。
公共方法BeginDeadLetter(Guid, AsyncCallback, Object)开始用于将消息移至死信队列的异步操作。
公共方法BeginDeadLetter(Guid, IDictionary<(Of <<'(String, Object>)>>), AsyncCallback, Object)开始用于将消息移至死信队列的异步操作。
公共方法BeginDeadLetter(Guid, String, String, AsyncCallback, Object)开始用于将消息移至死信队列的异步操作。
公共方法BeginDefer(Guid, AsyncCallback, Object)开始用于挂起消息处理的异步操作。
公共方法BeginDefer(Guid, IDictionary<(Of <<'(String, Object>)>>), AsyncCallback, Object)开始用于挂起消息处理的异步操作。
公共方法BeginGetMessageSessions(AsyncCallback, Object)开始用于获取消息会话的异步操作。
公共方法BeginGetMessageSessions(DateTime, AsyncCallback, Object)开始用于获取消息会话的异步操作。
公共方法BeginPeek(AsyncCallback, Object)开始用于返回的异步操作,但不删除队列中的第一个消息。
公共方法BeginPeek(Int64, AsyncCallback, Object)开始用于返回的异步操作,但不删除队列中的第一个消息。
公共方法BeginPeekBatch(Int32, AsyncCallback, Object)开始用于扫视批的异步操作。
公共方法BeginPeekBatch(Int64, Int32, AsyncCallback, Object)开始用于扫视批的异步操作。
公共方法BeginReceive(AsyncCallback, Object)开始用于接收消息的异步操作。
公共方法BeginReceive(Int64, AsyncCallback, Object)开始用于接收消息的异步操作。
公共方法BeginReceive(TimeSpan, AsyncCallback, Object)开始用于接收消息的异步操作。
公共方法BeginReceiveBatch(IEnumerable<(Of <<'(Int64>)>>), AsyncCallback, Object)开始用于接收批的异步操作。
公共方法BeginReceiveBatch(Int32, AsyncCallback, Object)开始用于接收批的异步操作。
公共方法BeginReceiveBatch(Int32, TimeSpan, AsyncCallback, Object)开始用于接收批的异步操作。
公共方法BeginRemoveRule开始“删除规则”异步操作。
公共方法CloseSends a cleanup message to Service Bus to signal the completion of the usage of an entity. (从 ClientEntity 继承。)
公共方法CloseAsyncSends a cleanup message asynchronously to Service Bus to signal the completion of the usage of an entity. (从 ClientEntity 继承。)
公共方法Complete完成消息处理。
公共方法CompleteAsync异步完成消息处理。
公共方法CompleteBatch完成批处理。
公共方法CompleteBatchAsync异步完成批处理。
公共方法静态成员Create(String, String)使用指定的名称和主题路径创建 SubscriptionClient 的新副本。
公共方法静态成员Create(String, String, ReceiveMode)使用指定的名称、主题路径和模式创建 SubscriptionClient 的新副本。
公共方法静态成员CreateFromConnectionString(String, String, String)使用指定的主题路径和名称从连接字符串创建 SubscriptionClient 的新副本。
公共方法静态成员CreateFromConnectionString(String, String, String, ReceiveMode)使用指定的主题路径、名称和模式从连接字符串创建 SubscriptionClient 的新副本。
公共方法DeadLetter(Guid)将未传递的消息移至死信队列。
公共方法DeadLetter(Guid, IDictionary<(Of <<'(String, Object>)>>))将未传递的消息移至死信队列。
公共方法DeadLetter(Guid, String, String)将未传递的消息移至死信队列。
公共方法DeadLetterAsync(Guid)将未传递的消息异步移动到死信队列。
公共方法DeadLetterAsync(Guid, IDictionary<(Of <<'(String, Object>)>>))将未传递的消息异步移动到死信队列。
公共方法DeadLetterAsync(Guid, String, String)将未传递的消息异步移动到死信队列。
公共方法Defer(Guid)挂起消息处理。
公共方法Defer(Guid, IDictionary<(Of <<'(String, Object>)>>))挂起消息处理。
公共方法DeferAsync(Guid)异步挂起消息处理。
公共方法DeferAsync(Guid, IDictionary<(Of <<'(String, Object>)>>))异步挂起消息处理。
公共方法EndAbandon完成用于放弃消息及其锁的异步操作。
公共方法EndAcceptMessageSession完成用于接受消息会话的异步操作,该会话允许将相关消息分组以便在单个事务中处理。
公共方法EndAddRule结束“添加规则”异步操作。
公共方法EndClose完成用于关闭消息客户端实体的异步操作。 (从 MessageClientEntity 继承。)
公共方法EndComplete完成用于完成消息处理的异步操作。
公共方法EndCompleteBatch完成用于完成批处理的异步操作。
公共方法EndDeadLetter完成用于将消息移至死信队列的异步操作。
公共方法EndDefer完成用于挂起消息处理的异步操作。
公共方法EndGetMessageSessions完成用于获取消息处理的异步操作。
公共方法EndPeek完成异步扫视操作。
公共方法EndPeekBatch对消息批完成异步扫视操作。
公共方法EndReceive完成用于接收消息的异步操作。
公共方法EndReceiveBatch完成用于接收批的异步操作。
公共方法EndRemoveRule结束“删除规则”异步操作。
公共方法Equals (从 Object 继承。)
受保护方法FaultFor internal use only. Do not inherit from this class. (从 ClientEntity 继承。)
受保护方法Finalize (从 Object 继承。)
公共方法静态成员FormatDeadLetterPath使用指定的主题路径和订阅名称构建格式名称死信路径。
公共方法静态成员FormatSubscriptionPath使用指定的主题路径和订阅名称构建格式名称订阅路径。
公共方法GetHashCode (从 Object 继承。)
公共方法GetMessageSessions()()()()获取一个消息会话,该会话允许将相关消息分组以便在单个事务中处理。
公共方法GetMessageSessions(DateTime)检索自 lastUpdatedTime 以来已更新了会话状态的所有消息会话。
公共方法GetMessageSessionsAsync()()()()异步获取一个消息会话,该会话允许将相关消息分组以便在单个事务中处理。
公共方法GetMessageSessionsAsync(DateTime)异步获取一个消息会话,该会话允许将相关消息分组以便在单个事务中处理。
公共方法GetType (从 Object 继承。)
受保护方法MemberwiseClone (从 Object 继承。)
受保护方法OnAbort执行中止操作。 (覆盖 ClientEntity..::..OnAbort()()()()。)
受保护方法OnBeginAcceptMessageSession在调用 BeginAcceptMessageSession 操作时执行。
受保护方法OnBeginAddRule在调用 BeginAddRule 操作时执行。
受保护方法OnBeginClose执行“开始关闭”操作。 (覆盖 ClientEntity..::..OnBeginClose(TimeSpan, AsyncCallback, Object)。)
受保护方法OnBeginCreateReceiver(ReceiveMode, TimeSpan, AsyncCallback, Object)执行“开始创建接收器”操作。
受保护方法OnBeginCreateReceiver(String, String, ReceiveMode, TimeSpan, AsyncCallback, Object)执行“开始创建接收器”操作。
受保护方法OnBeginGetMessageSessions在调用 BeginGetMessageSessions 操作时执行。
受保护方法OnBeginOpen (从 ClientEntity 继承。)
受保护方法OnBeginRemoveRule开始通过运行时客户端协议从 Rule 删除 Subscription
受保护方法OnBeginRemoveRulesByTag开始使用标记通过运行时客户端协议从 Rule 删除 Subscription
受保护方法OnClose执行关闭操作。 (覆盖 ClientEntity..::..OnClose(TimeSpan)。)
受保护方法OnClosed (从 ClientEntity 继承。)
受保护方法OnEndAcceptMessageSession在调用 EndAcceptMessageSession 操作时执行。
受保护方法OnEndAddRule结束对 OnBeginAddRule 的异步调用。
受保护方法OnEndClose执行“结束关闭”操作。 (覆盖 ClientEntity..::..OnEndClose(IAsyncResult)。)
受保护方法OnEndCreateReceiver执行“结束创建接收器”操作。
受保护方法OnEndGetMessageSessions执行“结束获取消息”操作。
受保护方法OnEndOpen (从 ClientEntity 继承。)
受保护方法OnEndRemoveRule结束对 OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object) 的异步调用。
受保护方法OnEndRemoveRules结束对 OnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object) 的异步调用。
受保护方法OnFaulted (从 ClientEntity 继承。)
公共方法OnMessage(Action<(Of <<'(BrokeredMessage>)>>))在事件驱动的消息泵中处理消息。
公共方法OnMessage(Action<(Of <<'(BrokeredMessage>)>>), OnMessageOptions)使用给定的一组 OnMessageOptions 选项,在事件驱动的消息泵中处理消息。
公共方法OnMessageAsync(Func<(Of <<'(BrokeredMessage, Task>)>>))异步处理消息。
公共方法OnMessageAsync(Func<(Of <<'(BrokeredMessage, Task>)>>), OnMessageOptions)异步处理消息。
受保护方法OnOpen (从 ClientEntity 继承。)
受保护方法OnOpened (从 ClientEntity 继承。)
公共方法Peek()()()()返回,但不删除队列中的第一个消息。
公共方法Peek(Int64)返回,但不删除队列中的第一个消息。
公共方法PeekAsync()()()()异步返回,但不删除队列中的第一个消息。
公共方法PeekAsync(Int64)异步返回,但不删除队列中的第一个消息。
公共方法PeekBatch(Int32)返回,但不删除批中的第一个消息。
公共方法PeekBatch(Int64, Int32)返回,但不删除批中的第一个消息。
公共方法PeekBatchAsync(Int32)异步返回,但不删除批中的第一个消息。
公共方法PeekBatchAsync(Int64, Int32)异步返回,但不删除批中的第一个消息。
公共方法Receive()()()()使用 InternalReceiver()()()() 接收消息。
公共方法Receive(Int64)使用 InternalReceiver()()()() 接收消息。
公共方法Receive(TimeSpan)使用 InternalReceiver()()()() 接收消息。
公共方法ReceiveAsync()()()()使用 InternalReceiver()()()() 来异步接收消息。
公共方法ReceiveAsync(Int64)使用 InternalReceiver()()()() 来异步接收消息。
公共方法ReceiveAsync(TimeSpan)使用 InternalReceiver()()()() 来异步接收消息。
公共方法ReceiveBatch(IEnumerable<(Of <<'(Int64>)>>))接收异步操作后生成的批。
公共方法ReceiveBatch(Int32)接收异步操作后生成的批。
公共方法ReceiveBatch(Int32, TimeSpan)接收异步操作后生成的批。
公共方法ReceiveBatchAsync(IEnumerable<(Of <<'(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)异步注册客户端会话的处理程序工厂。
公共方法RemoveRule删除 ruleName 所描述的规则。
公共方法RemoveRuleAsync异步删除 ruleName 所描述的规则。
受保护方法ThrowIfClosed (从 ClientEntity 继承。)
受保护方法ThrowIfDisposed (从 ClientEntity 继承。)
受保护方法ThrowIfDisposedOrImmutable (从 ClientEntity 继承。)
受保护方法ThrowIfDisposedOrNotOpen (从 ClientEntity 继承。)
受保护方法ThrowIfFaulted (从 ClientEntity 继承。)
公共方法ToString (从 Object 继承。)
页首

This abstract class is not meant to be inherited, so protected members of this class should be ignored.

// Create subscription client
SubscriptionClient mySubscriptionClient = 
factory.CreateSubscriptionClient(topicName, subscriptionName);

// Create a receiver
MessageReceiver myMessageReceiver = mySubscriptionClient.CreateReceiver(ReceiveMode.PeekLock);

// Receive messages
for (int count = 0; count &lt; MsgCount; count++)
{
    var message = subscriptionClient.Receive();
    message.Complete();
}

Any public static (Shared in Visual Basic) members of this type are thread safe. Instance members are also guaranteed to be thread safe.

社区附加资源

添加
显示:
© 2014 Microsoft