нл:: Переплетение:: Уровень устройства:: Внутренний:: Девицеконтролсервер

#include <src/adaptations/device-layer/include/Weave/DeviceLayer/internal/DeviceControlServer.h>

Реализует профиль управления устройствами Weave для устройства Weave.

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

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

Наследуется от:
  nl::Weave::Profiles::DeviceControl::DeviceControlServer
  nl::Weave::Profiles::DeviceControl::DeviceControlDelegate

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

Init ()
IsPairedToAccount () const override
virtual bool
Вызывается, чтобы определить, подключено ли устройство к учетной записи в данный момент.
IsResetAllowed (uint16_t resetFlags) override
virtual bool
Проверьте, разрешен ли сброс указанной конфигурации.
OnConnectionMonitorTimeout (uint64_t peerNodeId, IPAddress peerAddr) override
void
OnFailSafeArmed (void) override
virtual WEAVE_ERROR
Укажите, что отказоустойчивая конфигурация устройства поставлена ​​на охрану.
OnFailSafeDisarmed (void) override
virtual WEAVE_ERROR
Указывает, что отказоустойчивая конфигурация устройства снята с охраны.
OnPlatformEvent (const WeaveDeviceEvent *event)
void
OnRemotePassiveRendezvousDone (void) override
virtual void
Указывает, что процесс удаленного пассивного рандеву завершен.
OnRemotePassiveRendezvousStarted (void) override
virtual void
Указывает, что начался процесс удаленного пассивного рандеву.
OnResetConfig (uint16_t resetFlags) override
virtual WEAVE_ERROR
Сбросьте всю или часть конфигурации устройства.
OnSystemTestStarted (uint32_t profileId, uint32_t testId) override
virtual WEAVE_ERROR
Запустите указанный тест системы.
OnSystemTestStopped (void) override
virtual WEAVE_ERROR
Остановите текущий тест системы.
ShouldCloseConBeforeResetConfig (uint16_t resetFlags) override
virtual bool
Определите, следует ли закрыть соединение с сервером, если оно имеется, перед сбросом конфигурации.
WillCloseRemotePassiveRendezvous (void) override
virtual void
Приготовьтесь остановить удаленное пассивное рандеву.
WillStartRemotePassiveRendezvous (void) override
virtual WEAVE_ERROR
Подготовьтесь к удаленному пассивному свиданию.

Защищенные функции

DeviceControlServer ()=default
DeviceControlServer (const DeviceControlServer &)=delete
DeviceControlServer (const DeviceControlServer &&)=delete
operator= (const DeviceControlServer &)=delete
~DeviceControlServer ()=default

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

Инициализировать

WEAVE_ERROR Init()

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

virtual bool IsPairedToAccount() const override

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

IsResetAllowed

virtual bool IsResetAllowed(
  uint16_t resetFlags
) override

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

Подробности
Параметры
[in] resetFlags
Флаги, определяющие, какую конфигурацию сбрасывать.
Возвращаемые значения
TRUE
разрешен ли сброс конфигурации.
FALSE
если сброс конфигурации не разрешен.

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

void OnConnectionMonitorTimeout(
  uint64_t peerNodeId,
  IPAddress peerAddr
) override

OnFailSafeArmed

virtual WEAVE_ERROR OnFailSafeArmed(
  void
) override

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

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

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

OnFailSafeDisarmed

virtual WEAVE_ERROR OnFailSafeDisarmed(
  void
) override

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

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

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

Онплатформевент

void OnPlatformEvent(
  const WeaveDeviceEvent *event
)

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

virtual void OnRemotePassiveRendezvousDone(
  void
) override

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

OnRemotePassiveRendezvousStarted

virtual void OnRemotePassiveRendezvousStarted(
  void
) override

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

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

virtual WEAVE_ERROR OnResetConfig(
  uint16_t resetFlags
) override

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

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

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

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

virtual WEAVE_ERROR OnSystemTestStarted(
  uint32_t profileId,
  uint32_t testId
) override

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

Подробности
Параметры
[in] profileId
Идентификатор профиля запрошенного теста.
[in] testId
Идентификатор запрошенного теста.
Возвращаемые значения
WEAVE_NO_ERROR
Об успехе.
other
Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, препятствующая запуску системного теста.

OnSystemTestStopped

virtual WEAVE_ERROR OnSystemTestStopped(
  void
) override

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

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

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

virtual bool ShouldCloseConBeforeResetConfig(
  uint16_t resetFlags
) override

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

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

Подробности
Параметры
[in] resetFlags
Флаги, определяющие, какую конфигурацию сбрасывать.
Возвращаемые значения
true
если соединение необходимо закрыть.
false
если соединение не нужно закрывать.

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

virtual void WillCloseRemotePassiveRendezvous(
  void
) override

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

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

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

virtual WEAVE_ERROR WillStartRemotePassiveRendezvous(
  void
) override

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

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

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

Защищенные функции

Девицеконтролсервер

 DeviceControlServer()=default

Девицеконтролсервер

 DeviceControlServer(
  const DeviceControlServer &
)=delete

Девицеконтролсервер

 DeviceControlServer(
  const DeviceControlServer &&
)=delete

оператор=

DeviceControlServer & operator=(
  const DeviceControlServer &
)=delete

~DeviceControlServer

 ~DeviceControlServer()=default