ServiceBusSenderAsyncClient クラス
- java.
lang. Object - com.
azure. messaging. servicebus. ServiceBusSenderAsyncClient
- com.
実装
public final class ServiceBusSenderAsyncClient
implements AutoCloseable
Service Bus リソースにメッセージを送信する 非同期 クライアント。
このドキュメントに示す例では、認証に DefaultAzureCredential という名前の資格情報オブジェクトを使用します。これは、ローカルの開発環境や運用環境を含むほとんどのシナリオに適しています。 さらに、運用環境での認証に マネージド ID を 使用することをお勧めします。 認証のさまざまな方法とそれに対応する資格情報の種類の詳細については、 Azure ID のドキュメントを参照してください。
サンプル: 送信者のインスタンスを作成する
TokenCredential credential = new DefaultAzureCredentialBuilder().build();
// 'fullyQualifiedNamespace' will look similar to "{your-namespace}.servicebus.windows.net"
ServiceBusSenderAsyncClient asyncSender = new ServiceBusClientBuilder()
.credential(fullyQualifiedNamespace, credential)
.sender()
.queueName(queueName)
.buildAsyncClient();
// When users are done with the sender, they should dispose of it.
// Clients should be long-lived objects as they require resources
// and time to establish a connection to the service.
asyncSender.close();
サンプル: Service Bus リソースにメッセージを送信する
// `subscribe` is a non-blocking call. The program will move onto the next line of code when it starts the
// operation. Users should use the callbacks on `subscribe` to understand the status of the send operation.
asyncSender.createMessageBatch().flatMap(batch -> {
batch.tryAddMessage(new ServiceBusMessage("test-1"));
batch.tryAddMessage(new ServiceBusMessage("test-2"));
return asyncSender.sendMessages(batch);
}).subscribe(unused -> {
}, error -> {
System.err.println("Error occurred while sending batch:" + error);
}, () -> {
System.out.println("Send complete.");
});
サンプル: Service Bus リソースに制限 ServiceBusMessageBatch されたサイズを使用してメッセージを送信する
Flux<ServiceBusMessage> telemetryMessages = Flux.just(firstMessage, secondMessage);
// Setting `setMaximumSizeInBytes` when creating a batch, limits the size of that batch.
// In this case, all the batches created with these options are limited to 256 bytes.
CreateMessageBatchOptions options = new CreateMessageBatchOptions()
.setMaximumSizeInBytes(256);
AtomicReference<ServiceBusMessageBatch> currentBatch = new AtomicReference<>();
// Sends the current batch if it is not null and not empty. If the current batch is null, sets it.
// Returns the batch to work with.
Mono<ServiceBusMessageBatch> sendBatchAndGetCurrentBatchOperation = Mono.defer(() -> {
ServiceBusMessageBatch batch = currentBatch.get();
if (batch == null) {
return asyncSender.createMessageBatch(options);
}
if (batch.getCount() > 0) {
return asyncSender.sendMessages(batch).then(
asyncSender.createMessageBatch(options)
.handle((ServiceBusMessageBatch newBatch, SynchronousSink<ServiceBusMessageBatch> sink) -> {
// Expect that the batch we just sent is the current one. If it is not, there's a race
// condition accessing currentBatch reference.
if (!currentBatch.compareAndSet(batch, newBatch)) {
sink.error(new IllegalStateException(
"Expected that the object in currentBatch was batch. But it is not."));
} else {
sink.next(newBatch);
}
}));
} else {
return Mono.just(batch);
}
});
// The sample Flux contains two messages, but it could be an infinite stream of telemetry messages.
Flux<Void> sendMessagesOperation = telemetryMessages.flatMap(message -> {
return sendBatchAndGetCurrentBatchOperation.flatMap(batch -> {
if (batch.tryAddMessage(message)) {
return Mono.empty();
} else {
return sendBatchAndGetCurrentBatchOperation
.handle((ServiceBusMessageBatch newBatch, SynchronousSink<Void> sink) -> {
if (!newBatch.tryAddMessage(message)) {
sink.error(new IllegalArgumentException(
"Message is too large to fit in an empty batch."));
} else {
sink.complete();
}
});
}
});
});
// `subscribe` is a non-blocking call. The program will move onto the next line of code when it starts the
// operation. Users should use the callbacks on `subscribe` to understand the status of the send operation.
Disposable disposable = sendMessagesOperation.then(sendBatchAndGetCurrentBatchOperation)
.subscribe(batch -> {
System.out.println("Last batch should be empty: " + batch.getCount());
}, error -> {
System.err.println("Error sending telemetry messages: " + error);
}, () -> {
System.out.println("Completed.");
// Continue using the sender and finally, dispose of the sender.
// Clients should be long-lived objects as they require resources
// and time to establish a connection to the service.
asyncSender.close();
});
サンプル: セッションが有効なキューへのメッセージの送信
次のスニペットは、 Service Bus セッション が有効なキューにメッセージを送信する方法を示しています。 プロパティを "greetings" に設定 setMessageId(String messageId) すると、ID が "greetings" の Service Bus セッションにメッセージが送信されます。
// 'fullyQualifiedNamespace' will look similar to "{your-namespace}.servicebus.windows.net"
ServiceBusSenderAsyncClient sender = new ServiceBusClientBuilder()
.credential(fullyQualifiedNamespace, new DefaultAzureCredentialBuilder().build())
.sender()
.queueName(sessionEnabledQueueName)
.buildAsyncClient();
// Setting sessionId publishes that message to a specific session, in this case, "greeting".
ServiceBusMessage message = new ServiceBusMessage("Hello world")
.setSessionId("greetings");
// `subscribe` is a non-blocking call. The program will move onto the next line of code when it starts the
// operation. Users should use the callbacks on `subscribe` to understand the status of the send operation.
sender.sendMessage(message).subscribe(unused -> {
}, error -> {
System.err.println("Error occurred publishing batch: " + error);
}, () -> {
System.out.println("Send complete.");
});
// Continue using the sender and finally, dispose of the sender.
// Clients should be long-lived objects as they require resources
// and time to establish a connection to the service.
sender.close();
メソッドの概要
メソッドの継承元: java.lang.Object
メソッドの詳細
cancelScheduledMessage
public Mono
スケジュールされたメッセージのエンキューを取り消します (まだエンキューされていない場合)。
Parameters:
Returns:
cancelScheduledMessages
public Mono
既にスケジュールされているメッセージのエンキューを取り消します (まだエンキューされていない場合)。
Parameters:
Returns:
close
public void close()
を破棄します ServiceBusSenderAsyncClient。 クライアントに専用接続がある場合は、基になる接続も閉じられます。
commitTransaction
public Mono
指定 ServiceBusTransactionContextされたトランザクションをコミットします。 これにより、Service Bus が呼び出されます。
Parameters:
Returns:
createMessageBatch
public Mono
トランスポートで ServiceBusMessageBatch 許容される数のメッセージに収まる を作成します。
Returns:
createMessageBatch
public Mono
指定したオプションで ServiceBusMessageBatch 構成された を作成します。
Parameters:
Returns:
createTransaction
public Mono
Service Bus で新しいトランザクションを開始します。 は ServiceBusTransactionContext 、このトランザクションに含める必要があるすべての操作と ServiceBusReceivedMessage 共に渡す必要があります。
Returns:
getEntityPath
public String getEntityPath()
Service Bus リソースの名前を取得します。
Returns:
getFullyQualifiedNamespace
public String getFullyQualifiedNamespace()
完全修飾名前空間を取得します。
Returns:
getIdentifier
public String getIdentifier()
のインスタンス ServiceBusSenderAsyncClientの識別子を取得します。
Returns:
rollbackTransaction
public Mono
指定 ServiceBusTransactionContextされたトランザクションをロールバックします。 これにより、Service Bus が呼び出されます。
Parameters:
Returns:
scheduleMessage
public Mono
この送信者が接続しているAzure Service Bus エンティティにスケジュールされたメッセージを送信します。 スケジュールされたメッセージがエンキューされ、スケジュールされたエンキュー時刻にのみ受信者が使用できるようになります。
Parameters:
Returns:
scheduleMessage
public Mono
この送信者が接続しているAzure Service Bus エンティティにスケジュールされたメッセージを送信します。 スケジュールされたメッセージがエンキューされ、スケジュールされたエンキュー時刻にのみ受信者が使用できるようになります。
Parameters:
Returns:
scheduleMessages
public Flux
スケジュールされたメッセージのバッチを、この送信者が接続しているAzure Service Bus エンティティに送信します。 スケジュールされたメッセージがエンキューされ、スケジュールされたエンキュー時刻にのみ受信者が使用できるようになります。
Parameters:
Returns:
scheduleMessages
public Flux
この送信者が接続しているAzure Service Busエンティティにスケジュールされたメッセージを送信します。 スケジュールされたメッセージがエンキューされ、スケジュールされたエンキュー時刻にのみ受信者が使用できるようになります。
Parameters:
Returns:
sendMessage
public Mono
Service Bus キューまたはトピックにメッセージを送信します。
Parameters:
Returns:
sendMessage
public Mono
Service Bus キューまたはトピックにメッセージを送信します。
Parameters:
Returns:
sendMessages
public Mono
送信者が接続しているAzure Service Bus エンティティにメッセージ バッチを送信します。
Parameters:
Returns:
sendMessages
public Mono
送信者が接続しているAzure Service Bus エンティティにメッセージ バッチを送信します。
Parameters:
Returns:
sendMessages
public Mono
バッチ処理されたアプローチを使用して、一連のメッセージを Service Bus キューまたはトピックに送信します。 メッセージのサイズが 1 つのバッチの最大サイズを超えると、例外がトリガーされ、送信は失敗します。 既定では、メッセージ サイズはリンクで許可される最大量です。
Parameters:
Returns:
sendMessages
public Mono
バッチ処理されたアプローチを使用して、一連のメッセージを Service Bus キューまたはトピックに送信します。 メッセージのサイズが 1 つのバッチの最大サイズを超えると、例外がトリガーされ、送信は失敗します。 既定では、メッセージ サイズはリンクで許可される最大量です。
Parameters:
Returns:
適用対象
Azure SDK for Java
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示