ServiceBusSessionReceiver interface

Paket:

@azure/service-bus

Oturum kilidini yenileme dahil olmak üzere oturumları işleyen bir alıcı.

Extends

ServiceBusReceiver

Özellikler

sessionId	Oturum kimliği.
sessionLockedUntilUtc	Utc'de oturumun kilitlendiği saat. Her çağrıldığında renewSessionLock() , bu süre geçerli saate ve Kuyruk/Abonelik oluşturma sırasında belirtilen kilit süresine güncelleştirilir. Bir AMQP alıcı bağlantısı oturum için başarıyla ayarlanana kadar tanımsız olarak döndürülür.

Devralınan Özellikler

entityPath	Alıcının oluşturulduğu varlığın yolu.
identifier	Alıcıyı tanımlamak için kullanılan ad. Bu, günlükleri ve özel durumları ilişkilendirmek için kullanılabilir. Belirtilmezse veya boşsa rastgele benzersiz bir tane oluşturulur.
isClosed	Alıcı veya onu oluşturan istemci kapatılmışsa döndürür true .
receiveMode	Alıcıyı oluşturmak için kullanılan alma modu.

Yöntemler

getSessionState(OperationOptionsBase)	Oturumun durumunu alır. Oturum durumları hakkında daha fazla bilgi için bkz . Oturum Durumu
renewSessionLock(OperationOptionsBase)	Oturumdaki kilidi yeniler.
setSessionState(any, OperationOptionsBase)	Oturumdaki durumu ayarlar. Oturum durumları hakkında daha fazla bilgi için bkz . Oturum Durumu
subscribe(MessageHandlers, SubscribeOptions)	İletileri ileti işleyicilerine akışla aktarın.

Devralınan Yöntemler

abandonMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	Alıcı tarafından iletide tutulan kilit serbest bırakılarak iletinin Service Bus'ta başka bir alma işlemi için yeniden kullanılabilir duruma getirilmesi sağlanır.
close()	Alıcıyı kapatır. Kapatıldıktan sonra alıcı başka işlemler için kullanılamaz. createReceiver() Yeni bir Alıcı oluşturmak için ServiceBusClient'da yöntemini kullanın.
completeMessage(ServiceBusReceivedMessage)	İletiyi Service Bus'tan kaldırır.
deadLetterMessage(ServiceBusReceivedMessage, DeadLetterOptions & {[key: string]: number | boolean | string | Date | null})	İletiyi geçersiz hale getirmek için alt kuyruğa taşır. Geçersiz bir ileti almak için, geçersiz hale gelen alt kuyruğun yolunu kullanarak yeni bir QueueClient/SubscriptionClient oluşturun.
deferMessage(ServiceBusReceivedMessage, {[key: string]: number | boolean | string | Date | null})	İletinin işlenmesini geçersiz hale getirerek. sequenceNumber gelecekte yöntemini kullanarak iletiyi yeniden almak için iletisini kaydedinreceiveDeferredMessage.
getMessageIterator(GetMessageIteratorOptions)	Service Bus'tan ileti almak için kullanılabilecek bir yineleyici döndürür.
peekMessages(number, PeekMessagesOptions)	Değiştirmeden kuyrukta veya abonelikte bir sonraki etkin ileti grubuna (ertelenmiş ancak geçersiz olmayan iletiler dahil) göz atın. İlk çağrı peekMessages() ilk etkin iletiyi getirir. Sonraki her çağrı, sonraki iletiyi getirir. "Alındı" iletisinden farklı olarak, "göz atılan" ileti iletinin salt okunur bir sürümüdür. olamaz Completed/Abandoned/Deferred/Deadlettered.
receiveDeferredMessages(Long | Long[], OperationOptionsBase)	Verilen sequenceNumberstarafından tanımlanan ertelenen iletiler dizisine çözümlenen bir söz döndürür.
receiveMessages(number, ReceiveMessagesOptions)	Service Bus'tan alınan bir dizi iletiye çözümleyen bir söz döndürür.
renewMessageLock(ServiceBusReceivedMessage)	Kuyruk/Abonelik oluşturma sırasında belirtilen süre boyunca iletideki kilidi yeniler. Kilidin lockedUntilUtc süresi dolduğunda iletideki özelliğini denetleyin. İleti kapatılmazsa (kilidin süresi dolmadan önce , defer() veya deadletter()kullanarakcomplete()), ileti sonraki alma işlemi için Kuyruk/Abonelik'e geri döner.

Özellik Ayrıntıları

sessionId

Oturum kimliği.

sessionId: string

Özellik Değeri

string

sessionLockedUntilUtc

Utc'de oturumun kilitlendiği saat. Her çağrıldığında renewSessionLock() , bu süre geçerli saate ve Kuyruk/Abonelik oluşturma sırasında belirtilen kilit süresine güncelleştirilir.

Bir AMQP alıcı bağlantısı oturum için başarıyla ayarlanana kadar tanımsız olarak döndürülür.

sessionLockedUntilUtc: Date

Özellik Değeri

Date

Devralınan Özellik Detayları

entityPath

Alıcının oluşturulduğu varlığın yolu.

entityPath: string

Özellik Değeri

string

ServiceBusReceiver.entityPath'tenDevralındı

identifier

Alıcıyı tanımlamak için kullanılan ad. Bu, günlükleri ve özel durumları ilişkilendirmek için kullanılabilir. Belirtilmezse veya boşsa rastgele benzersiz bir tane oluşturulur.

identifier: string

Özellik Değeri

string

ServiceBusReceiver.identifier'danDevralındı

isClosed

Alıcı veya onu oluşturan istemci kapatılmışsa döndürür true .

isClosed: boolean

Özellik Değeri

boolean

ServiceBusReceiver.isClosed'dan Devralındı

receiveMode

Alıcıyı oluşturmak için kullanılan alma modu.

receiveMode: "peekLock" | "receiveAndDelete"

Özellik Değeri

"peekLock" | "receiveAndDelete"

ServiceBusReceiver.receiveMode'danDevralındı

Yöntem Ayrıntıları

getSessionState(OperationOptionsBase)

Oturumun durumunu alır. Oturum durumları hakkında daha fazla bilgi için bkz . Oturum Durumu

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

Parametreler

options

OperationOptionsBase

Durdurma sinyali veya izleme seçeneklerini geçirmek için seçenekler paketi.

Döndürülenler

Promise<any>

Bu oturumun durumu

renewSessionLock(OperationOptionsBase)

Oturumdaki kilidi yeniler.

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

Parametreler

options

OperationOptionsBase

Döndürülenler

Promise<Date>

setSessionState(any, OperationOptionsBase)

Oturumdaki durumu ayarlar. Oturum durumları hakkında daha fazla bilgi için bkz . Oturum Durumu

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

Parametreler

state

any

Ayarlanması gereken durum.

options

OperationOptionsBase

Durdurma sinyali veya izleme seçeneklerini geçirmek için seçenekler paketi.

Döndürülenler

Promise<void>

subscribe(MessageHandlers, SubscribeOptions)

İletileri ileti işleyicilerine akışla aktarın.

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

Parametreler

handlers

MessageHandlers

İletiler ve hatalar için çağrılan işleyici.

options

SubscribeOptions

Abone olma seçenekleri.

Döndürülenler

{ close() => Promise<void> }

Kapatılabilen, kalan iletileri gönderebilen ve yeni iletilerin handlers gelişini durduran bir nesne.

Devralınan Yöntemin Ayrıntıları

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

Alıcı tarafından iletide tutulan kilit serbest bırakılarak iletinin Service Bus'ta başka bir alma işlemi için yeniden kullanılabilir duruma getirilmesi sağlanır.

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

Parametreler

message

ServiceBusReceivedMessage

propertiesToModify

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

İletiyi bırakırken değiştirileceği iletinin özellikleri.

Döndürülenler

Promise<void>

ServiceBusReceiver.abandonMessage'danDevralındı

close()

Alıcıyı kapatır. Kapatıldıktan sonra alıcı başka işlemler için kullanılamaz. createReceiver() Yeni bir Alıcı oluşturmak için ServiceBusClient'da yöntemini kullanın.

function close(): Promise<void>

Döndürülenler

Promise<void>

ServiceBusReceiver.close'danDevralındı

completeMessage(ServiceBusReceivedMessage)

İletiyi Service Bus'tan kaldırır.

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

Parametreler

message

ServiceBusReceivedMessage

Döndürülenler

Promise<void>

ServiceBusReceiver.completeMessage'danDevralındı

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

İletiyi geçersiz hale getirmek için alt kuyruğa taşır. Geçersiz bir ileti almak için, geçersiz hale gelen alt kuyruğun yolunu kullanarak yeni bir QueueClient/SubscriptionClient oluşturun.

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

Parametreler

message

ServiceBusReceivedMessage

options

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

İleti reddederken sağlanabilir DeadLetter seçenekleri.

Döndürülenler

Promise<void>

ServiceBusReceiver.deadLetterMessage'danDevralındı

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

İletinin işlenmesini geçersiz hale getirerek. sequenceNumber gelecekte yöntemini kullanarak iletiyi yeniden almak için iletisini kaydedinreceiveDeferredMessage.

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

Parametreler

message

ServiceBusReceivedMessage

propertiesToModify

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

İleti ertelenirken değiştirileceği iletinin özellikleri

Döndürülenler

Promise<void>

ServiceBusReceiver.deferMessage'danDevralındı

getMessageIterator(GetMessageIteratorOptions)

Service Bus'tan ileti almak için kullanılabilecek bir yineleyici döndürür.

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

Parametreler

options

GetMessageIteratorOptions

Alma işlemini denetlemek için bir dizi seçenek.

• abortSignal: Devam eden işlemi durdurmak için kullanılacak sinyal.

Döndürülenler

AsyncIterableIterator<ServiceBusReceivedMessage>

ServiceBusReceiver.getMessageIterator'danDevralındı

peekMessages(number, PeekMessagesOptions)

Değiştirmeden kuyrukta veya abonelikte bir sonraki etkin ileti grubuna (ertelenmiş ancak geçersiz olmayan iletiler dahil) göz atın.

• İlk çağrı peekMessages() ilk etkin iletiyi getirir. Sonraki her çağrı, sonraki iletiyi getirir.
• "Alındı" iletisinden farklı olarak, "göz atılan" ileti iletinin salt okunur bir sürümüdür. olamaz Completed/Abandoned/Deferred/Deadlettered.

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

Parametreler

maxMessageCount

number

Göz atacak ileti sayısı üst sınırı.

options

PeekMessagesOptions

Göz atılacak en fazla ileti sayısını, göz atmaya başlanması gereken sequenceNumber değerini veya işlemi durdurmak için abortSignal değerini belirtmeye olanak sağlayan seçenekler.

Döndürülenler

Promise<ServiceBusReceivedMessage[]>

ServiceBusReceiver.peekMessages'danDevralındı

receiveDeferredMessages(Long | Long[], OperationOptionsBase)

Verilen sequenceNumberstarafından tanımlanan ertelenen iletiler dizisine çözümlenen bir söz döndürür.

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

Parametreler

sequenceNumbers

Long | Long[]

Alınması gereken iletiler için sıra numarası veya dizi numaraları dizisi.

options

OperationOptionsBase

Durdurma sinyali veya izleme seçeneklerini geçirmek için seçenekler paketi.

Döndürülenler

Promise<ServiceBusReceivedMessage[]>

Verilen sequenceNumbers tarafından tanımlanan iletilerin listesi veya ileti bulunamazsa boş bir liste.

ServiceBusReceiver.receiveDeferredMessages'danDevralındı

receiveMessages(number, ReceiveMessagesOptions)

Service Bus'tan alınan bir dizi iletiye çözümleyen bir söz döndürür.

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

Parametreler

maxMessageCount

number

Alınacak en fazla ileti sayısı.

options

ReceiveMessagesOptions

Alma işlemini denetlemek için bir dizi seçenek.

• maxWaitTimeInMs: Kullanılabilir ileti yoksa boş bir dizi döndürmeden önce ilk iletiyi bekleme süresi.
• abortSignal: Devam eden işlemi durdurmak için kullanılacak sinyal.

Döndürülenler

Promise<ServiceBusReceivedMessage[]>

Bir dizi iletiyle çözülen bir söz.

ServiceBusReceiver.receiveMessages'danDevralındı

renewMessageLock(ServiceBusReceivedMessage)

Kuyruk/Abonelik oluşturma sırasında belirtilen süre boyunca iletideki kilidi yeniler.

• Kilidin lockedUntilUtc süresi dolduğunda iletideki özelliğini denetleyin.
• İleti kapatılmazsa (kilidin süresi dolmadan önce , defer() veya deadletter()kullanarakcomplete()), ileti sonraki alma işlemi için Kuyruk/Abonelik'e geri döner.

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

Parametreler

message

ServiceBusReceivedMessage

Döndürülenler

Promise<Date>

Utc biçiminde yeni kilit belirteci süre sonu tarihi ve saati.

ServiceBusReceiver.renewMessageLock'tanDevralındı