Поделиться через

EventProcessorHostOptions interface

  • Ссылка
Пакет:
@azure/event-processor-host

Описывает необязательные параметры, которые можно указать для создания EventProcessorHost.

Extends
FromConnectionStringOptions

Свойства

checkpointManager

Менеджер для управления контрольными точками. По умолчанию: AzureStorageCheckpointLeaseManager.
eventHubConnectionString

Строка подключения для концентратора событий, от которую требуется получить. Пример: "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/; SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key".
leaseManager

Менеджер по управлению арендами. По умолчанию: AzureStorageCheckpointLeaseManager.
storageConnectionString

Строка подключения к учетной записи хранения Azure, используемая для аренды и контрольных точек. Пример DefaultEndpointsProtocol=https; AccountName=; AccountKey=; EndpointSuffix=core.windows.net"
storageContainerName

Имя контейнера службы хранилища Azure для использования встроенным диспетчером аренды и контрольных точек.
tokenProvider

Экземпляр интерфейса поставщика маркеров, предоставляющего маркер для проверки подлинности. Значение по умолчанию: SasTokenProvider.

Унаследованные свойства

consumerGroup

Имя группы потребителей в Концентраторе событий. Значение по умолчанию: "$default".
dataTransformer

Преобразователь данных, который будет использоваться для кодирования и декодирования отправленных и полученных сообщений соответственно. Если это не указано, мы будем использовать DefaultDataTransformer. Преобразователь по умолчанию должен обрабатывать большинство случаев. Этот параметр необходимо использовать только для специализированных сценариев.
eventHubPath

Имя EventHub. Это необязательно, если строка подключения EventHub содержит EntityPath=hub-name, кроме того, будет возникать ошибка.
fastScanInterval

Существует два возможных интервала между сканированием доступных секций, быстро и медленно. Быстрый (короткий) интервал in seconds используется после сканирования, в котором произошла кража аренды, для повышения более быстрого перебалансирования. По умолчанию: 3 секунды.
initialOffset

Это используется только в том случае, если получатель создается в первый раз, и данные контрольной точки в большом двоичном объекте отсутствуют. Чтобы этот параметр был эффективным, обязательно укажите новое имя узла, которое ранее не использовалось.
leaseDuration

Срок аренды in seconds до истечения срока его действия, если срок действия не будет продлен. По умолчанию: 30 секунд, минимальное значение: 15 секунд, максимальное значение: 60 секунд.

Если Leasemanager предоставляется при создании EventProcessorHost, это значение будет игнорироваться.
leaseRenewInterval

Интервал сна in seconds между сканированиями. По умолчанию: 10 секунды.

Позволяет реализации диспетчера аренды указать СекционManager, как часто он должен сканировать аренды и обновлять их. Для своевременного распространения аренды после прекращения работы узла рекомендуется относительно короткий интервал, например десять секунд. Очевидно, что это должно быть менее половины длины аренды, чтобы предотвратить случайное истечение срока действия.

Если Leasemanager предоставляется при создании EventProcessorHost, это значение будет игнорироваться.
onEphError

Обработчик ошибок, который можно предоставить для получения уведомления об общих ошибках.

Ошибки, возникающие при обработке событий из определенного раздела EventHub, доставляются обработчику onError, предоставленному в методе start(). Этот обработчик вызывается в случаях, когда возникает ошибка при управлении секциями или арендой для секций.
slowScanInterval

Медленный (длинный) интервал in seconds используется после сканирования, в котором кража аренды не произошла, чтобы уменьшить ненужные проверки, когда система находится в устойчивом состоянии. По умолчанию: 5 секунды.
startupScanDelay

Время задержки in seconds между первой проверкой доступных секций и второй. Это часть оптимизации запуска, которая позволяет отдельным узлам становиться видимыми для других узлов, и таким образом получить более точное количество узлов в системе, прежде чем попытаться оценить, сколько секций они должны принадлежать. По умолчанию: 30 секунды.
storageBlobPrefix

Префикс, используемый при именовании BLOB-объектов в контейнере хранилища.
userAgent

Агент пользователя, который необходимо добавить к встроенной строке агента пользователя.
webSocket

Конструктор WebSocket, используемый для создания подключения AMQP через WebSocket. Этот параметр следует указать в следующих сценариях.

  • TCP-порт 5671, который используется подключением AMQP к Центрам событий, заблокирован в вашей среде.
  • Приложение должно выполняться за прокси-сервером.
  • Приложение должно выполняться в браузере, и вы хотите предоставить собственный выбор реализации Websocket вместо встроенного WebSocket в браузере.
webSocketConstructorOptions

Параметры, передаваемые конструктору WebSocket

Сведения о свойстве

checkpointManager

Менеджер для управления контрольными точками. По умолчанию: AzureStorageCheckpointLeaseManager.

checkpointManager?: CheckpointManager

Значение свойства

CheckpointManager

eventHubConnectionString

Строка подключения для концентратора событий, от которую требуется получить. Пример: "Endpoint=sb://my-servicebus-namespace.servicebus.windows.net/; SharedAccessKeyName=my-SA-name; SharedAccessKey=my-SA-key".

eventHubConnectionString?: string

Значение свойства

string

leaseManager

Менеджер по управлению арендами. По умолчанию: AzureStorageCheckpointLeaseManager.

leaseManager?: LeaseManager

Значение свойства

LeaseManager

storageConnectionString

Строка подключения к учетной записи хранения Azure, используемая для аренды и контрольных точек. Пример DefaultEndpointsProtocol=https; AccountName=; AccountKey=; EndpointSuffix=core.windows.net"

storageConnectionString?: string

Значение свойства

string

storageContainerName

Имя контейнера службы хранилища Azure для использования встроенным диспетчером аренды и контрольных точек.

storageContainerName?: string

Значение свойства

string

tokenProvider

Экземпляр интерфейса поставщика маркеров, предоставляющего маркер для проверки подлинности. Значение по умолчанию: SasTokenProvider.

tokenProvider?: TokenProvider

Значение свойства

TokenProvider

Сведения об унаследованном свойстве

consumerGroup

Имя группы потребителей в Концентраторе событий. Значение по умолчанию: "$default".

consumerGroup?: string

Значение свойства

string

наследуется отFromConnectionStringOptions.consumerGroup

dataTransformer

Преобразователь данных, который будет использоваться для кодирования и декодирования отправленных и полученных сообщений соответственно. Если это не указано, мы будем использовать DefaultDataTransformer. Преобразователь по умолчанию должен обрабатывать большинство случаев. Этот параметр необходимо использовать только для специализированных сценариев.

dataTransformer?: DataTransformer

Значение свойства

DataTransformer

наследуется отFromConnectionStringOptions.dataTransformer

eventHubPath

Имя EventHub. Это необязательно, если строка подключения EventHub содержит EntityPath=hub-name, кроме того, будет возникать ошибка.

eventHubPath?: string

Значение свойства

string

наследуется отFromConnectionStringOptions.eventHubPath

fastScanInterval

Существует два возможных интервала между сканированием доступных секций, быстро и медленно. Быстрый (короткий) интервал in seconds используется после сканирования, в котором произошла кража аренды, для повышения более быстрого перебалансирования. По умолчанию: 3 секунды.

fastScanInterval?: number

Значение свойства

number

унаследован отFromConnectionStringOptions.fastScanInterval

initialOffset

Это используется только в том случае, если получатель создается в первый раз, и данные контрольной точки в большом двоичном объекте отсутствуют. Чтобы этот параметр был эффективным, обязательно укажите новое имя узла, которое ранее не использовалось.

initialOffset?: EventPosition

Значение свойства

EventPosition

наследуется отFromConnectionStringOptions.initialOffset

leaseDuration

Срок аренды in seconds до истечения срока его действия, если срок действия не будет продлен. По умолчанию: 30 секунд, минимальное значение: 15 секунд, максимальное значение: 60 секунд.

Если Leasemanager предоставляется при создании EventProcessorHost, это значение будет игнорироваться.

leaseDuration?: number

Значение свойства

number

наследуется отFromConnectionStringOptions.leaseDuration

leaseRenewInterval

Интервал сна in seconds между сканированиями. По умолчанию: 10 секунды.

Позволяет реализации диспетчера аренды указать СекционManager, как часто он должен сканировать аренды и обновлять их. Для своевременного распространения аренды после прекращения работы узла рекомендуется относительно короткий интервал, например десять секунд. Очевидно, что это должно быть менее половины длины аренды, чтобы предотвратить случайное истечение срока действия.

Если Leasemanager предоставляется при создании EventProcessorHost, это значение будет игнорироваться.

leaseRenewInterval?: number

Значение свойства

number

унаследован отFromConnectionStringOptions.leaseRenewInterval

onEphError

Обработчик ошибок, который можно предоставить для получения уведомления об общих ошибках.

Ошибки, возникающие при обработке событий из определенного раздела EventHub, доставляются обработчику onError, предоставленному в методе start(). Этот обработчик вызывается в случаях, когда возникает ошибка при управлении секциями или арендой для секций.

onEphError?: OnEphError

Значение свойства

OnEphError

наследуется отFromConnectionStringOptions.onEphError

slowScanInterval

Медленный (длинный) интервал in seconds используется после сканирования, в котором кража аренды не произошла, чтобы уменьшить ненужные проверки, когда система находится в устойчивом состоянии. По умолчанию: 5 секунды.

slowScanInterval?: number

Значение свойства

number

унаследовано отFromConnectionStringOptions.slowScanInterval

startupScanDelay

Время задержки in seconds между первой проверкой доступных секций и второй. Это часть оптимизации запуска, которая позволяет отдельным узлам становиться видимыми для других узлов, и таким образом получить более точное количество узлов в системе, прежде чем попытаться оценить, сколько секций они должны принадлежать. По умолчанию: 30 секунды.

startupScanDelay?: number

Значение свойства

number

Унаследовано отFromConnectionStringOptions.startupScanDelay

storageBlobPrefix

Префикс, используемый при именовании BLOB-объектов в контейнере хранилища.

storageBlobPrefix?: string

Значение свойства

string

наследуется отFromConnectionStringOptions.storageBlobPrefix

userAgent

Агент пользователя, который необходимо добавить к встроенной строке агента пользователя.

userAgent?: string

Значение свойства

string

наследуется отFromConnectionStringOptions.userAgent

webSocket

Конструктор WebSocket, используемый для создания подключения AMQP через WebSocket. Этот параметр следует указать в следующих сценариях.

  • TCP-порт 5671, который используется подключением AMQP к Центрам событий, заблокирован в вашей среде.
  • Приложение должно выполняться за прокси-сервером.
  • Приложение должно выполняться в браузере, и вы хотите предоставить собственный выбор реализации Websocket вместо встроенного WebSocket в браузере.
webSocket?: WebSocketImpl

Значение свойства

WebSocketImpl

наследуется отFromConnectionStringOptions.webSocket

webSocketConstructorOptions

Параметры, передаваемые конструктору WebSocket

webSocketConstructorOptions?: any

Значение свойства

any

унаследован отFromConnectionStringOptions.webSocketConstructorOptions