EventProcessorHostOptions interface

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

Extends

Свойства

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 содержит EntityPath=hub-name, в противном случае будет выдано сообщение Об ошибке.

fastScanInterval

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

initialOffset

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

leaseDuration

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

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

leaseRenewInterval

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

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

Если 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

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

eventHubConnectionString

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

eventHubConnectionString?: string

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

string

leaseManager

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

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

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

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

eventHubPath

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

eventHubPath?: string

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

string

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

fastScanInterval

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

fastScanInterval?: number

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

number

Наследуется отFromConnectionStringOptions.fastScanInterval

initialOffset

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

initialOffset?: EventPosition

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

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

leaseDuration

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

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

leaseDuration?: number

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

number

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

leaseRenewInterval

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

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

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

leaseRenewInterval?: number

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

number

Наследуется отFromConnectionStringOptions.leaseRenewInterval

onEphError

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

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

onEphError?: OnEphError

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

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

slowScanInterval

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

slowScanInterval?: number

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

number

Наследуется отFromConnectionStringOptions.slowScanInterval

startupScanDelay

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

startupScanDelay?: number

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

number

НаследуетсяотConnectionStringOptions.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