Эта страница переведена с помощью Cloud Translation API.

нл:: Переплетение:: Профили:: Девайсконтрол:: Девицеконтролделегат

Это абстрактный класс.

#include <src/lib/profiles/device-control/DeviceControl.h>

Класс делегата для реализации входящих операций управления устройствами на серверном устройстве.

Краткое содержание

Наследование

Наследуется от: nl::Weave::WeaveServerDelegateBase
Прямые известные подклассы: nl::Weave::DeviceLayer::Internal::DeviceControlServer

Общественные функции
`EnforceAccessControl ( ExchangeContext ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo msgInfo, AccessControlResult & result)`	`virtual void` Обеспечьте контроль доступа на уровне сообщений для входящего сообщения запроса DeviceControl .
`IsPairedToAccount () const`	`virtual bool` Вызывается, чтобы определить, подключено ли устройство к учетной записи в данный момент.
`IsResetAllowed (uint16_t resetFlags)=0`	`virtual bool` Проверьте, разрешен ли сброс указанной конфигурации.
`OnConnectionMonitorTimeout (uint64_t peerNodeId, IPAddress peerAddr)=0`	`virtual void` Укажите, что истек тайм-аут монитора подключения.
`OnFailSafeArmed (void)=0`	`virtual WEAVE_ERROR` Укажите, что отказоустойчивая конфигурация устройства поставлена на охрану.
`OnFailSafeDisarmed (void)=0`	`virtual WEAVE_ERROR` Указывает, что отказоустойчивая конфигурация устройства снята с охраны.
`OnRemotePassiveRendezvousDone (void)=0`	`virtual void` Указывает, что процесс удаленного пассивного рандеву завершен.
`OnRemotePassiveRendezvousStarted (void)=0`	`virtual void` Указывает, что начался процесс удаленного пассивного рандеву.
`OnResetConfig (uint16_t resetFlags)=0`	`virtual WEAVE_ERROR` Сбросьте всю или часть конфигурации устройства.
`OnSystemTestStarted (uint32_t profileId, uint32_t testId)=0`	`virtual WEAVE_ERROR` Запустите указанный тест системы.
`OnSystemTestStopped (void)=0`	`virtual WEAVE_ERROR` Остановите текущий тест системы.
`ShouldCloseConBeforeResetConfig (uint16_t resetFlags)=0`	`virtual bool` Определите, следует ли закрыть соединение с сервером, если оно имеется, перед сбросом конфигурации.
`WillCloseRemotePassiveRendezvous (void)=0`	`virtual void` Приготовьтесь остановить удаленное пассивное рандеву.
`WillStartRemotePassiveRendezvous (void)=0`	`virtual WEAVE_ERROR` Подготовьтесь к удаленному пассивному свиданию.

Общественные функции

EnforceAccessControl

virtual void EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  AccessControlResult & result
)

Обеспечьте контроль доступа на уровне сообщений для входящего сообщения запроса DeviceControl .

Подробности

Параметры

`[in] ec`	ExchangeContext , через который было получено сообщение.
`[in] msgProfileId`	Идентификатор профиля полученного сообщения.
`[in] msgType`	Тип полученного сообщения.
`[in] msgInfo`	Структура WeaveMessageInfo , содержащая информацию о полученном сообщении.
`[in,out] result`	Перечисляемое значение, описывающее результат оценки политики управления доступом для полученного сообщения. При входе в метод значение представляет собой предварительный результат на текущем этапе процесса оценки. Ожидается, что по возвращении результат будет представлять собой окончательную оценку политики управления доступом для сообщения.

Испайредтоаккаунт

virtual bool IsPairedToAccount() const

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

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
)=0

Проверьте, разрешен ли сброс указанной конфигурации.

Подробности

Параметры

[in] resetFlags

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

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

`TRUE`	разрешен ли сброс конфигурации.
`FALSE`	если сброс конфигурации не разрешен.

Онконнектионмонитортаймаут

virtual void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
)=0

Укажите, что истек тайм-аут монитора подключения.

Эта функция вызывается, когда произошел тайм-аут Connection Monitor, то есть когда проверки работоспособности не были обнаружены с удаленного хоста в течение определенного периода времени.

Подробности

Параметры

`[in] peerNodeId`	Идентификатор узла удаленного узла, к которому истекло время существования соединения.
`[in] peerAddr`	Адрес удаленного узла.

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
)=0

Укажите, что отказоустойчивая конфигурация устройства поставлена на охрану.

Эта функция вызывается, когда отказоустойчивая конфигурация серверного устройства поставлена на охрану в ответ на запрос клиента. Функция отказоустойчивости автоматически сбрасывает конфигурацию устройства в известное состояние, если процесс настройки не завершится успешно.

Подробности

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

`WEAVE_NO_ERROR`	Об успехе.
`other`	Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, препятствующая включению отказоустойчивого устройства на охрану.

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
)=0

Указывает, что отказоустойчивая конфигурация устройства снята с охраны.

Эта функция вызывается, когда отказоустойчивая конфигурация серверного устройства снята с охраны в ответ на запрос клиента. Клиент отключит отказоустойчивую систему после завершения настройки.

Подробности

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

`WEAVE_NO_ERROR`	Об успехе.
`other`	Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, препятствующая снятию с охраны отказоустойчивого устройства.

На Удаленном Пассивном Рандеву Готово

virtual void OnRemotePassiveRendezvousDone(
  void
)=0

Указывает, что процесс удаленного пассивного рандеву завершен.

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
)=0

Указывает, что начался процесс удаленного пассивного рандеву.

Онресетконфиг

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
)=0

Сбросьте всю или часть конфигурации устройства.

Ожидается, что реализация этой функции приведет к сбросу любой комбинации конфигураций сети, Weave Fabric или службы в известное состояние в соответствии с флагами сброса.

Подробности

Параметры

[in] resetFlags

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

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

`WEAVE_NO_ERROR`	Об успехе.
`other`	Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, не позволяющая устройству сбросить конфигурацию.

Онсистемтестстартед

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
)=0

Запустите указанный тест системы.

Подробности

Параметры

`[in] profileId`	Идентификатор профиля запрошенного теста.
`[in] testId`	Идентификатор запрошенного теста.

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

`WEAVE_NO_ERROR`	Об успехе.
`other`	Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, препятствующая запуску системного теста.

ОнСистемТестСтоппед

virtual WEAVE_ERROR OnSystemTestStopped(
  void
)=0

Остановите текущий тест системы.

Подробности

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

`WEAVE_NO_ERROR`	Об успехе.
`other`	Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, препятствующая остановке системного теста.

ДолженКлосеКонБефорересетконфиг

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
)=0

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

Эта функция используется для запроса делегата о желаемом поведении при обработке запроса на сброс конфигурации. Если соединение с сервером в данный момент активно, ответ TRUE на этот метод приведет к закрытию этого соединения до запуска сброса конфигурации с помощью метода OnResetConfig.

Подробности

Параметры

[in] resetFlags

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

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

`true`	если соединение необходимо закрыть.
`false`	если соединение не нужно закрывать.

БудетЗакрытьУдаленныйПассивныйРандеву

virtual void WillCloseRemotePassiveRendezvous(
  void
)=0

Приготовьтесь остановить удаленное пассивное рандеву.

См. также:
WillStartRemotePassiveRendezvous(void)

БудетСтартУдаленныйПассивныйРандеву

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
)=0

Подготовьтесь к удаленному пассивному свиданию.

Например, сделайте доступной для присоединения сеть 15.4/Thread.

Подробности

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

`WEAVE_NO_ERROR`	Об успехе.
`other`	Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка при подготовке к запуску удаленного пассивного рандеву.