Aracılığıyla paylaş

ServiceBusSender interface

  • Başvuru
Paket:
@azure/service-bus

Gönderen, ileti göndermek, iletileri daha sonra gönderilecek şekilde zamanlamak ve bu zamanlanmış iletileri iptal etmek için kullanılabilir. Bir Gönderen örneği createSender oluşturmak için ServiceBusClient'da işlevini kullanın. Sender sınıfı, temel alınan AMQP gönderen bağlantısı üzerinde bir soyutlamadır.

Özellikler

entityPath

Gönderenin oluşturulduğu varlığın yolu.
identifier

Göndereni 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

Gönderen veya oluşturan istemci kapatılmışsa döndürür true .

Yöntemler

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

ServiceBus Kuyruğunda/Aboneliğinde görünmesi zamanlanmış birden çok iletiyi iptal eder.
close()

Temel alınan AMQP gönderen bağlantısını kapatır. Kapatıldıktan sonra, gönderen başka işlemler için kullanılamaz. createSender Yeni bir Gönderen örneği oluşturmak için QueueClient veya TopicClient üzerindeki işlevini kullanın
createMessageBatch(CreateMessageBatchOptions)

Desteklenen boyut üst sınırına ServiceBusMessageBatch ulaşılana kadar ileti ekleyebileceği bir örneği oluşturur. Toplu işlem, iletileri Azure Service Bus göndermek için yöntemine geçirilebilir<xref:send>.
scheduleMessages(ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], Date, OperationOptionsBase)

Verilen iletilerin daha sonra Service Bus Kuyruğunda/Aboneliğinde gösterilmesini zamanlar.
sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)

AmQP Gönderen bağlantısı oluşturulduktan sonra, henüz yoksa verilen iletileri gönderir.

  • ve/veya partition etkin bir session Kuyruğa/Konuya ileti göndermek için, iletilerde sessionId sırasıyla ve/veya partitionKey özelliklerini ayarlayın.
  • Aynı sendMessages() çağrısına geçirilen tüm iletiler aynı sessionId (oturum kullanılıyorsa) ve aynı partitionKey (bölümler kullanılıyorsa) olmalıdır.

Not:

Boyutu 1 MB'tan büyük iletiler göndermek istiyorsanız toplu ileti veya aşağıdaki gibi bir ileti dizisi göndermek yerine tek tek iletiler gönderin.

await sender.sendMessages(message);

Bunun nedeni toplu iletilerin henüz daha büyük iletileri gönderemiyor olmasıdır. Aksi takdirde bu durumda hatayla force detached karşılaşırsınız. Service-bus-premium-messaging#large-messages-support dosyasını okuyun. Daha fazla bilgi için bkz. #23014.

Özellik Ayrıntıları

entityPath

Gönderenin oluşturulduğu varlığın yolu.

entityPath: string

Özellik Değeri

string

identifier

Göndereni 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

isClosed

Gönderen veya oluşturan istemci kapatılmışsa döndürür true .

isClosed: boolean

Özellik Değeri

boolean

Yöntem Ayrıntıları

cancelScheduledMessages(Long | Long[], OperationOptionsBase)

ServiceBus Kuyruğunda/Aboneliğinde görünmesi zamanlanmış birden çok iletiyi iptal eder.

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

Parametreler

sequenceNumbers

Long | Long[]

sıra numarası veya iptal edilecek iletilerin dizi numaraları dizisi.

options
OperationOptionsBase

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

Döndürülenler

Promise<void>

close()

Temel alınan AMQP gönderen bağlantısını kapatır. Kapatıldıktan sonra, gönderen başka işlemler için kullanılamaz. createSender Yeni bir Gönderen örneği oluşturmak için QueueClient veya TopicClient üzerindeki işlevini kullanın

function close(): Promise<void>

Döndürülenler

Promise<void>

createMessageBatch(CreateMessageBatchOptions)

Desteklenen boyut üst sınırına ServiceBusMessageBatch ulaşılana kadar ileti ekleyebileceği bir örneği oluşturur. Toplu işlem, iletileri Azure Service Bus göndermek için yöntemine geçirilebilir<xref:send>.

function createMessageBatch(options?: CreateMessageBatchOptions): Promise<ServiceBusMessageBatch>

Parametreler

options
CreateMessageBatchOptions

Toplu iş davranışını yapılandırılır.

  • maxSizeInBytes: Toplu iş boyutu için üst sınır. Bu tryAdd sınıra ulaşıldıktan sonra işlev döndürülecektir false .

Döndürülenler

Promise<ServiceBusMessageBatch>

scheduleMessages(ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], Date, OperationOptionsBase)

Verilen iletilerin daha sonra Service Bus Kuyruğunda/Aboneliğinde gösterilmesini zamanlar.

function scheduleMessages(messages: ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], scheduledEnqueueTimeUtc: Date, options?: OperationOptionsBase): Promise<Long[]>

Parametreler

messages

ServiceBusMessage | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

İleti veya zamanlanması gereken bir ileti dizisi.

scheduledEnqueueTimeUtc

Date

İletilerin sıraya alınması gereken UTC saati.

options
OperationOptionsBase

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

Döndürülenler

Promise<Long[]>

Zamanlanmış iletilerin sıra numaraları. İletilerin zamanlamasını iptal etmek istiyorsanız, sıra numarasına ihtiyacınız olacaktır. Sayıya Long dönüştürmeden türü uygulamanızda olduğu gibi kaydedin. JavaScript yalnızca 53 bit sayıyı desteklediğinden, öğesini sayıya dönüştürmek Long duyarlık kaybına neden olur.

sendMessages(ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], OperationOptionsBase)

AmQP Gönderen bağlantısı oluşturulduktan sonra, henüz yoksa verilen iletileri gönderir.

  • ve/veya partition etkin bir session Kuyruğa/Konuya ileti göndermek için, iletilerde sessionId sırasıyla ve/veya partitionKey özelliklerini ayarlayın.
  • Aynı sendMessages() çağrısına geçirilen tüm iletiler aynı sessionId (oturum kullanılıyorsa) ve aynı partitionKey (bölümler kullanılıyorsa) olmalıdır.

Not:

Boyutu 1 MB'tan büyük iletiler göndermek istiyorsanız toplu ileti veya aşağıdaki gibi bir ileti dizisi göndermek yerine tek tek iletiler gönderin.

await sender.sendMessages(message);

Bunun nedeni toplu iletilerin henüz daha büyük iletileri gönderemiyor olmasıdır. Aksi takdirde bu durumda hatayla force detached karşılaşırsınız. Service-bus-premium-messaging#large-messages-support dosyasını okuyun. Daha fazla bilgi için bkz. #23014.

function sendMessages(messages: ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[], options?: OperationOptionsBase): Promise<void>

Parametreler

messages

ServiceBusMessage | ServiceBusMessageBatch | AmqpAnnotatedMessage | ServiceBusMessage[] | AmqpAnnotatedMessage[]

Gönderilecek createBatch() yöntemiyle oluşturulan tek bir ileti veya ileti dizisi ya da bir dizi ileti.

options
OperationOptionsBase

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

Döndürülenler

Promise<void>