ServiceBusSessionReceiver interface

Pakiet:

@azure/service-bus

Odbiornik obsługujący sesje, w tym odnawianie blokady sesji.

Extends

ServiceBusReceiver

Właściwości

sessionId	Identyfikator sesji.
sessionLockedUntilUtc	Czas w formacie UTC, do którego sesja jest zablokowana. Za każdym razem renewSessionLock() jest wywoływany czas aktualizacji do bieżącego czasu oraz czas trwania blokady określony podczas tworzenia kolejki/subskrypcji. Zostanie zwrócony niezdefiniowany do momentu pomyślnego skonfigurowania linku odbiornika AMQP dla sesji.

Właściwości dziedziczone

entityPath	Ścieżka jednostki, dla której utworzono odbiornik.
identifier	Nazwa używana do identyfikowania odbiorcy. 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 odbiornik lub klient, który go utworzył, został zamknięty.
receiveMode	Tryb odbierania używany do tworzenia odbiornika.

Metody

getSessionState(OperationOptionsBase)	Pobiera stan sesji. Aby uzyskać więcej informacji na temat stanów sesji, zobacz Stan sesji
renewSessionLock(OperationOptionsBase)	Odnawia blokadę w sesji.
setSessionState(any, OperationOptionsBase)	Ustawia stan sesji. Aby uzyskać więcej informacji na temat stanów sesji, zobacz Stan sesji
subscribe(MessageHandlers, SubscribeOptions)	Przesyła strumieniowo komunikaty do programów obsługi komunikatów.

Metody dziedziczone

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Blokada przechowywana w komunikacie przez odbiornik jest odpuszczana, co powoduje ponowne udostępnienie komunikatu w usłudze Service Bus dla innej operacji odbierania.
close()	Zamyka odbiornik. Po zamknięciu odbiornik nie może być używany do dalszych operacji. createReceiver() Użyj metody w obiekcie ServiceBusClient, aby utworzyć nowy odbiornik.
completeMessage(ServiceBusReceivedMessage)	Usuwa komunikat z usługi Service Bus.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	Przenosi komunikat do kolejki podrzędnej deadletter. Aby odebrać komunikat zakleszczony, utwórz nowy element QueueClient/SubscriptionClient przy użyciu ścieżki dla kolejki podrzędnej deadletter.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Wyzywając przetwarzanie komunikatu. sequenceNumber Zapisz komunikat w celu ponownego odebrania komunikatu w przyszłości przy użyciu receiveDeferredMessage metody .
getMessageIterator(GetMessageIteratorOptions)	Zwraca iterator, który może służyć do odbierania komunikatów z usługi Service Bus.
peekMessages(number, PeekMessagesOptions)	Zobacz następną partię aktywnych komunikatów (w tym odroczone, ale nie martwe komunikaty) w kolejce lub subskrypcji bez ich modyfikowania. Pierwsze wywołanie do peekMessages() pobrania pierwszej aktywnej wiadomości. Każde kolejne wywołanie pobiera kolejną wiadomość. W przeciwieństwie do komunikatu "odebrane" komunikat "zajrzyj" do odczytu jest wersją komunikatu tylko do odczytu. Nie może to być Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Zwraca obietnicę, która rozpoznaje tablicę komunikatów odroczonych zidentyfikowanych przez daną sequenceNumberswartość .
receiveMessages(number, ReceiveMessagesOptions)	Zwraca obietnicę, która rozpoznaje tablicę komunikatów odebranych z usługi Service Bus.
renewMessageLock(ServiceBusReceivedMessage)	Odnawia blokadę komunikatu przez czas określony podczas tworzenia kolejki/subskrypcji. lockedUntilUtc Sprawdź właściwość w komunikacie o czasie wygaśnięcia blokady. Jeśli komunikat nie zostanie rozstrzygnięty (przy użyciu polecenia complete()lub defer() , przed deadletter()wygaśnięciem blokady, komunikat zostanie zwrócony w kolejce/subskrypcji dla następnej operacji odbierania.

Szczegóły właściwości

sessionId

Identyfikator sesji.

sessionId: string

Wartość właściwości

string

sessionLockedUntilUtc

Czas w formacie UTC, do którego sesja jest zablokowana. Za każdym razem renewSessionLock() jest wywoływany czas aktualizacji do bieżącego czasu oraz czas trwania blokady określony podczas tworzenia kolejki/subskrypcji.

Zostanie zwrócony niezdefiniowany do momentu pomyślnego skonfigurowania linku odbiornika AMQP dla sesji.

sessionLockedUntilUtc: Date

Wartość właściwości

Date

Szczegóły właściwości dziedziczonej

entityPath

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

entityPath: string

Wartość właściwości

string

Dziedziczone zklasy ServiceBusReceiver.entityPath

identifier

Nazwa używana do identyfikowania odbiorcy. 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

Dziedziczone zserviceBusReceiver.identifier

isClosed

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

isClosed: boolean

Wartość właściwości

boolean

Dziedziczone zserviceBusReceiver.isClosed

receiveMode

Tryb odbierania używany do tworzenia odbiornika.

receiveMode: "peekLock" | "receiveAndDelete"

Wartość właściwości

"peekLock" | "receiveAndDelete"

Dziedziczone zelementu ServiceBusReceiver.receiveMode

Szczegóły metody

getSessionState(OperationOptionsBase)

Pobiera stan sesji. Aby uzyskać więcej informacji na temat stanów sesji, zobacz Stan sesji

function getSessionState(options?: OperationOptionsBase): Promise<any>

Parametry

options

OperationOptionsBase

Torba opcje przekazywania opcji przerwania sygnału lub opcji śledzenia.

Zwraca

Promise<any>

Stan tej sesji

renewSessionLock(OperationOptionsBase)

Odnawia blokadę w sesji.

function renewSessionLock(options?: OperationOptionsBase): Promise<Date>

Parametry

options

OperationOptionsBase

Zwraca

Promise<Date>

setSessionState(any, OperationOptionsBase)

Ustawia stan sesji. Aby uzyskać więcej informacji na temat stanów sesji, zobacz Stan sesji

function setSessionState(state: any, options?: OperationOptionsBase): Promise<void>

Parametry

state

any

Stan, który należy ustawić.

options

OperationOptionsBase

Torba opcje przekazywania opcji przerwania sygnału lub opcji śledzenia.

Zwraca

Promise<void>

subscribe(MessageHandlers, SubscribeOptions)

Przesyła strumieniowo komunikaty do programów obsługi komunikatów.

function subscribe(handlers: MessageHandlers, options?: SubscribeOptions): { close() => Promise<void> }

Parametry

handlers

MessageHandlers

Procedura obsługi, która jest wywoływana w przypadku komunikatów i błędów.

options

SubscribeOptions

Opcje subskrypcji.

Zwraca

{ close() => Promise<void> }

Obiekt, który można zamknąć, wysyłając wszelkie pozostałe komunikaty do handlers i zatrzymując nowe komunikaty przed przybyciem.

Szczegóły metody dziedziczonej

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})

Blokada przechowywana w komunikacie przez odbiornik jest odpuszczana, co powoduje ponowne udostępnienie komunikatu w usłudze Service Bus dla innej operacji odbierania.

function abandonMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

Parametry

message

ServiceBusReceivedMessage

propertiesToModify

{[key: string]: number | boolean | string | Date | null}

Właściwości komunikatu do modyfikacji podczas porzucania komunikatu.

Zwraca

Promise<void>

Dziedziczone zserviceBusReceiver.abandonMessage

close()

Zamyka odbiornik. Po zamknięciu odbiornik nie może być używany do dalszych operacji. createReceiver() Użyj metody w obiekcie ServiceBusClient, aby utworzyć nowy odbiornik.

function close(): Promise<void>

Zwraca

Promise<void>

Dziedziczone zserviceBusReceiver.close

completeMessage(ServiceBusReceivedMessage)

Usuwa komunikat z usługi Service Bus.

function completeMessage(message: ServiceBusReceivedMessage): Promise<void>

Parametry

message

ServiceBusReceivedMessage

Zwraca

Promise<void>

Dziedziczone zserviceBusReceiver.completeMessage

deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})

Przenosi komunikat do kolejki podrzędnej deadletter. Aby odebrać komunikat zakleszczony, utwórz nowy element QueueClient/SubscriptionClient przy użyciu ścieżki dla kolejki podrzędnej deadletter.

function deadLetterMessage(message: ServiceBusReceivedMessage, options?: DeadLetterOptions & {[key: string]: number | boolean | string | Date | null}): Promise<void>

Parametry

message

ServiceBusReceivedMessage

options

DeadLetterOptions & {[key: string]: number | boolean | string | Date | null}

Opcje DeadLetter, które można podać podczas odrzucania wiadomości.

Zwraca

Promise<void>

Dziedziczone zserviceBusReceiver.deadLetterMessage

deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})

Wyzywając przetwarzanie komunikatu. sequenceNumber Zapisz komunikat w celu ponownego odebrania komunikatu w przyszłości przy użyciu receiveDeferredMessage metody .

function deferMessage(message: ServiceBusReceivedMessage, propertiesToModify?: {[key: string]: number | boolean | string | Date | null}): Promise<void>

Parametry

message

ServiceBusReceivedMessage

propertiesToModify

{[key: string]: number | boolean | string | Date | null}

Właściwości komunikatu do modyfikacji podczas odroczenia komunikatu

Zwraca

Promise<void>

Dziedziczone zserviceBusReceiver.deferMessage

getMessageIterator(GetMessageIteratorOptions)

Zwraca iterator, który może służyć do odbierania komunikatów z usługi Service Bus.

function getMessageIterator(options?: GetMessageIteratorOptions): AsyncIterableIterator<ServiceBusReceivedMessage>

Parametry

options

GetMessageIteratorOptions

Zestaw opcji do sterowania operacją odbierania.

• abortSignal: Sygnał używany do przerwania trwającej operacji.

Zwraca

AsyncIterableIterator<ServiceBusReceivedMessage>

Dziedziczone zserviceBusReceiver.getMessageIterator

peekMessages(number, PeekMessagesOptions)

Zobacz następną partię aktywnych komunikatów (w tym odroczone, ale nie martwe komunikaty) w kolejce lub subskrypcji bez ich modyfikowania.

• Pierwsze wywołanie do peekMessages() pobrania pierwszej aktywnej wiadomości. Każde kolejne wywołanie pobiera kolejną wiadomość.
• W przeciwieństwie do komunikatu "odebrane" komunikat "zajrzyj" do odczytu jest wersją komunikatu tylko do odczytu. Nie może to być Completed/Abandoned/Deferred/Deadlettered.

function peekMessages(maxMessageCount: number, options?: PeekMessagesOptions): Promise<ServiceBusReceivedMessage[]>

Parametry

maxMessageCount

number

Maksymalna liczba komunikatów do wglądu.

options

PeekMessagesOptions

Opcje, które umożliwiają określenie maksymalnej liczby komunikatów do zaglądania, sekwencjiNumber do rozpoczęcia podglądu z lub przerwaniaSignal w celu przerwania operacji.

Zwraca

Promise<ServiceBusReceivedMessage[]>

Dziedziczone zserviceBusReceiver.peekMessages

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Zwraca obietnicę, która rozpoznaje tablicę komunikatów odroczonych zidentyfikowanych przez daną sequenceNumberswartość .

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

Parametry

sequenceNumbers

Long | Long[]

Numer sekwencji lub tablica numerów sekwencji dla komunikatów, które muszą zostać odebrane.

options

OperationOptionsBase

Torba opcje przekazywania opcji przerwania sygnału lub opcji śledzenia.

Zwraca

Promise<ServiceBusReceivedMessage[]>

Lista komunikatów zidentyfikowanych przez daną sekwencjęNumbers lub pustą listę, jeśli nie znaleziono żadnych komunikatów.

Dziedziczone zserviceBusReceiver.receiveDeferredMessages

receiveMessages(number, ReceiveMessagesOptions)

Zwraca obietnicę, która rozpoznaje tablicę komunikatów odebranych z usługi Service Bus.

function receiveMessages(maxMessageCount: number, options?: ReceiveMessagesOptions): Promise<ServiceBusReceivedMessage[]>

Parametry

maxMessageCount

number

Maksymalna liczba komunikatów do odebrania.

options

ReceiveMessagesOptions

Zestaw opcji do sterowania operacją odbierania.

• maxWaitTimeInMs: maksymalny czas oczekiwania na pierwszy komunikat przed zwróceniem pustej tablicy, jeśli nie są dostępne żadne komunikaty.
• abortSignal: Sygnał używany do przerwania trwającej operacji.

Zwraca

Promise<ServiceBusReceivedMessage[]>

Obietnica, która rozwiązuje się z tablicą komunikatów.

Dziedziczone zserviceBusReceiver.receiveMessages

renewMessageLock(ServiceBusReceivedMessage)

Odnawia blokadę komunikatu przez czas określony podczas tworzenia kolejki/subskrypcji.

• lockedUntilUtc Sprawdź właściwość w komunikacie o czasie wygaśnięcia blokady.
• Jeśli komunikat nie zostanie rozstrzygnięty (przy użyciu polecenia complete()lub defer() , przed deadletter()wygaśnięciem blokady, komunikat zostanie zwrócony w kolejce/subskrypcji dla następnej operacji odbierania.

function renewMessageLock(message: ServiceBusReceivedMessage): Promise<Date>

Parametry

message

ServiceBusReceivedMessage

Zwraca

Promise<Date>

Nowa data i godzina wygaśnięcia tokenu blokady w formacie UTC.

Dziedziczone zserviceBusReceiver.renewMessageLock