ServiceBusSessionReceiver interface

Paket:

@azure/service-bus

Penerima yang menangani sesi, termasuk memperbarui kunci sesi.

Memperluas

ServiceBusReceiver

Properti

sessionId	ID sesi tersebut.
sessionLockedUntilUtc	Waktu dalam UTC hingga sesi dikunci. Setiap kali renewSessionLock() dipanggil, waktu ini diperbarui ke waktu saat ini ditambah durasi penguncian seperti yang ditentukan selama pembuatan Antrean/Langganan. Akan mengembalikan tidak terdefinisi hingga tautan penerima AMQP berhasil disiapkan untuk sesi.

Properti yang Diwariskan

entityPath	Jalur entitas tempat penerima telah dibuat.
identifier	Nama yang digunakan untuk mengidentifikasi penerima. Ini dapat digunakan untuk menghubungkan log dan pengecualian. Jika tidak ditentukan atau kosong, yang unik acak akan dihasilkan.
isClosed	Mengembalikan true jika penerima atau klien yang membuatnya telah ditutup.
receiveMode	Mode terima yang digunakan untuk membuat penerima.

Metode

getSessionState(OperationOptionsBase)	Mendapatkan status Sesi. Untuk selengkapnya tentang status sesi, lihat Status Sesi
renewSessionLock(OperationOptionsBase)	Memperbarui kunci pada sesi.
setSessionState(any, OperationOptionsBase)	Mengatur status pada Sesi. Untuk selengkapnya tentang status sesi, lihat Status Sesi
subscribe(MessageHandlers, SubscribeOptions)	Mengalirkan pesan ke penangan pesan.

Metode yang Diwarisi

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Kunci yang disimpan pada pesan oleh penerima dilepaskan, membuat pesan tersedia lagi di Bus Layanan untuk operasi penerimaan lain.
close()	Menutup penerima. Setelah ditutup, penerima tidak dapat digunakan untuk operasi lebih lanjut. Gunakan metode createReceiver() pada ServiceBusClient untuk membuat Penerima baru.
completeMessage(ServiceBusReceivedMessage)	Menghapus pesan dari Azure Service Bus.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	Memindahkan pesan ke sub-antrean deadletter. Untuk menerima pesan yang dihentikan, buat QueueClient/SubscriptionClient baru menggunakan jalur untuk sub-antrean deadletter.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Menangguhkan pemrosesan pesan. Simpan sequenceNumber pesan, untuk menerima pesan lagi di masa mendatang menggunakan metode receiveDeferredMessage.
getMessageIterator(GetMessageIteratorOptions)	Mengembalikan iterator yang dapat digunakan untuk menerima pesan dari Azure Service Bus.
peekMessages(number, PeekMessagesOptions)	Intip batch pesan aktif berikutnya (termasuk pesan yang ditangguhkan tetapi tidak dihentikan) pada antrean atau langganan tanpa memodifikasinya. Panggilan pertama untuk peekMessages() mengambil pesan aktif pertama. Setiap panggilan berikutnya mengambil pesan berikutnya. Tidak seperti pesan "diterima", pesan "diintip" adalah versi pesan baca-saja. Ini tidak dapat Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Mengembalikan janji yang diselesaikan ke array pesan yang ditangguhkan yang diidentifikasi oleh sequenceNumbersyang diberikan.
receiveMessages(number, ReceiveMessagesOptions)	Mengembalikan janji yang diselesaikan ke array pesan yang diterima dari Azure Service Bus.
renewMessageLock(ServiceBusReceivedMessage)	Memperbarui kunci pada pesan selama durasi seperti yang ditentukan selama pembuatan Antrean/Langganan. Periksa properti lockedUntilUtc pada pesan untuk waktu ketika kunci kedaluwarsa. Jika pesan tidak diselesaikan (menggunakan complete(), defer() atau deadletter(), sebelum kuncinya kedaluwarsa, pesan akan kembali ke Antrean/Langganan untuk operasi penerimaan berikutnya.

Detail Properti

sessionId

ID sesi tersebut.

sessionId: string

Nilai Properti

string

sessionLockedUntilUtc

Waktu dalam UTC hingga sesi dikunci. Setiap kali renewSessionLock() dipanggil, waktu ini diperbarui ke waktu saat ini ditambah durasi penguncian seperti yang ditentukan selama pembuatan Antrean/Langganan.

Akan mengembalikan tidak terdefinisi hingga tautan penerima AMQP berhasil disiapkan untuk sesi.

sessionLockedUntilUtc: Date

Nilai Properti

Date

Detail Properti yang Diwariskan

entityPath

Jalur entitas tempat penerima telah dibuat.

entityPath: string

Nilai Properti

string

Diwarisi dariServiceBusReceiver.entityPath

identifier

Nama yang digunakan untuk mengidentifikasi penerima. Ini dapat digunakan untuk menghubungkan log dan pengecualian. Jika tidak ditentukan atau kosong, yang unik acak akan dihasilkan.

identifier: string

Nilai Properti

string

Diwarisi dariServiceBusReceiver.identifier

isClosed

Mengembalikan true jika penerima atau klien yang membuatnya telah ditutup.

isClosed: boolean

Nilai Properti

boolean

Diwarisi dariServiceBusReceiver.isClosed

receiveMode

Mode terima yang digunakan untuk membuat penerima.

receiveMode: "peekLock" | "receiveAndDelete"

Nilai Properti

"peekLock" | "receiveAndDelete"

Diwarisi dariServiceBusReceiver.receiveMode

Detail Metode

getSessionState(OperationOptionsBase)

Mendapatkan status Sesi. Untuk selengkapnya tentang status sesi, lihat Status Sesi

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

Parameter

options

OperationOptionsBase

Tas opsi untuk meneruskan opsi sinyal atau pelacakan yang dibatalkan.

Mengembalikan

Promise<any>

Status sesi tersebut

renewSessionLock(OperationOptionsBase)

Memperbarui kunci pada sesi.

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

Parameter

options

OperationOptionsBase

Mengembalikan

Promise<Date>

setSessionState(any, OperationOptionsBase)

Mengatur status pada Sesi. Untuk selengkapnya tentang status sesi, lihat Status Sesi

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

Parameter

state

any

Status yang perlu diatur.

options

OperationOptionsBase

Tas opsi untuk meneruskan opsi sinyal atau pelacakan yang dibatalkan.

Mengembalikan

Promise<void>

subscribe(MessageHandlers, SubscribeOptions)

Mengalirkan pesan ke penangan pesan.

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

Parameter

handlers

MessageHandlers

Handler yang dipanggil untuk pesan dan kesalahan.

options

SubscribeOptions

Opsi untuk berlangganan.

Mengembalikan

{ close() => Promise<void> }

Objek yang dapat ditutup, mengirim pesan yang tersisa ke handlers dan menghentikan pesan baru tiba.

Detail Metode yang Diwarisi

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

Kunci yang disimpan pada pesan oleh penerima dilepaskan, membuat pesan tersedia lagi di Bus Layanan untuk operasi penerimaan lain.

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

Parameter

message

ServiceBusReceivedMessage

propertiesToModify

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

Properti pesan yang akan diubah saat meninggalkan pesan.

Mengembalikan

Promise<void>

Diwarisi dariServiceBusReceiver.abandonMessage

close()

Menutup penerima. Setelah ditutup, penerima tidak dapat digunakan untuk operasi lebih lanjut. Gunakan metode createReceiver() pada ServiceBusClient untuk membuat Penerima baru.

function close(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariServiceBusReceiver.close

completeMessage(ServiceBusReceivedMessage)

Menghapus pesan dari Azure Service Bus.

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

Parameter

message

ServiceBusReceivedMessage

Mengembalikan

Promise<void>

Diwarisi dariServiceBusReceiver.completeMessage

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

Memindahkan pesan ke sub-antrean deadletter. Untuk menerima pesan yang dihentikan, buat QueueClient/SubscriptionClient baru menggunakan jalur untuk sub-antrean deadletter.

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

Parameter

message

ServiceBusReceivedMessage

options

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

Opsi DeadLetter yang dapat disediakan saat menolak pesan.

Mengembalikan

Promise<void>

Diwarisi dariServiceBusReceiver.deadLetterMessage

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

Menangguhkan pemrosesan pesan. Simpan sequenceNumber pesan, untuk menerima pesan lagi di masa mendatang menggunakan metode receiveDeferredMessage.

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

Parameter

message

ServiceBusReceivedMessage

propertiesToModify

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

Properti pesan yang akan diubah saat menugasi pesan

Mengembalikan

Promise<void>

Diwarisi dariServiceBusReceiver.deferMessage

getMessageIterator(GetMessageIteratorOptions)

Mengembalikan iterator yang dapat digunakan untuk menerima pesan dari Azure Service Bus.

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

Parameter

options

GetMessageIteratorOptions

Sekumpulan opsi untuk mengontrol operasi penerimaan.

• abortSignal: Sinyal yang digunakan untuk membatalkan operasi yang sedang berlangsung.

Mengembalikan

AsyncIterableIterator<ServiceBusReceivedMessage>

Diwarisi dariServiceBusReceiver.getMessageIterator

peekMessages(number, PeekMessagesOptions)

Intip batch pesan aktif berikutnya (termasuk pesan yang ditangguhkan tetapi tidak dihentikan) pada antrean atau langganan tanpa memodifikasinya.

• Panggilan pertama untuk peekMessages() mengambil pesan aktif pertama. Setiap panggilan berikutnya mengambil pesan berikutnya.
• Tidak seperti pesan "diterima", pesan "diintip" adalah versi pesan baca-saja. Ini tidak dapat Completed/Abandoned/Deferred/Deadlettered.

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

Parameter

maxMessageCount

number

Jumlah maksimum pesan yang akan diintip.

options

PeekMessagesOptions

Opsi yang memungkinkan untuk menentukan jumlah maksimum pesan yang akan diintip, urutanNumber untuk mulai mengintip dari atau abortSignal untuk membatalkan operasi.

Mengembalikan

Promise<ServiceBusReceivedMessage[]>

Diwarisi dariServiceBusReceiver.peekMessages

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Mengembalikan janji yang diselesaikan ke array pesan yang ditangguhkan yang diidentifikasi oleh sequenceNumbersyang diberikan.

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

Parameter

sequenceNumbers

Long | Long[]

Nomor urut atau array nomor urut untuk pesan yang perlu diterima.

options

OperationOptionsBase

Tas opsi untuk meneruskan opsi sinyal atau pelacakan yang dibatalkan.

Mengembalikan

Promise<ServiceBusReceivedMessage[]>

Daftar pesan yang diidentifikasi oleh sequenceNumbers yang diberikan atau daftar kosong jika tidak ada pesan yang ditemukan.

Diwarisi dariServiceBusReceiver.receiveDeferredMessages

receiveMessages(number, ReceiveMessagesOptions)

Mengembalikan janji yang diselesaikan ke array pesan yang diterima dari Azure Service Bus.

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

Parameter

maxMessageCount

number

Jumlah maksimum pesan yang akan diterima.

options

ReceiveMessagesOptions

Sekumpulan opsi untuk mengontrol operasi penerimaan.

• maxWaitTimeInMs: Waktu maksimum untuk menunggu pesan pertama sebelum mengembalikan array kosong jika tidak ada pesan yang tersedia.
• abortSignal: Sinyal yang digunakan untuk membatalkan operasi yang sedang berlangsung.

Mengembalikan

Promise<ServiceBusReceivedMessage[]>

Janji yang diselesaikan dengan array pesan.

Diwarisi dariServiceBusReceiver.receiveMessages

renewMessageLock(ServiceBusReceivedMessage)

Memperbarui kunci pada pesan selama durasi seperti yang ditentukan selama pembuatan Antrean/Langganan.

• Periksa properti lockedUntilUtc pada pesan untuk waktu ketika kunci kedaluwarsa.
• Jika pesan tidak diselesaikan (menggunakan complete(), defer() atau deadletter(), sebelum kuncinya kedaluwarsa, pesan akan kembali ke Antrean/Langganan untuk operasi penerimaan berikutnya.

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

Parameter

message

ServiceBusReceivedMessage

Mengembalikan

Promise<Date>

Tanggal dan waktu kedaluwarsa token kunci baru dalam format UTC.

Diwarisi dariServiceBusReceiver.renewMessageLock