SubscriptionEventHandlers interface
Interface que descreve as funções a implementar pelo utilizador que são invocadas pelo EventHubConsumerClient quando o subscribe() método é chamado para receber eventos do Hub de Eventos.
Propriedades
| process |
A função invocada sempre Se o Se for |
| process |
A função invocada por para erros que ocorrem ao receber eventos ou ao executar qualquer uma das funções fornecidas pelo A Depois de o cliente concluir a execução desta função, a |
| process |
A função invocada quando O Nota: é possível que os eventos recebidos sejam uma matriz vazia.
Isto pode acontecer se não existirem novos eventos a receber no |
| process |
A função invocada por O cliente começará a receber eventos para a partição apenas depois de concluir a execução desta função (se for fornecida). Por conseguinte, utilize esta função para realizar qualquer trabalho de configuração, incluindo tarefas assíncronas. |
Detalhes de Propriedade
processClose
A função invocada sempre EventHubConsumerClient que a subscrição deixa de ler eventos de uma partição. As informações sobre esta partição estarão disponíveis na PartitionContext função transmitida para a função processClose.
Se o CloseReason transmitido para esta função for OwnershipLost, outra subscrição assumiu a leitura da mesma partição com o mesmo grupo de consumidores. Isto é esperado se tiver várias instâncias da sua aplicação em execução e tiver passado o CheckpointStore para o cliente para o balanceamento de carga.
Se for CloseReasonShutdown, significa que subscription.close() foi chamado ou ocorreu um erro. A menos que a subscrição tenha sido explicitamente fechada através subscription.close()do , a subscrição tentará retomar a leitura de eventos do último ponto de verificação da partição.
processClose?: ProcessCloseHandlerValor de Propriedade
processError
A função invocada por para erros que ocorrem ao receber eventos ou ao executar qualquer uma das funções fornecidas pelo EventHubConsumerClient utilizador passou para o subscribe() método .
A PartitionContext passagem para esta função indicará a partição que estava a ser processada quando o erro foi gerado. Nos casos em que um erro é emitido fora do processamento de eventos de uma partição (por exemplo, falha ao executar o balanceamento de carga), o partitionId no contexto será uma cadeia vazia.
Depois de o cliente concluir a execução desta função, a partitionClose função é invocada.
processError: ProcessErrorHandlerValor de Propriedade
processEvents
A função invocada quando EventHubConsumerClient é recebido um conjunto de eventos. A PartitionContext função transmitida para esta função pode ser utilizada para determinar a partir da qual a partição está a ser lida.
O updateCheckpoint() método no contexto pode ser utilizado para atualizar pontos de verificação no CheckpointStore (se tiver sido fornecido um ao cliente). Utilize-o em intervalos frequentes para marcar eventos que foram processados para que o cliente possa reiniciar a partir desses pontos de verificação em caso de reinício ou recuperação de erros.
Nota: é possível que os eventos recebidos sejam uma matriz vazia.
Isto pode acontecer se não existirem novos eventos a receber no maxWaitTimeInSeconds, que é predefinido para 60 segundos.
O maxWaitTimeInSeconds pode ser alterado ao defini-lo na options passagem para subscribe().
processEvents: ProcessEventsHandlerValor de Propriedade
processInitialize
A função invocada por EventHubConsumerClient cada vez que a subscrição está prestes a começar a ler a partir de uma partição. A PartitionContext função transmitida para esta função pode ser utilizada para determinar a partir da qual a partição está prestes a ser lida.
O cliente começará a receber eventos para a partição apenas depois de concluir a execução desta função (se for fornecida). Por conseguinte, utilize esta função para realizar qualquer trabalho de configuração, incluindo tarefas assíncronas.
processInitialize?: ProcessInitializeHandler