SubscriptionEventHandlers interface

Csomag:

@azure/event-hubs

A felhasználó által implementálandó függvényeket leíró felület, amelyet a EventHubConsumerClientsubscribe() metódus meghívásakor az eseményközpont eseményeinek fogadásához hív meg.

Tulajdonságok

processClose	Az előfizetés által meghívott függvény minden alkalommal, EventHubConsumerClient amikor az előfizetés leállítja az események olvasását egy partícióból. A partícióra vonatkozó információk a PartitionContext függvénynek átadott adatokon processCloselesznek elérhetők. Ha a CloseReason függvénynek átadott érték OwnershipLost, akkor egy másik előfizetés vette át az olvasást ugyanabból a partícióból, ugyanazzal a fogyasztói csoporttal. Ez akkor várható, ha az alkalmazás több példánya fut, és átadta az CheckpointStore ügyfelet a terheléselosztáshoz. Ha a CloseReason értéke Shutdown, az azt jelzi, hogy subscription.close() vagy meghívták, vagy hiba történt. Hacsak az előfizetés nem lett explicit módon lezárva a használatával subscription.close(), az előfizetés megpróbálja folytatni az olvasási eseményeket a partíció utolsó ellenőrzőpontjáról.
processError	Az által EventHubConsumerClient meghívott függvény az események fogadásakor vagy a felhasználó által a metódusnak subscribe() átadott függvények végrehajtásakor előforduló hibák esetén. Az PartitionContext ennek a függvénynek átadott partíció jelzi azt a partíciót, amely a hiba elhárításakor lett feldolgozva. Azokban az esetekben, amikor egy partíció feldolgozási eseményein kívül (például a terheléselosztás sikertelenségén) hiba történik, a partitionId környezet egy üres sztring lesz. Miután az ügyfél befejezte a függvény végrehajtását, a partitionClose függvény meg lesz hívva.
processEvents	Az eseménykészlet fogadásakor meghívott EventHubConsumerClient függvény. Az PartitionContext ennek a függvénynek átadott függvénnyel meghatározható, hogy melyik partícióról olvas be a rendszer. A updateCheckpoint() környezetben található metódus használatával frissítheti az ellenőrzőpontokat a CheckpointStore (ha az ügyfélnek biztosították). Használja ezt a gyakori időközöket a feldolgozott események megjelöléséhez, hogy az ügyfél újrainduljon az ilyen ellenőrzőpontokról újraindítás vagy hiba helyreállítása esetén. Megjegyzés: A fogadott események lehetnek üres tömbök. Ez akkor fordulhat elő, ha nem érkeznek új események a maxWaitTimeInSeconds-ben, amely alapértelmezés szerint 60 másodperc. A maxWaitTimeInSeconds módosítható úgy, hogy be van állítva az options átadott értékre subscribe().
processInitialize	A függvényt EventHubConsumerClient minden alkalommal meghívja, amikor az előfizetés egy partícióról kezdi az olvasást. Az PartitionContext ennek a függvénynek átadott függvénnyel meghatározható, hogy melyik partícióról szeretne olvasni. Az ügyfél csak a függvény végrehajtása után kezdi meg a partíció eseményeinek fogadását (ha meg van adva). Ezért ezzel a függvénnyel elvégezhet minden beállítási feladatot, beleértve az aszinkron feladatokat is.

Tulajdonság adatai

processClose

Az előfizetés által meghívott függvény minden alkalommal, EventHubConsumerClient amikor az előfizetés leállítja az események olvasását egy partícióból. A partícióra vonatkozó információk a PartitionContext függvénynek átadott adatokon processCloselesznek elérhetők.

Ha a CloseReason függvénynek átadott érték OwnershipLost, akkor egy másik előfizetés vette át az olvasást ugyanabból a partícióból, ugyanazzal a fogyasztói csoporttal. Ez akkor várható, ha az alkalmazás több példánya fut, és átadta az CheckpointStore ügyfelet a terheléselosztáshoz.

Ha a CloseReason értéke Shutdown, az azt jelzi, hogy subscription.close() vagy meghívták, vagy hiba történt. Hacsak az előfizetés nem lett explicit módon lezárva a használatával subscription.close(), az előfizetés megpróbálja folytatni az olvasási eseményeket a partíció utolsó ellenőrzőpontjáról.

processClose?: ProcessCloseHandler

Tulajdonság értéke

ProcessCloseHandler

processError

Az által EventHubConsumerClient meghívott függvény az események fogadásakor vagy a felhasználó által a metódusnak subscribe() átadott függvények végrehajtásakor előforduló hibák esetén.

Az PartitionContext ennek a függvénynek átadott partíció jelzi azt a partíciót, amely a hiba elhárításakor lett feldolgozva. Azokban az esetekben, amikor egy partíció feldolgozási eseményein kívül (például a terheléselosztás sikertelenségén) hiba történik, a partitionId környezet egy üres sztring lesz.

Miután az ügyfél befejezte a függvény végrehajtását, a partitionClose függvény meg lesz hívva.

processError: ProcessErrorHandler

Tulajdonság értéke

ProcessErrorHandler

processEvents

Az eseménykészlet fogadásakor meghívott EventHubConsumerClient függvény. Az PartitionContext ennek a függvénynek átadott függvénnyel meghatározható, hogy melyik partícióról olvas be a rendszer.

A updateCheckpoint() környezetben található metódus használatával frissítheti az ellenőrzőpontokat a CheckpointStore (ha az ügyfélnek biztosították). Használja ezt a gyakori időközöket a feldolgozott események megjelöléséhez, hogy az ügyfél újrainduljon az ilyen ellenőrzőpontokról újraindítás vagy hiba helyreállítása esetén.

Megjegyzés: A fogadott események lehetnek üres tömbök. Ez akkor fordulhat elő, ha nem érkeznek új események a maxWaitTimeInSeconds-ben, amely alapértelmezés szerint 60 másodperc. A maxWaitTimeInSeconds módosítható úgy, hogy be van állítva az options átadott értékre subscribe().

processEvents: ProcessEventsHandler

Tulajdonság értéke

ProcessEventsHandler

processInitialize

A függvényt EventHubConsumerClient minden alkalommal meghívja, amikor az előfizetés egy partícióról kezdi az olvasást. Az PartitionContext ennek a függvénynek átadott függvénnyel meghatározható, hogy melyik partícióról szeretne olvasni.

Az ügyfél csak a függvény végrehajtása után kezdi meg a partíció eseményeinek fogadását (ha meg van adva). Ezért ezzel a függvénnyel elvégezhet minden beállítási feladatot, beleértve az aszinkron feladatokat is.

processInitialize?: ProcessInitializeHandler

Tulajdonság értéke

ProcessInitializeHandler