@azure/event-hubs package
Sınıflar
EventHubBufferedProducerClient |
olayları Olaylar sıralandığında belirtilen seçeneklere bağlı olarak, bunlar otomatik olarak bir bölüme atanabilir, belirtilen bölüm anahtarına göre gruplandırılabilir veya özel olarak istenen bir bölüme atanabilir. Bu model, olayların ne zaman yayımlanacakları konusunda belirleyici olmayan bir zamanlama karşılığında çağıranlardan toplu iş yönetimi yükünü kaydırmaya yöneliktir. Dikkate alınması gereken ek avantajlar da vardır:
Olayların belirlenimci bir sonuçla hemen yayımlanmasının önemli olduğu senaryolarda, bölüm anahtarlarının diğer yayımcılarla tutarlı bir bölüme atandığından emin olun veya kullanılabilirliği en üst düzeye çıkarmanın gerekli olduğu durumlarda, öğesini kullanmanız |
EventHubConsumerClient |
Oluşturmanın birden çok yolu vardır
İsteğe bağlı olarak şunları da geçirebilirsiniz:
|
EventHubProducerClient |
Oluşturmanın birden çok yolu vardır
İsteğe bağlı olarak, yeniden deneme ilkesini veya ara sunucu ayarlarını yapılandırmak için bir seçenek paketi de geçirebilirsiniz. |
MessagingError |
Mesajlaşma Hatası için temel sınıfı açıklar. |
Arabirimler
BufferedCloseOptions |
üzerinde |
BufferedFlushOptions |
üzerinde |
Checkpoint |
Denetim noktası, olay hub'ı örneğindeki bir tüketici grubunun belirli bir bölümünden kullanıcı tarafından başarıyla işlenen son olayı temsil etmeye yöneliktir. sınıfındaki Kullanıcıların hiçbir zaman doğrudan etkileşim |
CheckpointStore |
Denetim noktası deposu, bir olay hub'ı örneğinin belirli bir tüketici grubundaki her bölüm için bölüm sahipliği bilgilerini ve denetim noktası ayrıntılarını depolar ve alır. Kullanıcıların uygulaması amaçlanmamıştır
|
CreateBatchOptions |
üzerinde
Örnek kullanım:
|
EnqueueEventOptions |
üzerinde |
EventData |
Olay Hub'ına gönderilecek verileri açıklayan arabirim.
kullanırken
|
EventDataAdapterParameters |
Olay veri bağdaştırıcısı oluşturan işlevin |
EventDataBatch |
Olay Hub'ına olay göndermek için kullanılabilecek bir dizi olayı temsil eden arabirim. Toplu işlemi oluşturmak için üzerinde |
EventHubBufferedProducerClientOptions |
oluşturulurken |
EventHubClientOptions |
EventHubClient oluşturulurken sağlanacak seçenekleri açıklar.
Basit bir kullanım olabilir Örnek kullanım:
|
EventHubConnectionStringProperties |
Olay Hub'ı bağlantı dizesi oluşturan özellikler kümesi. |
EventHubConsumerClientOptions |
EventHubConsumerClient oluşturulurken sağlanacak seçenekleri açıklar.
Basit bir kullanım olabilir Örnek kullanım:
|
EventHubProperties |
Bir Olay Hub'ının çalışma zamanı bilgilerini açıklar. |
EventPosition |
Olay Hub'ı bölümündeki bir olayın konumunu temsil eder; genellikle olay almaya başlamak için bölümdeki konumu belirtmek için üzerinde yöntemini Akışın başlangıcını veya sonunu temsil eden bir EventPosition almak için sırasıyla ve |
GetEventHubPropertiesOptions |
davranışını
|
GetPartitionIdsOptions |
davranışını
|
GetPartitionPropertiesOptions |
davranışını
|
LastEnqueuedEventProperties |
Event Hubs hizmetinden olaylar alınırken tüketici tarafından gözlemlendiği gibi, bir bölümün son sıraya alınan olayı hakkında bilgi kümesi |
LoadBalancingOptions |
Yük dengeleme ayarlarını yapılandırmak için bir seçenek paketi. |
OnSendEventsErrorContext |
Olay Hub'ına başarıyla gönderilmeyen olayları, atandıkları bölümü ve gönderirken karşılaşılan hatayı içerir. |
OnSendEventsSuccessContext |
Olay Hub'ına başarıyla gönderilen olayları ve atandıkları bölümü içerir. |
OperationOptions |
İzlemeyi ve abortSignal'ı yapılandırma seçenekleri. |
PartitionContext |
bir parçası |
PartitionOwnership |
Bir Olay Hub'ı örneğinin tüketici grubundan belirli bir Not: Bu, ve kullanıcının hiçbir zaman doğrudan oluşturması gerekmeyen |
PartitionProperties |
Bir EventHub Bölümünün çalışma zamanı bilgilerini açıklar. |
ReceivedEventData |
Olay Hub'ından alınan olayın yapısını açıklayan arabirim.
kullanırken |
RetryOptions |
Modu, yeniden deneme sayısını, yeniden deneme aralığını vb. belirleyen yeniden deneme ilkesi seçenekleri. |
SendBatchOptions |
Bir olay dizisi gönderirken üzerinde
|
SubscribeOptions |
üzerinde |
Subscription |
üzerinde |
SubscriptionEventHandlers |
Olay Hub'ından olay almak için yöntemi çağrıldığında |
TokenCredential |
Kimlik doğrulama belirteci sağlayabilen kimlik bilgilerini temsil eder. |
TryAddOptions |
sınıfındaki yönteminin |
WebSocketImpl |
WebSocket oluşturucularının gerekli şeklini açıklar. |
WebSocketOptions |
AMQP bağlantısının Web Yuvaları üzerinden kanallarını yapılandırma seçenekleri. |
Tür Diğer Adları
ProcessCloseHandler |
Bir bölümden olay almak için durduktan hemen sonra tarafından |
ProcessErrorHandler |
Olayları alırken veya kullanıcı tarafından sağlanan işlevlerden herhangi biri yöntemine geçirilirken oluşan hatalar için tarafından çağrılan |
ProcessEventsHandler |
Bir olay kümesi alındığında tarafından |
ProcessInitializeHandler |
Bir bölümden olay almaya başlamadan hemen önce tarafından |
Numaralandırmalar
CloseReason |
Olay Hub'ının tüketici grubundaki bir |
RetryMode |
Yeniden Deneme Modu türünü açıklar |
İşlevler
create |
Olay veri bağdaştırıcısı oluşturan bir işlev. Bu bağdaştırıcı, olay verilerinin gövdesini kodlamak ve kodunu çözmek için ile |
parse |
verilen bağlantı dizesi Azure Event Hubs için geçerli olan farklı özelliklere ayrıştırın. Özellikler daha sonra bir EventHubProducerClient veya EventHubConsumerClient oluşturmak için yararlıdır. |
İşlev Ayrıntıları
createEventDataAdapter(EventDataAdapterParameters)
Olay veri bağdaştırıcısı oluşturan bir işlev. Bu bağdaştırıcı, olay verilerinin gövdesini kodlamak ve kodunu çözmek için ile @azure/schema-registry-avro
birlikte kullanılabilir.
function createEventDataAdapter(params?: EventDataAdapterParameters): MessageAdapter<EventData>
Parametreler
- params
- EventDataAdapterParameters
olay verilerini oluşturmak için parametreler
Döndürülenler
MessageAdapter<EventData>
Olay verilerini oluşturabilen ve tüketebilen bir olay veri bağdaştırıcısı
parseEventHubConnectionString(string)
verilen bağlantı dizesi Azure Event Hubs için geçerli olan farklı özelliklere ayrıştırın. Özellikler daha sonra bir EventHubProducerClient veya EventHubConsumerClient oluşturmak için yararlıdır.
function parseEventHubConnectionString(connectionString: string): Readonly<EventHubConnectionStringProperties>
Parametreler
- connectionString
-
string
Event Hubs ad alanı için oluşturulan Paylaşılan Erişim İlkesi ile ilişkili bağlantı dizesi.
Döndürülenler
Readonly<EventHubConnectionStringProperties>