ServiceBusSessionReceiver interface

Pakket:

@azure/service-bus

Een ontvanger die sessies verwerkt, waaronder het vernieuwen van de sessievergrendeling.

Uitbreiding

ServiceBusReceiver

Eigenschappen

sessionId	De sessie-id.
sessionLockedUntilUtc	De tijd in UTC totdat de sessie is vergrendeld. Telkens wanneer renewSessionLock() 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 wordt de vergrendeling van de sessie verlengd.
setSessionState(any, OperationOptionsBase)	Hiermee stelt u de status van de sessie in. Zie sessiestatus voor meer informatie over sessiestatussen
subscribe(MessageHandlers, SubscribeOptions)	Hiermee worden berichten naar berichtenhandlers gestreamd.

Overgenomen methoden

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	De vergrendeling van het bericht door de ontvanger wordt losgelaten, waardoor het bericht opnieuw beschikbaar wordt gemaakt in Service Bus voor een andere ontvangstbewerking.
close()	Sluit de ontvanger. Zodra de ontvanger is gesloten, kan deze niet meer worden gebruikt voor verdere bewerkingen. Gebruik de methode createReceiver() 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 deadletter. Als u een deadletted bericht wilt ontvangen, maakt u een nieuwe QueueClient/SubscriptionClient met behulp van het pad voor de subwachtrij deadletter.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Hiermee wordt de verwerking van het bericht uitgesteld. Sla de sequenceNumber van het bericht op om het bericht later opnieuw te ontvangen met behulp van de methode receiveDeferredMessage.
getMessageIterator(GetMessageIteratorOptions)	Retourneert een iterator die kan worden gebruikt voor het ontvangen van berichten van Service Bus.
peekMessages(number, PeekMessagesOptions)	Bekijk de volgende batch actieve berichten (inclusief uitgestelde maar niet dode berichten) in de wachtrij of het abonnement zonder deze te wijzigen. De eerste aanroep om peekMessages() het eerste actieve bericht ophaalt. Bij elke volgende aanroep wordt het volgende bericht opgehaald. In tegenstelling tot een bericht 'ontvangen' is het bericht een alleen-lezen versie van het bericht. Het kan niet worden Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Retourneert een belofte die wordt omgezet in een matrix met uitgestelde berichten die zijn geïdentificeerd door gegeven sequenceNumbers.
receiveMessages(number, ReceiveMessagesOptions)	Retourneert een belofte die wordt omgezet in een matrix met 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 eigenschap lockedUntilUtc op het bericht voor het tijdstip waarop de vergrendeling verloopt. Als een bericht niet is geregeld (met behulp van complete(), defer() of deadletter(), voordat de vergrendeling verloopt, komt het bericht terug in de wachtrij/het abonnement 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. Telkens wanneer renewSessionLock() 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

Optiestas om een afgebroken signaal of traceringsopties door te geven.

Retouren

Promise<any>

De status van die sessie

renewSessionLock(OperationOptionsBase)

Hiermee wordt de vergrendeling van de sessie verlengd.

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

Optiestas om een afgebroken signaal of traceringsopties door te geven.

Retouren

Promise<void>

subscribe(MessageHandlers, SubscribeOptions)

Hiermee worden berichten naar berichtenhandlers gestreamd.

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, alle resterende berichten verzenden naar handlers en het stoppen van nieuwe berichten die binnenkomen.

Details overgenomen methode

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

De vergrendeling van het bericht door de ontvanger wordt losgelaten, waardoor het bericht opnieuw beschikbaar wordt gemaakt 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 die moeten worden gewijzigd tijdens het afbreken van het bericht.

Retouren

Promise<void>

overgenomen vanServiceBusReceiver.abandonMessage

close()

Sluit de ontvanger. Zodra de ontvanger is gesloten, kan deze niet meer worden gebruikt voor verdere bewerkingen. Gebruik de methode createReceiver() 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 deadletter. Als u een deadletted bericht wilt ontvangen, maakt u een nieuwe QueueClient/SubscriptionClient met behulp van het pad voor de subwachtrij deadletter.

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})

Hiermee wordt de verwerking van het bericht uitgesteld. Sla de sequenceNumber van het bericht op om het bericht later opnieuw te ontvangen met behulp van de methode receiveDeferredMessage.

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 die moeten worden gewijzigd tijdens het uitstellen van het bericht

Retouren

Promise<void>

overgenomen vanServiceBusReceiver.deferMessage-

getMessageIterator(GetMessageIteratorOptions)

Retourneert een iterator die kan worden gebruikt voor het ontvangen van berichten van Service Bus.

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 dode berichten) in de wachtrij of het abonnement zonder deze te wijzigen.

• De eerste aanroep om peekMessages() het eerste actieve bericht ophaalt. Bij elke volgende aanroep wordt het volgende bericht opgehaald.
• In tegenstelling tot een bericht 'ontvangen' is het bericht een alleen-lezen versie van het bericht. Het kan niet worden Completed/Abandoned/Deferred/Deadlettered.

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

Parameters

maxMessageCount

number

Het maximum aantal berichten dat u wilt bekijken.

options

PeekMessagesOptions

Opties waarmee u het maximum aantal berichten kunt opgeven dat moet worden weergegeven, de sequenceNumber om te beginnen met het bekijken van een aortSignal 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 zijn geïdentificeerd door gegeven sequenceNumbers.

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

Parameters

sequenceNumbers

Long | Long[]

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

options

OperationOptionsBase

Optiestas om een afgebroken signaal of traceringsopties door te geven.

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 met berichten die zijn ontvangen van Service Bus.

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

Parameters

maxMessageCount

number

Het maximum aantal te ontvangen berichten.

options

ReceiveMessagesOptions

Een set opties voor het beheren van de ontvangstbewerking.

• maxWaitTimeInMs: de maximale tijd die moet worden gewacht 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 omgezet 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 eigenschap lockedUntilUtc op het bericht voor het tijdstip waarop de vergrendeling verloopt.
• Als een bericht niet is geregeld (met behulp van complete(), defer() of deadletter(), voordat de vergrendeling verloopt, komt het bericht terug in de wachtrij/het abonnement voor de volgende ontvangstbewerking.

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

Parameters

message

ServiceBusReceivedMessage

Retouren

Promise<Date>

Nieuwe vervaldatum en -tijd voor vergrendelingstoken in UTC-indeling.

overgenomen vanServiceBusReceiver.renewMessageLock-