次の方法で共有


ServiceBusSender クラス

定義

特定の Service Bus エンティティ (キューまたはトピック) への送信 ServiceBusMessage を担当するクライアント。 セッション エンティティと非セッション エンティティの両方に使用できます。 これは、 を呼び出 CreateSender(String)すことによって構築されます。

public class ServiceBusSender : IAsyncDisposable
type ServiceBusSender = class
    interface IAsyncDisposable
Public Class ServiceBusSender
Implements IAsyncDisposable
継承
ServiceBusSender
実装

注釈

ServiceBusSenderは、アプリケーションの有効期間中、またはによって作成された がServiceBusClient破棄されるまで、キャッシュして使用しても安全です。 アプリケーションがメッセージを定期的または準定期的に発行する場合は、送信者をキャッシュすることをお勧めします。 送信側は、ネットワーク、CPU、メモリの効率的な使用を確保する責任があります。 アプリケーションのシャットダウン時に関連付けられている ServiceBusClient を呼び出DisposeAsync()すと、送信者が使用するネットワーク リソースやその他のアンマネージド オブジェクトが適切にクリーンアップされます。

コンストラクター

ServiceBusSender()

モック作成のために クラスの ServiceBusSender 新しいインスタンスを初期化します。

ServiceBusSender(ServiceBusClient, String)

派生型で使用するために、 ServiceBusSender クラスの新しいインスタンスを初期化します。

ServiceBusSender(ServiceBusClient, String, ServiceBusSenderOptions)

派生型で使用するために、 ServiceBusSender クラスの新しいインスタンスを初期化します。

プロパティ

EntityPath

送信者が接続されているエンティティのパス。送信者を含む Service Bus 名前空間に固有です。

FullyQualifiedNamespace

プロデューサーが関連付けられている完全修飾 Service Bus 名前空間。 これは と似ている {yournamespace}.servicebus.windows.net可能性があります。

Identifier

このクライアントを識別する ID を取得します。 これは、ログと例外を関連付けるために使用できます。

IsClosed

これが ServiceBusSender 閉じられているかどうかを示します。

メソッド

CancelScheduledMessageAsync(Int64, CancellationToken)

スケジュールされたメッセージを取り消します。

CancelScheduledMessagesAsync(IEnumerable<Int64>, CancellationToken)

スケジュールされたメッセージのセットを取り消します。

CloseAsync(CancellationToken)

によって使用されるリソースをクリーンするために必要なタスクを実行しますServiceBusSender

CreateMessageBatchAsync(CancellationToken)

を使用して追加できるサイズ制約バッチ ServiceBusMessageTryAddMessage(ServiceBusMessage)作成します。 メッセージがバッチの最大許容サイズを超える場合、バッチはメッセージの追加を許可せず、戻り値を使用してそのシナリオを通知します。

サイズ制約に違反するメッセージを追加できないため、キュー/トピックにメッセージを送信しようとしたときにバッチを発行しても例外はトリガーされません。

CreateMessageBatchAsync(CreateMessageBatchOptions, CancellationToken)

try ベースのパターンを使用して追加できるサイズ制約バッチ ServiceBusMessage を作成します。 メッセージがバッチの最大許容サイズを超える場合、バッチはメッセージの追加を許可せず、その戻り値を使用してそのシナリオを通知します。

サイズ制約に違反するメッセージを追加できないため、キュー/トピックにメッセージを送信しようとしたときにバッチを発行しても例外はトリガーされません。

DisposeAsync()

によって使用されるリソースをクリーンするために必要なタスクを実行しますServiceBusSender。 これは、 を呼び出すこと CloseAsync(CancellationToken)と同じです。

ScheduleMessageAsync(ServiceBusMessage, DateTimeOffset, CancellationToken)

後で Service Bus にメッセージを表示するようにスケジュールします。

ScheduleMessagesAsync(IEnumerable<ServiceBusMessage>, DateTimeOffset, CancellationToken)

後で Service Bus に表示される一連のメッセージをスケジュールします。

SendMessageAsync(ServiceBusMessage, CancellationToken)

Service Bus の関連付けられたエンティティにメッセージを送信します。

SendMessagesAsync(IEnumerable<ServiceBusMessage>, CancellationToken)

バッチ処理されたアプローチを使用して、関連付けられている Service Bus エンティティに一連のメッセージを送信します。 メッセージのサイズが 1 つのバッチの最大サイズを超えると、例外がトリガーされ、送信は失敗します。 送信されるメッセージがバッチに収まるようにするには、代わりに を使用 SendMessagesAsync(ServiceBusMessageBatch, CancellationToken) します。

SendMessagesAsync(ServiceBusMessageBatch, CancellationToken)

ServiceBusMessageBatchのセットServiceBusMessageを含む を、関連付けられた Service Bus エンティティに送信します。

適用対象