ServiceBusSessionReceiver interface

Pakiet:

@azure/service-bus

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

Rozszerzenie

ServiceBusReceiver

Właściwości

sessionId	Identyfikator sesji.
sessionLockedUntilUtc	Czas w formacie UTC, do którego sesja jest zablokowana. Za każdym razem, gdy renewSessionLock() jest wywoływana, tym razem jest aktualizowany 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 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 odbiorcę zostaje wypuszczana, 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. Użyj metody createReceiver() 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 utracony, utwórz nową kolejkę QueueClient/SubscriptionClient przy użyciu ścieżki dla kolejki podrzędnej deadletter.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Odchyli przetwarzanie komunikatu. Zapisz sequenceNumber komunikatu, aby ponownie odebrać komunikat w przyszłości przy użyciu metody receiveDeferredMessage.
getMessageIterator(GetMessageIteratorOptions)	Zwraca iterator, który może służyć do odbierania komunikatów z usługi Service Bus.
peekMessages(number, PeekMessagesOptions)	Zajrzyj do następnej partii aktywnych komunikatów (w tym odroczonych, ale nie utraconych komunikatów) w kolejce lub subskrypcji bez ich modyfikowania. Pierwsze wywołanie peekMessages() pobiera pierwszą aktywną wiadomość. Każde kolejne wywołanie pobiera kolejną wiadomość. W przeciwieństwie do komunikatu "odebranego" komunikat "zaglądany" jest wersją komunikatu tylko do odczytu. Nie można go Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Zwraca obietnicę, która rozwiązuje tablicę odroczonych komunikatów zidentyfikowanych przez daną sequenceNumbers.
receiveMessages(number, ReceiveMessagesOptions)	Zwraca obietnicę, która rozpoznaje tablicę komunikatów odebranych z usługi Service Bus.
renewMessageLock(ServiceBusReceivedMessage)	Odnawia blokadę komunikatu przez czas trwania określony podczas tworzenia kolejki/subskrypcji. Sprawdź właściwość lockedUntilUtc w komunikacie o czasie wygaśnięcia blokady. Jeśli komunikat nie zostanie rozstrzygnięty (przy użyciu complete(), defer() lub deadletter(), przed wygaśnięciem blokady, komunikat zostanie ponownie wyświetlony 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, gdy renewSessionLock() jest wywoływana, tym razem jest aktualizowany 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 zServiceBusReceiver.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 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 zServiceBusReceiver.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 opcji przekazywania opcji sygnału przerwania 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 opcji przekazywania opcji sygnału przerwania 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 dla komunikatów i błędów.

options

SubscribeOptions

Opcje subskrypcji.

Zwraca

{ close() => Promise<void> }

Obiekt, który można zamknąć, wysyłając wszystkie 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 odbiorcę zostaje wypuszczana, 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 zmodyfikowania 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. Użyj metody createReceiver() 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 utracony, utwórz nową kolejkę 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})

Odchyli przetwarzanie komunikatu. Zapisz sequenceNumber komunikatu, aby ponownie odebrać komunikat w przyszłości przy użyciu metody receiveDeferredMessage.

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 zmodyfikowania 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 kontrolowania operacji odbierania.

• abortSignal: sygnał do przerwania trwającej operacji.

Zwraca

AsyncIterableIterator<ServiceBusReceivedMessage>

dziedziczone zServiceBusReceiver.getMessageIterator

peekMessages(number, PeekMessagesOptions)

Zajrzyj do następnej partii aktywnych komunikatów (w tym odroczonych, ale nie utraconych komunikatów) w kolejce lub subskrypcji bez ich modyfikowania.

• Pierwsze wywołanie peekMessages() pobiera pierwszą aktywną wiadomość. Każde kolejne wywołanie pobiera kolejną wiadomość.
• W przeciwieństwie do komunikatu "odebranego" komunikat "zaglądany" jest wersją komunikatu tylko do odczytu. Nie można go Completed/Abandoned/Deferred/Deadlettered.

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

Parametry

maxMessageCount

number

Maksymalna liczba komunikatów do zajrzeć.

options

PeekMessagesOptions

Opcje, które umożliwiają określenie maksymalnej liczby komunikatów do zajrzeć, sekwencjiNumber, aby rozpocząć podgląd z lub przerwaćSignal, aby przerwać operację.

Zwraca

Promise<ServiceBusReceivedMessage[]>

dziedziczone zServiceBusReceiver.peekMessages

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Zwraca obietnicę, która rozwiązuje tablicę odroczonych komunikatów zidentyfikowanych przez daną sequenceNumbers.

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 opcji przekazywania opcji sygnału przerwania 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 kontrolowania operacji odbierania.

• maxWaitTimeInMs: maksymalny czas oczekiwania na pierwszy komunikat przed zwróceniem pustej tablicy, jeśli nie są dostępne żadne komunikaty.
• abortSignal: sygnał 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 trwania określony podczas tworzenia kolejki/subskrypcji.

• Sprawdź właściwość lockedUntilUtc w komunikacie o czasie wygaśnięcia blokady.
• Jeśli komunikat nie zostanie rozstrzygnięty (przy użyciu complete(), defer() lub deadletter(), przed wygaśnięciem blokady, komunikat zostanie ponownie wyświetlony 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