エクスポート (0) 印刷
すべて展開
このトピックはまだ評価されていません - このトピックを評価する

SubscriptionClient クラス

トピックのサブスクリプションに関連するランタイム操作に使用されるアンカー クラスを表します。

System..::..Object
  Microsoft.ServiceBus.Messaging..::..MessageClientEntity
    Microsoft.ServiceBus.Messaging..::..SubscriptionClient

名前空間:  Microsoft.ServiceBus.Messaging
アセンブリ:  Microsoft.ServiceBus (Microsoft.ServiceBus.dll)
public abstract class SubscriptionClient : MessageClientEntity

SubscriptionClient 型は、以下のメンバーを公開しています。

  名前説明
パブリック プロパティIsClosedメッセージ クライアント エンティティが閉じられているかどうかを示す値を取得または設定します。 (MessageClientEntity から継承されています。)
パブリック プロパティMessagingFactoryこのサブスクリプション クライアントの作成に使用されるメッセージング ファクトリを取得します。
パブリック プロパティMode受信したメッセージを処理するときにメッセージ受信モードを取得します。
パブリック プロパティNameサブスクリプションの名前を取得します。
パブリック プロパティPrefetchCountメッセージ受信者が同時に要求できるメッセージの数を取得または設定します。
パブリック プロパティRetryPolicy要求を再試行するかどうかを決定するこのインスタンスに関連付けられている再試行ポリシーを取得または設定します。 (MessageClientEntity から継承されています。)
プロテクト プロパティThisLockMessageClientEntity インスタンスをロックするために使用されたオブジェクトを取得します。 (MessageClientEntity から継承されています。)
パブリック プロパティTopicPathトピックの完全なパス名を取得します。
先頭に戻る
  名前説明
パブリック メソッドAbandon(Guid)メッセージを破棄し、メッセージ ロックの所有権を解除します。
パブリック メソッドAbandon(Guid, IDictionary<(Of <<'(String, Object>)>>))メッセージを破棄し、メッセージ ロックの所有権を解除します。
パブリック メソッドAbandonAsync(Guid)非同期的にメッセージを破棄し、メッセージ ロックの所有権を解除します。
パブリック メソッドAbandonAsync(Guid, IDictionary<(Of <<'(String, Object>)>>))非同期的にメッセージを破棄し、メッセージ ロックの所有権を解除します。
パブリック メソッドAbortメッセージ クライアント エンティティを破棄し、その状態を終了状態に設定します。 (MessageClientEntity から継承されています。)
パブリック メソッドAcceptMessageSession()()()()1 回のトランザクションで処理する関連メッセージのグループ化を許可するメッセージ セッションを受け付けます。
パブリック メソッドAcceptMessageSession(String)特定のセッション ID を使用して、1 回のトランザクションで処理する関連メッセージのグループ化を許可するメッセージ セッションを受け付けます。
パブリック メソッドAcceptMessageSession(TimeSpan)指定されたサーバー待機時間を使用して、1 回のトランザクションで処理する関連メッセージのグループ化を許可するメッセージ セッションを受け付けます。
パブリック メソッドAcceptMessageSession(String, TimeSpan)特定のセッション ID および待機時間を使用して、1 回のトランザクションで処理する関連メッセージのグループ化を許可するメッセージ セッションを受け付けます。
パブリック メソッドAcceptMessageSessionAsync()()()()指定されたサーバー待機時間を使用して、1 回のトランザクションで処理する関連メッセージのグループ化を許可するメッセージ セッションを非同期的に受け付けます。
パブリック メソッドAcceptMessageSessionAsync(String)指定されたサーバー待機時間を使用して、1 回のトランザクションで処理する関連メッセージのグループ化を許可するメッセージ セッションを非同期的に受け付けます。
パブリック メソッドAcceptMessageSessionAsync(TimeSpan)指定されたサーバー待機時間を使用して、1 回のトランザクションで処理する関連メッセージのグループ化を許可するメッセージ セッションを非同期的に受け付けます。
パブリック メソッドAcceptMessageSessionAsync(String, TimeSpan)指定されたサーバー待機時間を使用して、1 回のトランザクションで処理する関連メッセージのグループ化を許可するメッセージ セッションを非同期的に受け付けます。
パブリック メソッド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非同期の規則の削除アクションを開始します。
パブリック メソッドCloseメッセージ クライアント エンティティを閉じ、その状態を終了状態に設定します。 (MessageClientEntity から継承されています。)
パブリック メソッドCloseAsync非同期的にメッセージ クライアント エンティティを閉じ、その状態を終了状態に設定します。 (MessageClientEntity から継承されています。)
パブリック メソッド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複数のメッセージを 1 回のトランザクションで処理するための、関連メッセージのグループ化を許可するメッセージ セッションを受け入れる非同期操作を完了します。
パブリック メソッドEndAddRule非同期の規則の追加操作を終了します。
パブリック メソッドEndCloseメッセージ クライアント エンティティを閉じる非同期操作を終了します。 (MessageClientEntity から継承されています。)
パブリック メソッドEndCompleteメッセージの処理を完了する非同期操作を完了します。
パブリック メソッドEndCompleteBatchバッチの処理を完了する非同期操作を完了します。
パブリック メソッドEndDeadLetterメッセージを配信不能キューに移動する非同期操作を完了します。
パブリック メソッドEndDeferメッセージの処理を中断する非同期操作を完了します。
パブリック メソッドEndGetMessageSessionsメッセージの処理を取得する非同期操作を完了します。
パブリック メソッドEndPeek非同期的なピーク操作を終了します。
パブリック メソッドEndPeekBatchメッセージのバッチに対する非同期的ピーク操作を終了します。
パブリック メソッドEndReceiveメッセージを受信する非同期操作を完了します。
パブリック メソッドEndReceiveBatchバッチを受信する非同期操作を完了します。
パブリック メソッドEndRemoveRule非同期の規則の削除操作を終了します。
パブリック メソッドEquals (Object から継承されています。)
プロテクト メソッドFaultメッセージ クライアント エンティティをエラー状態に設定します。 (MessageClientEntity から継承されています。)
プロテクト メソッドFinalize (Object から継承されています。)
パブリック メソッド静的メンバーFormatDeadLetterPath指定されたトピック パスおよびサブスクリプション名を使用して、形式名の配信不能パスを作成します。
パブリック メソッド静的メンバーFormatSubscriptionPath指定されたトピック パスおよびサブスクリプション名を使用して、形式名のサブスクリプション パスを作成します。
パブリック メソッドGetHashCode (Object から継承されています。)
パブリック メソッドGetMessageSessions()()()()1 回のトランザクションで処理する関連メッセージのグループ化を許可するメッセージ セッションを取得します。
パブリック メソッドGetMessageSessions(DateTime)lastUpdatedTime 以降にセッション状態が更新されたすべてのメッセージ セッションを取得します。
パブリック メソッドGetMessageSessionsAsync()()()()1 回のトランザクションで処理する関連メッセージのグループ化を許可するメッセージ セッションを非同期的に取得します。
パブリック メソッドGetMessageSessionsAsync(DateTime)1 回のトランザクションで処理する関連メッセージのグループ化を許可するメッセージ セッションを非同期的に取得します。
パブリック メソッドGetType (Object から継承されています。)
プロテクト メソッドMemberwiseClone (Object から継承されています。)
プロテクト メソッドOnAbort破棄アクションを実行します。 (MessageClientEntity..::..OnAbort()()()() をオーバーライドします。)
プロテクト メソッドOnBeginAcceptMessageSessionBeginAcceptMessageSession 操作の呼び出しと同時に実行されます。
プロテクト メソッドOnBeginAddRuleBeginAddRule 操作を呼び出したときに実行されます。
プロテクト メソッドOnBeginClose閉じることの開始アクションを実行します。 (MessageClientEntity..::..OnBeginClose(TimeSpan, AsyncCallback, Object) をオーバーライドします。)
プロテクト メソッドOnBeginCreateReceiver(ReceiveMode, TimeSpan, AsyncCallback, Object)受信者の作成開始アクションを実行します。
プロテクト メソッドOnBeginCreateReceiver(String, String, ReceiveMode, TimeSpan, AsyncCallback, Object)受信者の作成開始アクションを実行します。
プロテクト メソッドOnBeginGetMessageSessionsBeginGetMessageSessions 操作を呼び出したときに実行されます。
プロテクト メソッドOnBeginOpenメッセージ クライアント エンティティを開くことを開始する操作を呼び出したときに実行されます。 (MessageClientEntity から継承されています。)
プロテクト メソッドOnBeginRemoveRuleランタイム クライアント プロトコルを通じて Subscription から Rule の削除を開始します。
プロテクト メソッドOnBeginRemoveRulesByTagタグを使用して、ランタイム クライアント プロトコルを通じて Subscription から Rule の削除を開始します。
プロテクト メソッドOnClose閉じるアクションを実行します。 (MessageClientEntity..::..OnClose(TimeSpan) をオーバーライドします。)
プロテクト メソッドOnClosedメッセージ クライアント エンティティが終了状態に移行したときに発生します。 (MessageClientEntity から継承されています。)
プロテクト メソッドOnEndAcceptMessageSessionEndAcceptMessageSession 操作の呼び出しと同時に実行されます。
プロテクト メソッドOnEndAddRuleOnBeginAddRule の非同期呼び出しを終了します。
プロテクト メソッドOnEndClose閉じることの終了アクションを実行します。 (MessageClientEntity..::..OnEndClose(IAsyncResult) をオーバーライドします。)
プロテクト メソッドOnEndCreateReceiver受信者の作成終了アクションを実行します。
プロテクト メソッドOnEndGetMessageSessionsメッセージ取得終了アクションを実行します。
プロテクト メソッドOnEndOpenメッセージ クライアント エンティティを開くことを終了する操作を呼び出したときに実行されます。 (MessageClientEntity から継承されています。)
プロテクト メソッドOnEndRemoveRuleOnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object) の非同期呼び出しを終了します。
プロテクト メソッドOnEndRemoveRulesOnBeginRemoveRule(String, TimeSpan, AsyncCallback, Object) の非同期呼び出しを終了します。
プロテクト メソッドOnFaultedFault 操作を呼び出したときに実行されます。 (MessageClientEntity から継承されています。)
パブリック メソッドOnMessage(Action<(Of <<'(BrokeredMessage>)>>))イベント駆動型メッセージ ポンプ内のメッセージを処理します。
パブリック メソッドOnMessage(Action<(Of <<'(BrokeredMessage>)>>), OnMessageOptions)指定された OnMessageOptions オプションのセットを使用して、イベント駆動型メッセージ ポンプ内のメッセージを処理します。
パブリック メソッドOnMessageAsync(Func<(Of <<'(BrokeredMessage, Task>)>>))メッセージを非同期的に処理します。
パブリック メソッドOnMessageAsync(Func<(Of <<'(BrokeredMessage, Task>)>>), OnMessageOptions)メッセージを非同期的に処理します。
プロテクト メソッドOnOpenメッセージ クライアント エンティティを開く操作を呼び出したときに実行されます。 (MessageClientEntity から継承されています。)
プロテクト メソッドOnOpenedメッセージ クライアント エンティティが開かれたときに実行されます。 (MessageClientEntity から継承されています。)
プロテクト メソッドOnRuntimeDescriptionChangedランタイムの説明が変更された時にイベントを発行します。 (MessageClientEntity から継承されています。)
パブリック メソッド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)メッセージのセットを非同期的に受信します (バッチ処理のため)。
パブリック メソッドRemoveRuleruleName で示される規則を削除します。
パブリック メソッドRemoveRuleAsyncruleName で示される規則を非同期的に削除します。
プロテクト メソッドThrowIfClosedメッセージ クライアント エンティティが閉じられた場合に例外をスローします。 (MessageClientEntity から継承されています。)
プロテクト メソッドThrowIfDisposedメッセージ クライアント エンティティが破棄された場合に例外をスローします。 (MessageClientEntity から継承されています。)
プロテクト メソッドThrowIfDisposedOrImmutableクライアントが破棄されたか不変の場合に例外をスローします。 (MessageClientEntity から継承されています。)
プロテクト メソッドThrowIfDisposedOrNotOpenクライアントが破棄されたか開いていない場合に例外をスローします。 (MessageClientEntity から継承されています。)
プロテクト メソッドThrowIfFaultedクライアントにエラーが発生した場合に例外をスローします。 (MessageClientEntity から継承されています。)
パブリック メソッド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.

この情報は役に立ちましたか。
(残り 1500 文字)
フィードバックをいただき、ありがとうございました

コミュニティの追加

追加
表示:
© 2014 Microsoft. All rights reserved.