ServiceBusSessionReceiver interface

Paket:

@azure/service-bus

En mottagare som hanterar sessioner, inklusive förnyelse av sessionslåset.

Extends

ServiceBusReceiver

Egenskaper

sessionId	Sessions-ID: t.
sessionLockedUntilUtc	Tiden i UTC tills sessionen är låst. Varje gång renewSessionLock() anropas uppdateras den här gången till aktuell tid plus låsets varaktighet enligt vad som angavs när kön/prenumerationen skapades. Returnerar odefinierat tills en AMQP-mottagarlänk har konfigurerats för sessionen.

Ärvda egenskaper

entityPath	Sökvägen till entiteten som mottagaren har skapats för.
identifier	Ett namn som används för att identifiera mottagaren. Detta kan användas för att korrelera loggar och undantag. Om det inte anges eller är tomt genereras ett slumpmässigt unikt objekt.
isClosed	Returnerar true om mottagaren eller klienten som skapade den har stängts.
receiveMode	Mottagningsläget som används för att skapa mottagaren.

Metoder

getSessionState(OperationOptionsBase)	Hämtar tillståndet för sessionen. Mer information om sessionstillstånd finns i Sessionstillstånd
renewSessionLock(OperationOptionsBase)	Förnyar låset för sessionen.
setSessionState(any, OperationOptionsBase)	Anger tillståndet för sessionen. Mer information om sessionstillstånd finns i Sessionstillstånd
subscribe(MessageHandlers, SubscribeOptions)	Strömmar meddelanden till meddelandehanterare.

Ärvda metoder

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Låset som finns på meddelandet av mottagaren släpps, vilket gör meddelandet tillgängligt igen i Service Bus för en annan mottagningsåtgärd.
close()	Stänger mottagaren. När mottagaren har stängts kan den inte användas för ytterligare åtgärder. createReceiver() Använd metoden på ServiceBusClient för att skapa en ny mottagare.
completeMessage(ServiceBusReceivedMessage)	Tar bort meddelandet från Service Bus.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	Flyttar meddelandet till underkön deadletter. Om du vill ta emot ett deadletted-meddelande skapar du en ny QueueClient/SubscriptionClient med hjälp av sökvägen för underkön deadletter.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Defers bearbetningen av meddelandet. sequenceNumber Spara meddelandet för att få meddelandet igen i framtiden med hjälp av receiveDeferredMessage metoden .
getMessageIterator(GetMessageIteratorOptions)	Returnerar en iterator som kan användas för att ta emot meddelanden från Service Bus.
peekMessages(number, PeekMessagesOptions)	Granska nästa batch med aktiva meddelanden (inklusive uppskjutna men inte deadlettered-meddelanden) i kön eller prenumerationen utan att ändra dem. Det första anropet till peekMessages() hämtar det första aktiva meddelandet. Varje efterföljande anrop hämtar det efterföljande meddelandet. Till skillnad från ett "mottaget" meddelande är "peeked"-meddelandet en skrivskyddad version av meddelandet. Det kan inte vara Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Returnerar ett löfte som matchar en matris med uppskjutna meddelanden som identifieras av angiven sequenceNumbers.
receiveMessages(number, ReceiveMessagesOptions)	Returnerar ett löfte som matchar en matris med meddelanden som tas emot från Service Bus.
renewMessageLock(ServiceBusReceivedMessage)	Förnyar låset på meddelandet under den tid som anges när kön/prenumerationen skapas. lockedUntilUtc Kontrollera egenskapen för meddelandet för den tid då låset upphör att gälla. Om ett meddelande inte har lösts (med antingen complete(), defer() eller deadletter(), innan låset upphör att gälla, hamnar meddelandet tillbaka i kön/prenumerationen för nästa mottagningsåtgärd.

Egenskapsinformation

sessionId

Sessions-ID: t.

sessionId: string

Egenskapsvärde

string

sessionLockedUntilUtc

Tiden i UTC tills sessionen är låst. Varje gång renewSessionLock() anropas uppdateras den här gången till aktuell tid plus låsets varaktighet enligt vad som angavs när kön/prenumerationen skapades.

Returnerar odefinierat tills en AMQP-mottagarlänk har konfigurerats för sessionen.

sessionLockedUntilUtc: Date

Egenskapsvärde

Date

Information om ärvda egenskaper

entityPath

Sökvägen till entiteten som mottagaren har skapats för.

entityPath: string

Egenskapsvärde

string

Ärvd frånServiceBusReceiver.entityPath

identifier

Ett namn som används för att identifiera mottagaren. Detta kan användas för att korrelera loggar och undantag. Om det inte anges eller är tomt genereras ett slumpmässigt unikt objekt.

identifier: string

Egenskapsvärde

string

Ärvd frånServiceBusReceiver.identifier

isClosed

Returnerar true om mottagaren eller klienten som skapade den har stängts.

isClosed: boolean

Egenskapsvärde

boolean

Ärvd frånServiceBusReceiver.isClosed

receiveMode

Mottagningsläget som används för att skapa mottagaren.

receiveMode: "peekLock" | "receiveAndDelete"

Egenskapsvärde

"peekLock" | "receiveAndDelete"

Ärvd frånServiceBusReceiver.receiveMode

Metodinformation

getSessionState(OperationOptionsBase)

Hämtar tillståndet för sessionen. Mer information om sessionstillstånd finns i Sessionstillstånd

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

Parametrar

options

OperationOptionsBase

Alternativ påse för att skicka en avbruten signal eller spårningsalternativ.

Returer

Promise<any>

Tillståndet för sessionen

renewSessionLock(OperationOptionsBase)

Förnyar låset för sessionen.

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

Parametrar

options

OperationOptionsBase

Returer

Promise<Date>

setSessionState(any, OperationOptionsBase)

Anger tillståndet för sessionen. Mer information om sessionstillstånd finns i Sessionstillstånd

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

Parametrar

state

any

Det tillstånd som måste anges.

options

OperationOptionsBase

Alternativ påse för att skicka en avbruten signal eller spårningsalternativ.

Returer

Promise<void>

subscribe(MessageHandlers, SubscribeOptions)

Strömmar meddelanden till meddelandehanterare.

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

Parametrar

handlers

MessageHandlers

En hanterare som anropas för meddelanden och fel.

options

SubscribeOptions

Alternativ för prenumeration.

Returer

{ close() => Promise<void> }

Ett objekt som kan stängas, skicka eventuella återstående meddelanden till handlers och stoppa nya meddelanden från att komma in.

Ärvd metodinformation

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

Låset som finns på meddelandet av mottagaren släpps, vilket gör meddelandet tillgängligt igen i Service Bus för en annan mottagningsåtgärd.

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

Parametrar

message

ServiceBusReceivedMessage

propertiesToModify

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

Egenskaperna för meddelandet som ska ändras när meddelandet överges.

Returer

Promise<void>

Ärvd frånServiceBusReceiver.abandonMessage

close()

Stänger mottagaren. När mottagaren har stängts kan den inte användas för ytterligare åtgärder. createReceiver() Använd metoden på ServiceBusClient för att skapa en ny mottagare.

function close(): Promise<void>

Returer

Promise<void>

Ärvd frånServiceBusReceiver.close

completeMessage(ServiceBusReceivedMessage)

Tar bort meddelandet från Service Bus.

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

Parametrar

message

ServiceBusReceivedMessage

Returer

Promise<void>

Ärvd frånServiceBusReceiver.completeMessage

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

Flyttar meddelandet till underkön deadletter. Om du vill ta emot ett deadletted-meddelande skapar du en ny QueueClient/SubscriptionClient med hjälp av sökvägen för underkön deadletter.

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

Parametrar

message

ServiceBusReceivedMessage

options

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

DeadLetter-alternativen som kan anges när meddelandet avvisas.

Returer

Promise<void>

Ärvd frånServiceBusReceiver.deadLetterMessage

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

Defers bearbetningen av meddelandet. sequenceNumber Spara meddelandet för att få meddelandet igen i framtiden med hjälp av receiveDeferredMessage metoden .

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

Parametrar

message

ServiceBusReceivedMessage

propertiesToModify

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

Egenskaperna för meddelandet som ska ändras när meddelandet skjuts upp

Returer

Promise<void>

Ärvd frånServiceBusReceiver.deferMessage

getMessageIterator(GetMessageIteratorOptions)

Returnerar en iterator som kan användas för att ta emot meddelanden från Service Bus.

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

Parametrar

options

GetMessageIteratorOptions

En uppsättning alternativ för att styra mottagningsåtgärden.

• abortSignal: Signalen som ska användas för att avbryta den pågående åtgärden.

Returer

AsyncIterableIterator<ServiceBusReceivedMessage>

Ärvd frånServiceBusReceiver.getMessageIterator

peekMessages(number, PeekMessagesOptions)

Granska nästa batch med aktiva meddelanden (inklusive uppskjutna men inte deadlettered-meddelanden) i kön eller prenumerationen utan att ändra dem.

• Det första anropet till peekMessages() hämtar det första aktiva meddelandet. Varje efterföljande anrop hämtar det efterföljande meddelandet.
• Till skillnad från ett "mottaget" meddelande är "peeked"-meddelandet en skrivskyddad version av meddelandet. Det kan inte vara Completed/Abandoned/Deferred/Deadlettered.

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

Parametrar

maxMessageCount

number

Det maximala antalet meddelanden som ska visas.

options

PeekMessagesOptions

Alternativ som gör det möjligt att ange det maximala antalet meddelanden att granska, sekvensnumber för att börja titta från eller en abortSignal för att avbryta åtgärden.

Returer

Promise<ServiceBusReceivedMessage[]>

Ärvd frånServiceBusReceiver.peekMessages

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Returnerar ett löfte som matchar en matris med uppskjutna meddelanden som identifieras av angiven sequenceNumbers.

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

Parametrar

sequenceNumbers

Long | Long[]

Sekvensnumret eller en matris med sekvensnummer för de meddelanden som behöver tas emot.

options

OperationOptionsBase

Alternativ påse för att skicka en avbruten signal eller spårningsalternativ.

Returer

Promise<ServiceBusReceivedMessage[]>

En lista över meddelanden som identifieras av den angivna sekvensenNumbers eller en tom lista om inga meddelanden hittas.

Ärvd frånServiceBusReceiver.receiveDeferredMessages

receiveMessages(number, ReceiveMessagesOptions)

Returnerar ett löfte som matchar en matris med meddelanden som tas emot från Service Bus.

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

Parametrar

maxMessageCount

number

Maximalt antal meddelanden att ta emot.

options

ReceiveMessagesOptions

En uppsättning alternativ för att styra mottagningsåtgärden.

• maxWaitTimeInMs: Den maximala tiden att vänta på det första meddelandet innan du returnerar en tom matris om inga meddelanden är tillgängliga.
• abortSignal: Signalen som ska användas för att avbryta den pågående åtgärden.

Returer

Promise<ServiceBusReceivedMessage[]>

Ett löfte som matchar med en matris med meddelanden.

Ärvd frånServiceBusReceiver.receiveMessages

renewMessageLock(ServiceBusReceivedMessage)

Förnyar låset på meddelandet under den tid som anges när kön/prenumerationen skapas.

• lockedUntilUtc Kontrollera egenskapen för meddelandet för den tid då låset upphör att gälla.
• Om ett meddelande inte har lösts (med antingen complete(), defer() eller deadletter(), innan låset upphör att gälla, hamnar meddelandet tillbaka i kön/prenumerationen för nästa mottagningsåtgärd.

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

Parametrar

message

ServiceBusReceivedMessage

Returer

Promise<Date>

Nytt utgångsdatum och tid för låstoken i UTC-format.

Ärvd frånServiceBusReceiver.renewMessageLock