Udostępnij za pośrednictwem

ServiceBusSender interface

  • Odwołanie
Pakiet:
@azure/service-bus

Nadawca może służyć do wysyłania komunikatów, planowania wysyłania komunikatów w późniejszym czasie i anulowania takich zaplanowanych komunikatów. createSender Użyj funkcji w obiekcie ServiceBusClient, aby utworzyć wystąpienie elementu Sender. Klasa Sender to abstrakcja podstawowego linku nadawcy AMQP.

Właściwości

entityPath

Ścieżka jednostki, dla której utworzono nadawcę.
identifier

Nazwa używana do identyfikowania nadawcy. Może to służyć do korelowania dzienników i wyjątków. Jeśli nie zostanie określony lub pusty, zostanie wygenerowany losowy unikatowy.
isClosed

Zwraca wartość true , jeśli nadawca lub klient, który go utworzył, został zamknięty.

Metody

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

Anuluje wiele komunikatów, które zostały zaplanowane do wyświetlenia w kolejce/subskrypcji usługi ServiceBus.
close()

Zamyka podstawowy link nadawcy AMQP. Po zamknięciu nadawca nie może być używany do dalszych operacji. createSender Użyj funkcji w obiekcie QueueClient lub TopicClient, aby utworzyć wystąpienie nowego nadawcy
createMessageBatch(CreateMessageBatchOptions)

Tworzy wystąpienie ServiceBusMessageBatch , do którego można dodać komunikaty do momentu osiągnięcia maksymalnego obsługiwanego rozmiaru. Partię <xref:send> można przekazać do metody w celu wysłania komunikatów do Azure Service Bus.
scheduleMessages(ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], Date, OperationOptionsBase)

Harmonogramy wyświetlania komunikatów w kolejce/subskrypcji usługi Service Bus w późniejszym czasie.
sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)

Wysyła podane komunikaty po utworzeniu linku nadawcy AMQP, jeśli jeszcze nie istnieje.

  • Aby wysyłać komunikaty do kolejki/tematu i/lub partition z włączoną obsługąsession, ustaw sessionId odpowiednio właściwości i/lub partitionKey na komunikatach.
  • Wszystkie komunikaty przekazane do tego samego wywołania sendMessages() powinny mieć to samo sessionId (jeśli używasz sesji) i takie same partitionKey (jeśli używasz partycji).

Uwaga:

Jeśli chcesz wysyłać komunikaty o rozmiarze większym niż 1 MB, wyślij poszczególne komunikaty zamiast wysyłać wsadowe komunikaty lub tablicę komunikatów, takich jak poniżej.

await sender.sendMessages(message);

Dzieje się tak, ponieważ komunikaty wsadowe nie mogą jeszcze wysyłać większych komunikatów. W takim przypadku wystąpi force detached błąd. Przeczytaj service-bus-premium-messaging#large-messages-support. Więcej informacji znajduje się pod adresem #23014.

Szczegóły właściwości

entityPath

Ścieżka jednostki, dla której utworzono nadawcę.

entityPath: string

Wartość właściwości

string

identifier

Nazwa używana do identyfikowania nadawcy. Może to służyć do korelowania dzienników i wyjątków. Jeśli nie zostanie określony lub pusty, zostanie wygenerowany losowy unikatowy.

identifier: string

Wartość właściwości

string

isClosed

Zwraca wartość true , jeśli nadawca lub klient, który go utworzył, został zamknięty.

isClosed: boolean

Wartość właściwości

boolean

Szczegóły metody

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

Anuluje wiele komunikatów, które zostały zaplanowane do wyświetlenia w kolejce/subskrypcji usługi ServiceBus.

function cancelScheduledMessages(sequenceNumbers: Long | Long[], options?: OperationOptionsBase): Promise<void>

Parametry

sequenceNumbers

Long | Long[]

Numer sekwencji lub tablica numerów sekwencji komunikatów do anulowania.

options
OperationOptionsBase

Opcje torbę do przekazania przerwania sygnału lub opcji śledzenia.

Zwraca

Promise<void>

close()

Zamyka podstawowy link nadawcy AMQP. Po zamknięciu nadawca nie może być używany do dalszych operacji. createSender Użyj funkcji w obiekcie QueueClient lub TopicClient, aby utworzyć wystąpienie nowego nadawcy

function close(): Promise<void>

Zwraca

Promise<void>

createMessageBatch(CreateMessageBatchOptions)

Tworzy wystąpienie ServiceBusMessageBatch , do którego można dodać komunikaty do momentu osiągnięcia maksymalnego obsługiwanego rozmiaru. Partię <xref:send> można przekazać do metody w celu wysłania komunikatów do Azure Service Bus.

function createMessageBatch(options?: CreateMessageBatchOptions): Promise<ServiceBusMessageBatch>

Parametry

options
CreateMessageBatchOptions

Konfiguruje zachowanie partii.

  • maxSizeInBytes: górny limit rozmiaru partii. Funkcja zostanie zwrócona tryAddfalse po osiągnięciu tego limitu.

Zwraca

Promise<ServiceBusMessageBatch>

scheduleMessages(ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], Date, OperationOptionsBase)

Harmonogramy wyświetlania komunikatów w kolejce/subskrypcji usługi Service Bus w późniejszym czasie.

function scheduleMessages(messages: ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], scheduledEnqueueTimeUtc: Date, options?: OperationOptionsBase): Promise<Long[]>

Parametry

messages

ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

Komunikat lub tablica komunikatów, które należy zaplanować.

scheduledEnqueueTimeUtc

Date

Czas UTC, o którym komunikaty powinny być w kolejce.

options
OperationOptionsBase

Opcje torbę do przekazania przerwania sygnału lub opcji śledzenia.

Zwraca

Promise<Long[]>

Numery sekwencji komunikatów, które zostały zaplanowane. Jeśli zamierzasz anulować planowanie komunikatów, będzie potrzebny numer sekwencji. Long Zapisz typ , który znajduje się w aplikacji bez konwertowania na liczbę. Ponieważ język JavaScript obsługuje tylko 53-bitowe liczby, konwersja wartości Long na liczbę spowoduje utratę dokładności.

sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)

Wysyła podane komunikaty po utworzeniu linku nadawcy AMQP, jeśli jeszcze nie istnieje.

  • Aby wysyłać komunikaty do kolejki/tematu i/lub partition z włączoną obsługąsession, ustaw sessionId odpowiednio właściwości i/lub partitionKey na komunikatach.
  • Wszystkie komunikaty przekazane do tego samego wywołania sendMessages() powinny mieć to samo sessionId (jeśli używasz sesji) i takie same partitionKey (jeśli używasz partycji).

Uwaga:

Jeśli chcesz wysyłać komunikaty o rozmiarze większym niż 1 MB, wyślij poszczególne komunikaty zamiast wysyłać wsadowe komunikaty lub tablicę komunikatów, takich jak poniżej.

await sender.sendMessages(message);

Dzieje się tak, ponieważ komunikaty wsadowe nie mogą jeszcze wysyłać większych komunikatów. W takim przypadku wystąpi force detached błąd. Przeczytaj service-bus-premium-messaging#large-messages-support. Więcej informacji znajduje się pod adresem #23014.

function sendMessages(messages: ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], options?: OperationOptionsBase): Promise<void>

Parametry

messages

ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

Pojedynczy komunikat lub tablica komunikatów lub partia komunikatów utworzonych za pośrednictwem metody createBatch() do wysłania.

options
OperationOptionsBase

Opcje torbę do przekazania przerwania sygnału lub opcji śledzenia.

Zwraca

Promise<void>