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

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

Cihaz Açıklaması istekleri yayınlamak için kullanılan 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 mesajlarının işlenmesinden sorumludur.

Herkese açık özellikler

AppState
void *
Uygulama tarafından tanımlanmış durum nesnesi.
ExchangeMgr
[SADECE OKUYUN] Exchange yöneticisi nesnesi
FabricState
[YALNIZCA OKUYUN] Fabric durum nesnesi
OnIdentifyResponseReceived

Kamu işlevleri

CancelExchange(void)
Yanıt bekleyen ve devam eden bir IdentityRequest exchange'ini iptal etme.
Init(WeaveExchangeManager *exchangeMgr)
Cihaz Açıklaması istemci durumunu başlatın.
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
Belirli bir IP adresine IdentityRequest iletisi gönderin.
SendIdentifyRequest(const IdentifyRequestMessage & msg)
Weave düğümlerini keşfetmek için bir yayın IdentityRequest mesajı gönderin.
Shutdown(void)
Device Description Client'ı 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 mesajlarının işlenmesinden sorumludur.

Ayrıntılar
Parametreler
[in] appState
IdentityRequest Exchange Bağlamı oluşturulurken uygulama tanımlı durumun ayarlanmış olduğunu gösteren işaretçi.
[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 iletisine referans.

Herkese açık özellikler

AppState

void * AppState

Uygulama tarafından tanımlanmış durum nesnesi.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[SADECE OKUYUN] Exchange yöneticisi nesnesi

FabricState

const WeaveFabricState * FabricState

[YALNIZCA OKUYUN] Fabric durum nesnesi

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

Kamu işlevleri

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

Yanıt bekleyen ve devam eden bir IdentityRequest exchange'ini iptal etme.

Ayrıntılar
Döndürülen Değerler
WEAVE_NO_ERROR
koşulsuz bir şekilde çalışır.

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Başlat

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

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

param[in] exchangeMgr A işaretçisi Weave Exchange Yöneticisi'ni gösterir.

Ayrıntılar
Döndürülen Değerler
WEAVE_ERROR_INCORRECT_STATE
Uzak bir pasif buluşma sunucusu zaten kayıtlı olduğunda.
WEAVE_NO_ERROR
Başarılı olun.

SendIdentifyRequest

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

Belirli bir IP adresine IdentityRequest iletisi gönderin.

Ayrıntılar
Parametreler
[in] nodeAddr
Sorgulanacak Weave düğümünün IP adresi için referans.
[in] msg
Gönderilecek IdentityRequest mesajı için referans.
Döndürülen Değerler
WEAVE_ERROR_NO_MEMORY
Paket arabelleği değişim bağlamı ayırma başarısız olursa.
WEAVE_NO_ERROR
Başarılı olun.
other
DescriptionRequest'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 IdentityRequest mesajı gönderin.

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

Kapat

WEAVE_ERROR Shutdown(
  void
)

Device Description Client'ı kapatın.

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

Ayrıntılar
Döndürülen Değerler
WEAVE_NO_ERROR
koşulsuz bir şekilde çalışır.