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


azure-iot-common package

Классы

Message

Объект Message используется для асинхронной передачи сообщений телеметрии (устройства в облако) и асинхронного обмена сообщениями между устройством и службой Центра Интернета вещей. Это не зависит от транспорта, что означает, что он работает так же, как AMQP, MQTT и HTTP.

ArgumentError

Ошибка, возникаемая при недопустимом аргументе.

ArgumentOutOfRangeError

Ошибка возникает, когда аргумент имеет значение, которое выходит за пределы допустимого диапазона.

BadDeviceResponseError

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

CloudToDeviceDetachedError

Ошибка, возникающая, когда функция c2d перестала работать на уровне транспорта, требуя от клиента повторного запуска.

DeviceAlreadyExistsError

Возникает ошибка, когда идентификатор устройства, используемый для создания устройства, уже существует в реестре удостоверений устройств.

DeviceMaximumQueueDepthExceededError

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

DeviceMessageLockLostError

Ошибка, возникавшая при урегулировании сообщения, завершается ошибкой, так как маркер блокировки, связанный с сообщением, теряется.

DeviceMethodsDetachedError

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

DeviceNotFoundError

Возникает ошибка, когда устройство не удается найти в реестре экземпляров Центра Интернета вещей.

DeviceRegistrationFailedError

Ошибка, возникаемая при сбое операции регистрации DPS

DeviceTimeoutError

Ошибка, возникаемая при том, что устройство не обрабатывает вызов метода вовремя.

FormatError

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

GatewayTimeoutError

Ошибка, возникаемая, когда экземпляр Центра Интернета вещей не обрабатывает вызов метода устройства вовремя.

InternalServerError

Ошибка, возникавшая при возникновении внутренней ошибки сервера. Возможно, вы нашли ошибку?

InvalidEtagError

Ошибка, возникаемая при неправильном форматировании или истечении срока действия eTag.

InvalidOperationError

Ошибка, возникаемая при попытке операции, но не допускается.

IotHubNotFoundError

Ошибка, возникаемая при обнаружении центра Интернета вещей Azure.

IotHubQuotaExceededError

Ошибка, возникаемая при превышении квоты Центра Интернета вещей Azure. Квоты периодически сбрасываются, эта операция придется ждать до тех пор. Дополнительные сведения о квотах см. в статье квоты Центра Интернета вещей Azure и регулирование

IoTHubSuspendedError

Ошибка, возникаемая при приостановке Центра Интернета вещей.

JobNotFoundError

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

MessageTooLargeError

Ошибка, возникаемая при слишком большом размере сообщения: максимальный размер составляет 256 КБ.

NotConnectedError

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

NotImplementedError

Ошибка возникает, когда функция еще не реализована, но заполнитель присутствует.

OperationCancelledError

Ошибка, возникаемая при отмене любой операции (локальной или удаленной)

PreconditionFailedError

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

SecurityDeviceError

Ошибка, возникаемая при сбое устройства или драйвера с низким уровнем безопасности.

ServiceUnavailableError

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

ThrottlingError

Ошибка, возникаемая при регулировании Центра Интернета вещей из-за чрезмерной активности. Дополнительные сведения о квотах см. в статье квоты Центра Интернета вещей Azure и регулирование

TimeoutError

Ошибка, возникаемая при истечении времени ожидания

TooManyDevicesError

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

TwinDetachedError

Ошибка, возникающая, когда функция двойника перестала работать на уровне транспорта, требуя от клиента повторного запуска.

TwinRequestError

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

UnauthorizedError

Ошибка, возникаемая при неправильном изменении параметров подключения, и сервер отказался от подключения.

Connected

Результат возвращается при успешном подключении транспорта.

Disconnected

Результат возвращается при успешном отключении транспорта.

MessageAbandoned

Результат возвращается при успешном отказе сообщения.

MessageCompleted

Результат возвращается при успешном отклонении сообщения.

MessageEnqueued

Результат возвращается при успешном выполнении запроса сообщения.

MessageRejected

Результат возвращается при успешном отклонении сообщения.

SharedAccessSignatureUpdated

Результат возвращается при успешном обновлении маркера SAS.

TransportConfigured

Результат возвращается при успешной настройке транспорта.

ConnectionString

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

ExponentialBackOffWithJitter

Реализует экспоненциальную обратную передачу с помощью стратегии повторных попыток Jitter. Функция для вычисления следующего интервала является следующей (x — это повторная попытка xth): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)

NoRetry

Политика заглушки, блокирующая любые предварительные попытки. Операции не выполняются.

RetryOperation

Реализует необходимую логику для повторных операций, таких как подключение, получение сообщений C2D, отправка данных телеметрии, обновления двойников и т. д.

SharedAccessSignature

Маркеры подписи общего доступа используются для проверки подлинности подключения при использовании симметричного ключа (в отличие от сертификатов x509) для защиты подключения к Центру Интернета вещей Azure.

Интерфейсы

AuthenticationProvider

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

Receiver
RetryPolicy

Интерфейс, описывающий объект политики повторных попыток. Политики повторных попыток состоят из 2 вещей

  • Алгоритм, вычисляющий следующий раз повтора на основе текущего числа или повторных попыток.
  • Фильтр ошибок, который определяет тип полученной ошибки, независимо от того, должна ли происходить повторная попытка.

Эти 2 компонента скрываются за 2 вызовами методов, описанными в этом интерфейсе.

TransportConfig

Структура конфигурации, используемая транспортом и AuthenticationProvider объектами для хранения и обмена учетными данными.

X509

Объект, используемый для хранения сертификата X509 и ключа для использования транспорта.

Это передается непосредственно к объектам низкого уровня, используемым Node.js для подключения сокета TLS. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback

Псевдонимы типа

BufferConvertible
ResultWithHttpResponse
Callback

Определяет тип, описывающий регулярный обратный вызов с двумя результатами — ошибка, другая — это значение результата.

DoubleValueCallback

Определяет тип, описывающий обратный вызов с двумя результатами.

ErrorCallback

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

HttpResponseCallback

Определяет тип, описывающий обратный вызов с тремя результатами — ответом, необработанным HTTP-ответом и ошибкой.

NoErrorCallback

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

TripleValueCallback

Определяет тип, описывающий регулярный обратный вызов с тремя результатами — первый — Error, остальные два — это значения результатов.

Перечисления

AuthenticationType

Укажите тип проверки подлинности, используемый AuthenticationProvider.

Функции

anHourFromNow()

Возвращает секунды, прошедшие с 1 января 1970 г. 00:00:00 UTC до одного часа.

encodeUriComponentStrict(string)

Сведения о функции

anHourFromNow()

Возвращает секунды, прошедшие с 1 января 1970 г. 00:00:00 UTC до одного часа.

function anHourFromNow(): number

Возвращаемое значение

number

encodeUriComponentStrict(string)

function encodeUriComponentStrict(str: string): string

Параметры

str

string

Возвращаемое значение

string