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

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

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

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

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

DeviceDescriptionClient (void)

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

HandleIdentifyResponseFunct )(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) определение типа
void(*
Эта функция отвечает за обработку сообщений IdentityResponse.

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

AppState
void *
Объект состояния, определенный приложением.
ExchangeMgr
[ТОЛЬКО ДЛЯ ЧТЕНИЯ] Объект диспетчера обмена
FabricState
[ТОЛЬКО ДЛЯ ЧТЕНИЯ] Объект состояния структуры
OnIdentifyResponseReceived

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

CancelExchange (void)
Отмените выполняющийся обмен IdentifyRequest, ожидающий ответа.
Init ( WeaveExchangeManager *exchangeMgr)
Инициализируйте состояние клиента описания устройства.
SendIdentifyRequest (const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
Отправьте сообщение IdentifyRequest на определенный IP-адрес.
SendIdentifyRequest (const IdentifyRequestMessage & msg)
Отправьте широковещательное сообщение идентификацииRequest для обнаружения узлов Weave.
Shutdown (void)
Завершите работу клиента описания устройства.

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

HandleIdentifyResponseFunct 

void(* HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg)

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

Подробности
Параметры
[in] appState
Указатель на состояние, определенное приложением, установленное при создании контекста обмена IdentityRequest.
[in] nodeId
Идентификатор узла Weave источника сообщения.
[in] nodeAddr
IP-адрес отвечающего узла.
[in] msg
Ссылка на входящее сообщение IdentResponse.

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

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

void * AppState

Объект состояния, определенный приложением.

ExchangeMgr 

WeaveExchangeManager * ExchangeMgr

[ТОЛЬКО ДЛЯ ЧТЕНИЯ] Объект диспетчера обмена

Состояние Фабрики 

const WeaveFabricState * FabricState

[ТОЛЬКО ДЛЯ ЧТЕНИЯ] Объект состояния структуры

OnIdentifyResponseReceived 

HandleIdentifyResponseFunct OnIdentifyResponseReceived

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

ОтменаОбменять 

WEAVE_ERROR CancelExchange(
  void
)

Отмените выполняющийся обмен IdentifyRequest, ожидающий ответа.

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

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

 DeviceDescriptionClient(
  void
)

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

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Инициализируйте состояние клиента описания устройства.

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

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

Отправитьидентифифитерекуест 

WEAVE_ERROR SendIdentifyRequest(
  const IPAddress & nodeAddr,
  const IdentifyRequestMessage & msg
)

Отправьте сообщение IdentifyRequest на определенный IP-адрес.

Подробности
Параметры
[in] nodeAddr
Ссылка на IP-адрес узла Weave для запроса.
[in] msg
Ссылка на сообщение IdentifyRequest для отправки.
Возвращаемые значения
WEAVE_ERROR_NO_MEMORY
Если выделение контекста обмена буфера пакетов не удалось.
WEAVE_NO_ERROR
Об успехе.
other
Другие коды ошибок Weave или конкретной платформы, указывающие на то, что произошла ошибка, препятствующая отправке идентификацииRequest.

Отправитьидентифифитерекуест 

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

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

Подробности
Параметры
[in] msg
Ссылка на сообщение IdentifyRequest для отправки.

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

WEAVE_ERROR Shutdown(
  void
)

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

Эта функция закрывает любой активный контекст обмена и сбрасывает указатели. Объект можно использовать повторно, повторно вызвав метод Init .

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