ServiceBusSessionReceiver interface

Pakket:

@azure/service-bus

Een ontvanger die sessies afhandelt, inclusief het vernieuwen van de sessievergrendeling.

Uitbreiding

ServiceBusReceiver

Eigenschappen

sessionId	De sessie-id.
sessionLockedUntilUtc	De tijd in UTC totdat de sessie is vergrendeld. Elke keer renewSessionLock() dat wordt aangeroepen, wordt deze tijd bijgewerkt naar de huidige tijd plus de vergrendelingsduur zoals opgegeven tijdens het maken van de wachtrij/het abonnement. Retourneert niet-gedefinieerd totdat een AMQP-ontvangerkoppeling is ingesteld voor de sessie.

Overgenomen eigenschappen

entityPath	Pad van de entiteit waarvoor de ontvanger is gemaakt.
identifier	Een naam die wordt gebruikt om de ontvanger te identificeren. Dit kan worden gebruikt om logboeken en uitzonderingen te correleren. Als dit niet is opgegeven of leeg is, wordt er een willekeurige unieke gegenereerd.
isClosed	Retourneert true als de ontvanger of de client die deze heeft gemaakt, is gesloten.
receiveMode	De ontvangstmodus die wordt gebruikt om de ontvanger te maken.

Methoden

getSessionState(OperationOptionsBase)	Hiermee haalt u de status van de sessie op. Zie Sessiestatus voor meer informatie over sessiestatussen
renewSessionLock(OperationOptionsBase)	Hiermee vernieuwt u de vergrendeling van de sessie.
setSessionState(any, OperationOptionsBase)	Hiermee stelt u de status van de sessie in. Zie Sessiestatus voor meer informatie over sessiestatussen
subscribe(MessageHandlers, SubscribeOptions)	Streamt berichten naar berichtenhandlers.

Overgenomen methoden

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	De vergrendeling die door de ontvanger op het bericht is vastgehouden, wordt losgelaten, waardoor het bericht weer beschikbaar is in Service Bus voor een andere ontvangstbewerking.
close()	Sluit de ontvanger. Eenmaal gesloten, kan de ontvanger niet meer worden gebruikt voor verdere bewerkingen. Gebruik de createReceiver() methode op de ServiceBusClient om een nieuwe ontvanger te maken.
completeMessage(ServiceBusReceivedMessage)	Hiermee verwijdert u het bericht uit Service Bus.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	Hiermee verplaatst u het bericht naar de subwachtrij voor onbestelbare berichten. Als u een vastgelopen bericht wilt ontvangen, maakt u een nieuwe QueueClient/SubscriptionClient met behulp van het pad voor de subwachtrij voor deadletters.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	De verwerking van het bericht wordt uitstellen. Sla de sequenceNumber van het bericht op om het bericht in de toekomst opnieuw te ontvangen met behulp van de receiveDeferredMessage -methode.
getMessageIterator(GetMessageIteratorOptions)	Retourneert een iterator die kan worden gebruikt om berichten van Service Bus te ontvangen.
peekMessages(number, PeekMessagesOptions)	Bekijk de volgende batch actieve berichten (inclusief uitgestelde maar niet-vastgelopen berichten) in de wachtrij of het abonnement zonder deze te wijzigen. Met de eerste aanroep wordt peekMessages() het eerste actieve bericht opgehaald. Bij elke volgende aanroep wordt het volgende bericht opgehaald. In tegenstelling tot een 'ontvangen' bericht is een 'gekeken' bericht een alleen-lezen versie van het bericht. Dit kan niet zijn Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Retourneert een belofte die wordt omgezet in een matrix met uitgestelde berichten die worden geïdentificeerd door opgegeven sequenceNumbers.
receiveMessages(number, ReceiveMessagesOptions)	Retourneert een belofte die wordt omgezet in een matrix van berichten die zijn ontvangen van Service Bus.
renewMessageLock(ServiceBusReceivedMessage)	Hiermee wordt de vergrendeling van het bericht verlengd voor de duur die is opgegeven tijdens het maken van de wachtrij/het abonnement. Controleer de lockedUntilUtc eigenschap in het bericht voor het tijdstip waarop de vergrendeling verloopt. Als een bericht niet is opgelost (met behulp van complete(), defer() of deadletter(), voordat de vergrendeling verloopt, komt het bericht weer in de wachtrij/het abonnement terecht voor de volgende ontvangstbewerking.

Eigenschapdetails

sessionId

De sessie-id.

sessionId: string

Waarde van eigenschap

string

sessionLockedUntilUtc

De tijd in UTC totdat de sessie is vergrendeld. Elke keer renewSessionLock() dat wordt aangeroepen, wordt deze tijd bijgewerkt naar de huidige tijd plus de vergrendelingsduur zoals opgegeven tijdens het maken van de wachtrij/het abonnement.

Retourneert niet-gedefinieerd totdat een AMQP-ontvangerkoppeling is ingesteld voor de sessie.

sessionLockedUntilUtc: Date

Waarde van eigenschap

Date

Details van overgenomen eigenschap

entityPath

Pad van de entiteit waarvoor de ontvanger is gemaakt.

entityPath: string

Waarde van eigenschap

string

Overgenomen vanServiceBusReceiver.entityPath

identifier

Een naam die wordt gebruikt om de ontvanger te identificeren. Dit kan worden gebruikt om logboeken en uitzonderingen te correleren. Als dit niet is opgegeven of leeg is, wordt er een willekeurige unieke gegenereerd.

identifier: string

Waarde van eigenschap

string

Overgenomen vanServiceBusReceiver.identifier

isClosed

Retourneert true als de ontvanger of de client die deze heeft gemaakt, is gesloten.

isClosed: boolean

Waarde van eigenschap

boolean

Overgenomen vanServiceBusReceiver.isClosed

receiveMode

De ontvangstmodus die wordt gebruikt om de ontvanger te maken.

receiveMode: "peekLock" | "receiveAndDelete"

Waarde van eigenschap

"peekLock" | "receiveAndDelete"

Overgenomen vanServiceBusReceiver.receiveMode

Methodedetails

getSessionState(OperationOptionsBase)

Hiermee haalt u de status van de sessie op. Zie Sessiestatus voor meer informatie over sessiestatussen

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

Parameters

options

OperationOptionsBase

Opties voor het doorgeven van een afbreeksignaal of traceringsopties.

Retouren

Promise<any>

De status van die sessie

renewSessionLock(OperationOptionsBase)

Hiermee vernieuwt u de vergrendeling van de sessie.

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

Parameters

options

OperationOptionsBase

Retouren

Promise<Date>

setSessionState(any, OperationOptionsBase)

Hiermee stelt u de status van de sessie in. Zie Sessiestatus voor meer informatie over sessiestatussen

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

Parameters

state

any

De status die moet worden ingesteld.

options

OperationOptionsBase

Opties voor het doorgeven van een afbreeksignaal of traceringsopties.

Retouren

Promise<void>

subscribe(MessageHandlers, SubscribeOptions)

Streamt berichten naar berichtenhandlers.

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

Parameters

handlers

MessageHandlers

Een handler die wordt aangeroepen voor berichten en fouten.

options

SubscribeOptions

Opties voor abonneren.

Retouren

{ close() => Promise<void> }

Een object dat kan worden gesloten, eventuele resterende berichten verzendt naar handlers en voorkomt dat nieuwe berichten binnenkomen.

Details overgenomen methode

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

De vergrendeling die door de ontvanger op het bericht is vastgehouden, wordt losgelaten, waardoor het bericht weer beschikbaar is in Service Bus voor een andere ontvangstbewerking.

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

Parameters

message

ServiceBusReceivedMessage

propertiesToModify

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

De eigenschappen van het bericht dat moet worden gewijzigd tijdens het verlaten van het bericht.

Retouren

Promise<void>

Overgenomen vanServiceBusReceiver.abandonMessage

close()

Sluit de ontvanger. Eenmaal gesloten, kan de ontvanger niet meer worden gebruikt voor verdere bewerkingen. Gebruik de createReceiver() methode op de ServiceBusClient om een nieuwe ontvanger te maken.

function close(): Promise<void>

Retouren

Promise<void>

Overgenomen vanServiceBusReceiver.close

completeMessage(ServiceBusReceivedMessage)

Hiermee verwijdert u het bericht uit Service Bus.

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

Parameters

message

ServiceBusReceivedMessage

Retouren

Promise<void>

Overgenomen vanServiceBusReceiver.completeMessage

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

Hiermee verplaatst u het bericht naar de subwachtrij voor onbestelbare berichten. Als u een vastgelopen bericht wilt ontvangen, maakt u een nieuwe QueueClient/SubscriptionClient met behulp van het pad voor de subwachtrij voor deadletters.

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

Parameters

message

ServiceBusReceivedMessage

options

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

De DeadLetter-opties die kunnen worden opgegeven tijdens het weigeren van het bericht.

Retouren

Promise<void>

Overgenomen vanServiceBusReceiver.deadLetterMessage

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

De verwerking van het bericht wordt uitstellen. Sla de sequenceNumber van het bericht op om het bericht in de toekomst opnieuw te ontvangen met behulp van de receiveDeferredMessage -methode.

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

Parameters

message

ServiceBusReceivedMessage

propertiesToModify

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

De eigenschappen van het bericht dat moet worden gewijzigd tijdens het uitstellen van het bericht

Retouren

Promise<void>

Overgenomen vanServiceBusReceiver.deferMessage

getMessageIterator(GetMessageIteratorOptions)

Retourneert een iterator die kan worden gebruikt om berichten van Service Bus te ontvangen.

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

Parameters

options

GetMessageIteratorOptions

Een set opties voor het beheren van de ontvangstbewerking.

• abortSignal: Het signaal dat moet worden gebruikt om de lopende bewerking af te breken.

Retouren

AsyncIterableIterator<ServiceBusReceivedMessage>

Overgenomen vanServiceBusReceiver.getMessageIterator

peekMessages(number, PeekMessagesOptions)

Bekijk de volgende batch actieve berichten (inclusief uitgestelde maar niet-vastgelopen berichten) in de wachtrij of het abonnement zonder deze te wijzigen.

• Met de eerste aanroep wordt peekMessages() het eerste actieve bericht opgehaald. Bij elke volgende aanroep wordt het volgende bericht opgehaald.
• In tegenstelling tot een 'ontvangen' bericht is een 'gekeken' bericht een alleen-lezen versie van het bericht. Dit kan niet zijn Completed/Abandoned/Deferred/Deadlettered.

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

Parameters

maxMessageCount

number

Het maximum aantal berichten om te bekijken.

options

PeekMessagesOptions

Opties voor het opgeven van het maximum aantal berichten om te bekijken, het sequenceNumber om te beginnen met gluren of een abortSignal om de bewerking af te breken.

Retouren

Promise<ServiceBusReceivedMessage[]>

Overgenomen vanServiceBusReceiver.peekMessages

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Retourneert een belofte die wordt omgezet in een matrix met uitgestelde berichten die worden geïdentificeerd door opgegeven sequenceNumbers.

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

Parameters

sequenceNumbers

Long | Long[]

Het volgnummer of een matrix met volgnummers voor de berichten die moeten worden ontvangen.

options

OperationOptionsBase

Opties voor het doorgeven van een afbreeksignaal of traceringsopties.

Retouren

Promise<ServiceBusReceivedMessage[]>

Een lijst met berichten die worden geïdentificeerd door de opgegeven sequenceNumbers of een lege lijst als er geen berichten worden gevonden.

Overgenomen vanServiceBusReceiver.receiveDeferredMessages

receiveMessages(number, ReceiveMessagesOptions)

Retourneert een belofte die wordt omgezet in een matrix van berichten die zijn ontvangen van Service Bus.

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

Parameters

maxMessageCount

number

Het maximum aantal berichten dat moet worden ontvangen.

options

ReceiveMessagesOptions

Een set opties voor het beheren van de ontvangstbewerking.

• maxWaitTimeInMs: De maximale tijd om te wachten op het eerste bericht voordat een lege matrix wordt geretourneerd als er geen berichten beschikbaar zijn.
• abortSignal: het signaal dat moet worden gebruikt om de lopende bewerking af te breken.

Retouren

Promise<ServiceBusReceivedMessage[]>

Een belofte die wordt opgelost met een matrix met berichten.

Overgenomen vanServiceBusReceiver.receiveMessages

renewMessageLock(ServiceBusReceivedMessage)

Hiermee wordt de vergrendeling van het bericht verlengd voor de duur die is opgegeven tijdens het maken van de wachtrij/het abonnement.

• Controleer de lockedUntilUtc eigenschap in het bericht voor het tijdstip waarop de vergrendeling verloopt.
• Als een bericht niet is opgelost (met behulp van complete(), defer() of deadletter(), voordat de vergrendeling verloopt, komt het bericht weer in de wachtrij/het abonnement terecht voor de volgende ontvangstbewerking.

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

Parameters

message

ServiceBusReceivedMessage

Retouren

Promise<Date>

Nieuwe verloopdatum en -tijd van het vergrendelingstoken in UTC-indeling.

Overgenomen vanServiceBusReceiver.renewMessageLock