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

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

Cihaz Açıklaması isteklerinde bulunmak için istemci nesnesi.

Özet

Oluşturucular ve Yıkıcılar
DeviceDescriptionClient(void)

Herkese açık türler
HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) typedef
void(*
Bu işlev, IdentityResponse iletilerini işlemekten sorumludur.

Herkese açık özellikler
AppState
void *
Uygulama tarafından tanımlanan durum nesnesi.
ExchangeMgr
[SALT OKUNUR] Exchange yöneticisi nesnesi
FabricState
[SALT OKUNUR] Yapı durumu nesnesi
OnIdentifyResponseReceived

Herkese açık işlevler
CancelExchange(void)
Yanıt bekleyen, devam eden IdentityRequest değişimini iptal edin.
Init(WeaveExchangeManager *exchangeMgr)
Cihaz Açıklaması istemci durumunu başlatın.
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
Belirli bir IP adresine IdentityRequest mesajı gönderin.
SendIdentifyRequest(const IdentifyRequestMessage & msg)
Weave düğümlerini keşfetmek için bir yayın identifierRequest mesajı gönderin.
Shutdown(void)
Cihaz Açıklama İstemcisi'ni kapatın.

Herkese açık türler

HandleIdentifyResponseFunct

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

Bu işlev, IdentityResponse iletilerini işlemekten sorumludur.

Ayrıntılar
Parametreler
[in] appState
IdentityRequest Exchange Bağlamı oluşturulurken belirlenen uygulama tanımlı durumunun işaretçisi.
[in] nodeId
İleti kaynağının Weave düğüm kimliği.
[in] nodeAddr
Yanıt veren düğümün IP adresi.
[in] msg
Gelen IdentityResponse mesajına referans.

Herkese açık özellikler

AppState

void * AppState

Uygulama tarafından tanımlanan durum nesnesi.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[SALT OKUNUR] Exchange yöneticisi nesnesi

FabricState

const WeaveFabricState * FabricState

[SALT OKUNUR] Yapı durumu nesnesi

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

Herkese açık işlevler

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

Yanıt bekleyen, devam eden IdentityRequest değişimini iptal edin.

Ayrıntılar
Değerleri Döndür
WEAVE_NO_ERROR
hiçbir şey yapmadan geri alabilir.

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Cihaz Açıklaması istemci durumunu başlatın.

param[in] exchangeMgr Weave Exchange Manager işaretçisini gösterir.

Ayrıntılar
Değerleri Döndür
WEAVE_ERROR_INCORRECT_STATE
Uzak pasif buluşma sunucusu zaten kayıtlıysa.
WEAVE_NO_ERROR
Başarıya merhaba.

SendIdentifyRequest

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

Belirli bir IP adresine IdentityRequest mesajı gönderin.

Ayrıntılar
Parametreler
[in] nodeAddr
Sorgulanacak Weave düğümünün IP adresine başvuru.
[in] msg
Gönderilecek IdentityRequest mesajına referans.
Değerleri Döndür
WEAVE_ERROR_NO_MEMORY
Paket arabelleğinin exchange bağlamını ayırma işlemi başarısız olursa.
WEAVE_NO_ERROR
Başarıya merhaba.
other
IdentityRequest'in gönderilmesini engelleyen bir hata oluştuğunu belirten diğer Weave veya platforma özgü hata kodları.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

Weave düğümlerini keşfetmek için bir yayın identifierRequest mesajı gönderin.

Ayrıntılar
Parametreler
[in] msg
Gönderilecek IdentityRequest mesajına referans.

Kapat

WEAVE_ERROR Shutdown(
  void
)

Cihaz Açıklama İstemcisi'ni kapatın.

Bu işlev, etkin exchange bağlamını kapatır ve işaretçileri sıfırlar. Nesne, Init yöntemi tekrar çağrılarak yeniden kullanılabilir.

Ayrıntılar
Değerleri Döndür
WEAVE_NO_ERROR
hiçbir şey yapmadan geri alabilir.