ServiceBusSessionReceiver interface

Pacchetto:

@azure/service-bus

Ricevitore che gestisce le sessioni, incluso il rinnovo del blocco della sessione.

Extends

ServiceBusReceiver

Proprietà

sessionId	ID sessione.
sessionLockedUntilUtc	Ora in formato UTC fino a quando la sessione è bloccata. Ogni volta che viene chiamato renewSessionLock(), questa volta viene aggiornata all'ora corrente più la durata del blocco come specificato durante la creazione della coda o della sottoscrizione. Restituisce un valore non definito fino a quando non è stato configurato correttamente un collegamento del ricevitore AMQP per la sessione.

Proprietà ereditate

entityPath	Percorso dell'entità per cui è stato creato il ricevitore.
identifier	Nome utilizzato per identificare il ricevitore. Può essere usato per correlare log ed eccezioni. Se non specificato o vuoto, verrà generato un valore univoco casuale.
isClosed	Restituisce true se il ricevitore o il client che lo ha creato è stato chiuso.
receiveMode	Modalità di ricezione utilizzata per creare il ricevitore.

Metodi

getSessionState(OperationOptionsBase)	Ottiene lo stato della sessione. Per altre informazioni sugli stati della sessione, vedere stato sessione
renewSessionLock(OperationOptionsBase)	Rinnova il blocco nella sessione.
setSessionState(any, OperationOptionsBase)	Imposta lo stato nella sessione. Per altre informazioni sugli stati della sessione, vedere stato sessione
subscribe(MessageHandlers, SubscribeOptions)	Trasmette i messaggi ai gestori di messaggi.

Metodi ereditati

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Il blocco mantenuto sul messaggio dal ricevitore viene lasciato andare, rendendo nuovamente disponibile il messaggio nel bus di servizio per un'altra operazione di ricezione.
close()	Chiude il ricevitore. Una volta chiuso, il ricevitore non può essere utilizzato per ulteriori operazioni. Usare il metodo createReceiver() in ServiceBusClient per creare un nuovo ricevitore.
completeMessage(ServiceBusReceivedMessage)	Rimuove il messaggio dal bus di servizio.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	Sposta il messaggio nella coda secondaria di deadletter. Per ricevere un messaggio di deadletted, creare un nuovo QueueClient/SubscriptionClient usando il percorso per la coda secondaria di deadletter.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Rinvia l'elaborazione del messaggio. Salvare il sequenceNumber del messaggio per ricevere nuovamente il messaggio in futuro usando il metodo receiveDeferredMessage.
getMessageIterator(GetMessageIteratorOptions)	Restituisce un iteratore che può essere utilizzato per ricevere messaggi dal bus di servizio.
peekMessages(number, PeekMessagesOptions)	Visualizzare il batch successivo di messaggi attivi (inclusi i messaggi posticipati ma non inattive) nella coda o nella sottoscrizione senza modificarli. La prima chiamata a peekMessages() recupera il primo messaggio attivo. Ogni chiamata successiva recupera il messaggio successivo. A differenza di un messaggio "ricevuto", il messaggio "visualizzato" è una versione di sola lettura del messaggio. Non può essere Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Restituisce una promessa che viene risolta in una matrice di messaggi posticipati identificati da sequenceNumbers.
receiveMessages(number, ReceiveMessagesOptions)	Restituisce una promessa che viene risolta in una matrice di messaggi ricevuti dal bus di servizio.
renewMessageLock(ServiceBusReceivedMessage)	Rinnova il blocco sul messaggio per la durata specificata durante la creazione della coda o della sottoscrizione. Controllare la proprietà lockedUntilUtc nel messaggio per l'ora di scadenza del blocco. Se un messaggio non viene risolto (usando complete(), defer() o deadletter(), prima della scadenza del blocco, il messaggio torna nella coda/sottoscrizione per l'operazione di ricezione successiva.

Dettagli proprietà

sessionId

ID sessione.

sessionId: string

Valore della proprietà

string

sessionLockedUntilUtc

Ora in formato UTC fino a quando la sessione è bloccata. Ogni volta che viene chiamato renewSessionLock(), questa volta viene aggiornata all'ora corrente più la durata del blocco come specificato durante la creazione della coda o della sottoscrizione.

Restituisce un valore non definito fino a quando non è stato configurato correttamente un collegamento del ricevitore AMQP per la sessione.

sessionLockedUntilUtc: Date

Valore della proprietà

Date

Dettagli proprietà ereditate

entityPath

Percorso dell'entità per cui è stato creato il ricevitore.

entityPath: string

Valore della proprietà

string

Ereditato daServiceBusReceiver.entityPath

identifier

Nome utilizzato per identificare il ricevitore. Può essere usato per correlare log ed eccezioni. Se non specificato o vuoto, verrà generato un valore univoco casuale.

identifier: string

Valore della proprietà

string

ereditato daServiceBusReceiver.identifier

isClosed

Restituisce true se il ricevitore o il client che lo ha creato è stato chiuso.

isClosed: boolean

Valore della proprietà

boolean

ereditato daServiceBusReceiver.isClosed

receiveMode

Modalità di ricezione utilizzata per creare il ricevitore.

receiveMode: "peekLock" | "receiveAndDelete"

Valore della proprietà

"peekLock" | "receiveAndDelete"

Ereditato daServiceBusReceiver.receiveMode

Dettagli metodo

getSessionState(OperationOptionsBase)

Ottiene lo stato della sessione. Per altre informazioni sugli stati della sessione, vedere stato sessione

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

Parametri

options

OperationOptionsBase

Contenitore opzioni per passare un segnale di interruzione o opzioni di traccia.

Restituisce

Promise<any>

Stato della sessione

renewSessionLock(OperationOptionsBase)

Rinnova il blocco nella sessione.

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

Parametri

options

OperationOptionsBase

Restituisce

Promise<Date>

setSessionState(any, OperationOptionsBase)

Imposta lo stato nella sessione. Per altre informazioni sugli stati della sessione, vedere stato sessione

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

Parametri

state

any

Stato che deve essere impostato.

options

OperationOptionsBase

Contenitore opzioni per passare un segnale di interruzione o opzioni di traccia.

Restituisce

Promise<void>

subscribe(MessageHandlers, SubscribeOptions)

Trasmette i messaggi ai gestori di messaggi.

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

Parametri

handlers

MessageHandlers

Gestore che viene chiamato per messaggi ed errori.

options

SubscribeOptions

Opzioni per la sottoscrizione.

Restituisce

{ close() => Promise<void> }

Oggetto che può essere chiuso, inviando eventuali messaggi rimanenti a handlers e interrompendo l'arrivo di nuovi messaggi.

Dettagli dei metodi ereditati

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

Il blocco mantenuto sul messaggio dal ricevitore viene lasciato andare, rendendo nuovamente disponibile il messaggio nel bus di servizio per un'altra operazione di ricezione.

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

Parametri

message

ServiceBusReceivedMessage

propertiesToModify

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

Proprietà del messaggio da modificare durante l'abbandono del messaggio.

Restituisce

Promise<void>

Ereditato daServiceBusReceiver.abandonMessage

close()

Chiude il ricevitore. Una volta chiuso, il ricevitore non può essere utilizzato per ulteriori operazioni. Usare il metodo createReceiver() in ServiceBusClient per creare un nuovo ricevitore.

function close(): Promise<void>

Restituisce

Promise<void>

ereditato daServiceBusReceiver.close

completeMessage(ServiceBusReceivedMessage)

Rimuove il messaggio dal bus di servizio.

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

Parametri

message

ServiceBusReceivedMessage

Restituisce

Promise<void>

Ereditato daServiceBusReceiver.completeMessage

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

Sposta il messaggio nella coda secondaria di deadletter. Per ricevere un messaggio di deadletted, creare un nuovo QueueClient/SubscriptionClient usando il percorso per la coda secondaria di deadletter.

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

Parametri

message

ServiceBusReceivedMessage

options

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

Opzioni DeadLetter che è possibile specificare durante il rifiuto del messaggio.

Restituisce

Promise<void>

Ereditato daServiceBusReceiver.deadLetterMessage

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

Rinvia l'elaborazione del messaggio. Salvare il sequenceNumber del messaggio per ricevere nuovamente il messaggio in futuro usando il metodo receiveDeferredMessage.

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

Parametri

message

ServiceBusReceivedMessage

propertiesToModify

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

Proprietà del messaggio da modificare durante il rinvio del messaggio

Restituisce

Promise<void>

Ereditato daServiceBusReceiver.deferMessage

getMessageIterator(GetMessageIteratorOptions)

Restituisce un iteratore che può essere utilizzato per ricevere messaggi dal bus di servizio.

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

Parametri

options

GetMessageIteratorOptions

Set di opzioni per controllare l'operazione di ricezione.

• abortSignal: segnale da usare per interrompere l'operazione in corso.

Restituisce

AsyncIterableIterator<ServiceBusReceivedMessage>

Ereditato daServiceBusReceiver.getMessageIterator

peekMessages(number, PeekMessagesOptions)

Visualizzare il batch successivo di messaggi attivi (inclusi i messaggi posticipati ma non inattive) nella coda o nella sottoscrizione senza modificarli.

• La prima chiamata a peekMessages() recupera il primo messaggio attivo. Ogni chiamata successiva recupera il messaggio successivo.
• A differenza di un messaggio "ricevuto", il messaggio "visualizzato" è una versione di sola lettura del messaggio. Non può essere Completed/Abandoned/Deferred/Deadlettered.

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

Parametri

maxMessageCount

number

Numero massimo di messaggi da visualizzare.

options

PeekMessagesOptions

Opzioni che consentono di specificare il numero massimo di messaggi da visualizzare, sequenceNumber per avviare la visualizzazione da o abortSignal per interrompere l'operazione.

Restituisce

Promise<ServiceBusReceivedMessage[]>

Ereditato daServiceBusReceiver.peekMessages

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Restituisce una promessa che viene risolta in una matrice di messaggi posticipati identificati da sequenceNumbers.

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

Parametri

sequenceNumbers

Long | Long[]

Numero di sequenza o matrice di numeri di sequenza per i messaggi che devono essere ricevuti.

options

OperationOptionsBase

Contenitore opzioni per passare un segnale di interruzione o opzioni di traccia.

Restituisce

Promise<ServiceBusReceivedMessage[]>

Elenco di messaggi identificati dall'oggetto sequenceNumbers specificato o da un elenco vuoto se non viene trovato alcun messaggio.

Ereditato daServiceBusReceiver.receiveDeferredMessages

receiveMessages(number, ReceiveMessagesOptions)

Restituisce una promessa che viene risolta in una matrice di messaggi ricevuti dal bus di servizio.

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

Parametri

maxMessageCount

number

Numero massimo di messaggi da ricevere.

options

ReceiveMessagesOptions

Set di opzioni per controllare l'operazione di ricezione.

• maxWaitTimeInMs: tempo massimo di attesa del primo messaggio prima di restituire una matrice vuota se non sono disponibili messaggi.
• abortSignal: segnale da usare per interrompere l'operazione in corso.

Restituisce

Promise<ServiceBusReceivedMessage[]>

Promessa che viene risolta con una matrice di messaggi.

Ereditato daServiceBusReceiver.receiveMessages

renewMessageLock(ServiceBusReceivedMessage)

Rinnova il blocco sul messaggio per la durata specificata durante la creazione della coda o della sottoscrizione.

• Controllare la proprietà lockedUntilUtc nel messaggio per l'ora di scadenza del blocco.
• Se un messaggio non viene risolto (usando complete(), defer() o deadletter(), prima della scadenza del blocco, il messaggio torna nella coda/sottoscrizione per l'operazione di ricezione successiva.

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

Parametri

message

ServiceBusReceivedMessage

Restituisce

Promise<Date>

Nuova data e ora di scadenza del token di blocco in formato UTC.

Ereditato daServiceBusReceiver.renewMessageLock