SubscriptionEventHandlers interface

參考

套件:: @azure/event-hubs

介面，描述呼叫方法以從事件中樞接收事件時 subscribe() ， EventHubConsumerClient 由使用者實作的函式。

屬性

processClose	每次訂閱停止從分割區讀取事件時所 `EventHubConsumerClient` 叫用的函式。傳遞至函 `processClose` 式的上，將會提供 `PartitionContext` 此資料分割的相關資訊。如果傳遞至此函式的 `CloseReason` 是 `OwnershipLost` ，則另一個訂用帳戶已使用同一個取用者群組來接管從相同分割區的讀取。如果您有多個應用程式實例正在執行，且已將傳遞給 `CheckpointStore` 用戶端進行負載平衡，則這是預期情況。 `CloseReason`如果為 `Shutdown` ，表示 `subscription.close()` 已呼叫或發生錯誤。除非透過明確關閉 `subscription.close()` 訂閱，否則訂閱會嘗試繼續從資料分割的最後一個檢查點讀取事件。
processError	針對 `EventHubConsumerClient` 接收事件或執行任何傳遞至方法的使用者提供的函式時，所叫用的錯誤所叫用的 `subscribe()` 函式。 `PartitionContext`傳遞至此函式的會指出擲回錯誤時正在處理的分割區。如果從分割區 (處理事件之外擲回錯誤，例如無法執行負載平衡) ， `partitionId` 內容上的會是空字串。用戶端完成執行此函式之後，就會叫用函 `partitionClose` 式。
processEvents	收到一組事件時所叫用 `EventHubConsumerClient` 的函式。 `PartitionContext`傳遞至此函式的可用來判斷要讀取的資料分割。如果已將檢查點提供給用戶端) ，則 `updateCheckpoint()` 內容上的方法可用來更新 (中的 `CheckpointStore` 檢查點。請以頻繁的間隔來標記已處理的事件，讓用戶端可以在重新開機或錯誤復原時從這類檢查點重新開機。注意：接收的事件可能是空陣列。如果中 `maxWaitTimeInSeconds` 沒有要接收的新事件，預設為 60 秒，就會發生這種情況。 `maxWaitTimeInSeconds`可以藉由將它設定為，將它 `options` 設定為 `subscribe()` 。
processInitialize	每次訂閱即將開始讀取資料分割時所 `EventHubConsumerClient` 叫用的函式。 `PartitionContext`傳遞至此函式的可用來判斷要讀取的資料分割。只有在提供此函式) 時，用戶端才會開始接收資料分割的事件 (。因此，使用此函式來執行任何安裝工作，包括非同步工作。

屬性詳細資料

processClose

每次訂閱停止從分割區讀取事件時所 EventHubConsumerClient 叫用的函式。傳遞至函 processClose 式的上，將會提供 PartitionContext 此資料分割的相關資訊。

如果傳遞至此函式的 CloseReason 是 OwnershipLost ，則另一個訂用帳戶已使用同一個取用者群組來接管從相同分割區的讀取。如果您有多個應用程式實例正在執行，且已將傳遞給 CheckpointStore 用戶端進行負載平衡，則這是預期情況。

CloseReason如果為 Shutdown ，表示 subscription.close() 已呼叫或發生錯誤。除非透過明確關閉 subscription.close() 訂閱，否則訂閱會嘗試繼續從資料分割的最後一個檢查點讀取事件。

processClose?: ProcessCloseHandler

屬性值

ProcessCloseHandler

processError

針對 EventHubConsumerClient 接收事件或執行任何傳遞至方法的使用者提供的函式時，所叫用的錯誤所叫用的 subscribe() 函式。

PartitionContext傳遞至此函式的會指出擲回錯誤時正在處理的分割區。如果從分割區 (處理事件之外擲回錯誤，例如無法執行負載平衡) ， partitionId 內容上的會是空字串。

用戶端完成執行此函式之後，就會叫用函 partitionClose 式。

processError: ProcessErrorHandler

屬性值

ProcessErrorHandler

processEvents

收到一組事件時所叫用 EventHubConsumerClient 的函式。 PartitionContext傳遞至此函式的可用來判斷要讀取的資料分割。

如果已將檢查點提供給用戶端) ，則 updateCheckpoint() 內容上的方法可用來更新 (中的 CheckpointStore 檢查點。請以頻繁的間隔來標記已處理的事件，讓用戶端可以在重新開機或錯誤復原時從這類檢查點重新開機。

注意：接收的事件可能是空陣列。如果中 maxWaitTimeInSeconds 沒有要接收的新事件，預設為 60 秒，就會發生這種情況。 maxWaitTimeInSeconds可以藉由將它設定為，將它 options 設定為 subscribe() 。

processEvents: ProcessEventsHandler

屬性值

ProcessEventsHandler

processInitialize

每次訂閱即將開始讀取資料分割時所 EventHubConsumerClient 叫用的函式。 PartitionContext傳遞至此函式的可用來判斷要讀取的資料分割。

只有在提供此函式) 時，用戶端才會開始接收資料分割的事件 (。因此，使用此函式來執行任何安裝工作，包括非同步工作。

processInitialize?: ProcessInitializeHandler

屬性值

ProcessInitializeHandler

共用方式為