nl::Weave::Profiles::DeviceDescription::DeviceDescriptionClient

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

기기 설명 요청을 실행하기 위한 클라이언트 객체입니다.

요약

생성자 및 소멸자
DeviceDescriptionClient(void)

공개 유형
HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) typedef
void(*
이 함수는 IdentityResponse 메시지를 처리합니다.

공개 속성
AppState
void *
애플리케이션에서 정의한 상태 객체입니다.
ExchangeMgr
[읽기 전용] Exchange 관리자 객체
FabricState
[읽기 전용] Fabric 상태 객체
OnIdentifyResponseReceived

공개 함수
CancelExchange(void)
응답 대기 중인 진행 중인 ConfirmRequest 교환을 취소합니다.
Init(WeaveExchangeManager *exchangeMgr)
기기 설명 클라이언트 상태를 초기화합니다.
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
특정 IP 주소로 IdentityRequest 메시지를 전송합니다.
SendIdentifyRequest(const IdentifyRequestMessage & msg)
브로드캐스트 IdentityRequest 메시지를 보내 Weave 노드를 탐색합니다.
Shutdown(void)
기기 설명 클라이언트를 종료합니다.

공개 유형

HandleIdentifyResponseFunct

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

이 함수는 IdentityResponse 메시지를 처리합니다.

세부정보
매개변수
[in] appState
IdentityRequest Exchange Context를 만들 때 설정된 애플리케이션 정의 상태에 대한 포인터입니다.
[in] nodeId
메시지 소스의 Weave 노드 ID입니다.
[in] nodeAddr
응답 노드의 IP 주소입니다.
[in] msg
수신되는 VerifyResponse 메시지에 대한 참조입니다.

공개 속성

AppState

void * AppState

애플리케이션에서 정의한 상태 객체입니다.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[읽기 전용] Exchange 관리자 객체

FabricState

const WeaveFabricState * FabricState

[읽기 전용] Fabric 상태 객체

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

공개 함수

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

응답 대기 중인 진행 중인 ConfirmRequest 교환을 취소합니다.

세부정보
반환 값
WEAVE_NO_ERROR
있습니다.

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

기기 설명 클라이언트 상태를 초기화합니다.

param[in] ExchangeMgr Weave Exchange 관리자에 대한 포인터입니다.

세부정보
반환 값
WEAVE_ERROR_INCORRECT_STATE
원격 패시브 rendezvous 서버가 이미 등록된 경우
WEAVE_NO_ERROR
성공 시

SendIdentifyRequest

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

특정 IP 주소로 IdentityRequest 메시지를 전송합니다.

세부정보
매개변수
[in] nodeAddr
쿼리할 Weave 노드의 IP 주소에 대한 참조입니다.
[in] msg
전송할 VerifyRequest 메시지에 대한 참조입니다.
반환 값
WEAVE_ERROR_NO_MEMORY
패킷 버퍼의 교환 컨텍스트 할당이 실패하는 경우
WEAVE_NO_ERROR
성공 시
other
IDRequest 전송을 방해하는 오류가 발생했음을 나타내는 기타 Weave 또는 플랫폼별 오류 코드입니다.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

브로드캐스트 IdentityRequest 메시지를 보내 Weave 노드를 탐색합니다.

세부정보
매개변수
[in] msg
전송할 VerifyRequest 메시지에 대한 참조입니다.

종료

WEAVE_ERROR Shutdown(
  void
)

기기 설명 클라이언트를 종료합니다.

이 함수는 활성 교환 컨텍스트를 닫고 포인터를 재설정합니다. 이 객체는 Init 메서드를 다시 호출하여 재사용할 수 있습니다.

세부정보
반환 값
WEAVE_NO_ERROR
있습니다.