nl:: örgü:: Profiller:: Cihaz Açıklaması:: Cihaz Tanımıİstemci

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

Aygıt Açıklaması isteklerini yayınlamak için istemci nesnesi.

Özet

Yapıcılar ve Yıkıcılar

DeviceDescriptionClient (void)

Genel türler

HandleIdentifyResponseFunct )(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) typedef
void(*
Bu işlev, IdentityResponse mesajlarının işlenmesinden sorumludur.

Genel özellikler

AppState
void *
Uygulama tanımlı durum nesnesi.
ExchangeMgr
[SADECE OKUYUN] Exchange yöneticisi nesnesi
FabricState
[SADECE OKUYUN] Yapı durumu nesnesi
OnIdentifyResponseReceived

Kamu işlevleri

CancelExchange (void)
Yanıt bekleyen, devam etmekte olan bir Tanımlama İsteği değişimini iptal edin.
Init ( WeaveExchangeManager *exchangeMgr)
Aygıt Açıklaması istemci durumunu başlatın.
SendIdentifyRequest (const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
Belirli bir IP adresine bir Tanımlama İsteği mesajı gönderin.
SendIdentifyRequest (const IdentifyRequestMessage & msg)
Weave düğümlerini keşfetmek için bir yayın Tanımlama İsteği mesajı gönderin.
Shutdown (void)
Cihaz Açıklama İstemcisini kapatın.

Genel türler

HandleIdentifyResponseFunct

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

Bu işlev, IdentityResponse mesajlarının işlenmesinden sorumludur.

Ayrıntılar
parametreler
[in] appState
IdentityRequest Exchange Bağlamı oluşturulurken uygulama tanımlı durum kümesine yönelik bir işaretçi.
[in] nodeId
Mesaj kaynağının Örgü düğüm kimliği.
[in] nodeAddr
Yanıt veren düğümün IP adresi.
[in] msg
Gelen KimlikResponse iletisine bir başvuru.

Genel özellikler

Uygulama Durumu

void * AppState

Uygulama tanımlı durum nesnesi.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[SADECE OKUYUN] Exchange yöneticisi nesnesi

KumaşDurumu

const WeaveFabricState * FabricState

[SADECE OKUYUN] Yapı durumu nesnesi

OnIdentifyResponseAlındı

HandleIdentifyResponseFunct OnIdentifyResponseReceived

Kamu işlevleri

İptalDeğişim

WEAVE_ERROR CancelExchange(
  void
)

Yanıt bekleyen, devam etmekte olan bir Tanımlama İsteği değişimini iptal edin.

Ayrıntılar
Dönüş Değerleri
WEAVE_NO_ERROR
koşulsuz olarak.

Cihaz Tanımıİstemci

 DeviceDescriptionClient(
  void
)

İçinde

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Aygıt Açıklaması istemci durumunu başlatın.

param[in] exchangeMgr Weave Exchange Manager için bir işaretçi.

Ayrıntılar
Dönüş Değerleri
WEAVE_ERROR_INCORRECT_STATE
Uzak bir pasif buluşma sunucusu zaten kayıtlı olduğunda.
WEAVE_NO_ERROR
Başarı üzerine.

SendIdentifyRequest

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

Belirli bir IP adresine bir Tanımlama İsteği mesajı gönderin.

Ayrıntılar
parametreler
[in] nodeAddr
Sorgulanacak Weave düğümünün IP adresine bir başvuru.
[in] msg
Gönderilecek KimlikRequest mesajına bir referans.
Dönüş Değerleri
WEAVE_ERROR_NO_MEMORY
Paket arabelleğinin değişim bağlamını tahsis etme başarısız olursa.
WEAVE_NO_ERROR
Başarı üzerine.
other
Diğer Örgü veya platforma özgü hata kodları, Tanımlama İsteğinin gönderilmesini engelleyen bir hata oluştuğunu gösterir.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

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

Ayrıntılar
parametreler
[in] msg
Gönderilecek KimlikRequest mesajına bir referans.

Kapat

WEAVE_ERROR Shutdown(
  void
)

Cihaz Açıklama İstemcisini kapatın.

Bu işlev, herhangi bir etkin değişim bağlamını kapatır ve işaretçileri sıfırlar. Nesne arayarak yeniden kullanılabilir başlatma tekrar yöntem.

Ayrıntılar
Dönüş Değerleri
WEAVE_NO_ERROR
koşulsuz olarak.