нл:: Переплетение:: Профили:: Описание устройства:: УстройствоОписаниеСервер

#include <src/lib/profiles/device-description/DeviceDescription.h>

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

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

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

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

Конструкторы и деструкторы

DeviceDescriptionServer (void)

Публичные типы

HandleIdentifyRequestFunct )(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyRequestMessage &reqMsg, bool &sendResp, IdentifyResponseMessage &respMsg) определение типа
void(*

Публичные атрибуты

AppState
void *
Определенный приложением указатель состояния для предоставления контекста для обратных вызовов.
OnIdentifyRequestReceived
HandleIdentifyRequestFunct
Эта функция отвечает за обработку сообщений IdentityRequest.

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

Init ( WeaveExchangeManager *exchangeMgr)
Инициализируйте состояние сервера описания устройства и зарегистрируйтесь для получения сообщений с описанием устройства.
Shutdown (void)
Завершите работу сервера описания устройств.

Публичные типы

HandleIdentifyRequestFunct 

void(* HandleIdentifyRequestFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyRequestMessage &reqMsg, bool &sendResp, IdentifyResponseMessage &respMsg)

Публичные атрибуты

состояние приложения

void * AppState

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

OnIdentifyRequestReceived

HandleIdentifyRequestFunct OnIdentifyRequestReceived

Эта функция отвечает за обработку сообщений IdentityRequest.

Подробности
Параметры
[in] appState
Указатель на состояние, определенное приложением, установленное при регистрации для получения сообщений этого типа.
[in] nodeId
Идентификатор узла Weave источника сообщения.
[in] nodeAddr
IP-адрес источника сообщения.
[in] reqMsg
Ссылка на входящее сообщение идентификацииRequest.
[out] sendResp
Ссылка на логическое значение, которому должно быть присвоено значение true, если инициатору должно быть отправлено ответное сообщение.
[out] respMsg
Ссылка на сообщение идентификацииответа, которое будет отправлено инициатору.

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

УстройствоОписаниеСервер 

 DeviceDescriptionServer(
  void
)

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

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Инициализируйте состояние сервера описания устройства и зарегистрируйтесь для получения сообщений с описанием устройства.

param[in] ExchangeMgr Указатель на менеджер обмена Weave.

Подробности
Возвращаемые значения
WEAVE_ERROR_INCORRECT_STATE
Когда удаленный пассивный сервер рандеву уже зарегистрирован.
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Когда зарегистрировано слишком много обработчиков нежелательных сообщений.
WEAVE_NO_ERROR
Об успехе.

Неисправность

WEAVE_ERROR Shutdown(
  void
)

Завершите работу сервера описания устройств.

Подробности
Возвращаемые значения
WEAVE_NO_ERROR
безоговорочно.