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

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

Objek klien untuk mengeluarkan permintaan Deskripsi Perangkat.

Ringkasan

Konstruktor dan Destruktor
DeviceDescriptionClient(void)

Jenis publik
HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) typedef
void(*
Fungsi ini bertanggung jawab memproses pesan IdentityResponse.

Atribut publik
AppState
void *
Objek status yang ditentukan aplikasi.
ExchangeMgr
[HANYA BACA] Objek pengelola Exchange
FabricState
[HANYA BACA] Objek status Fabric
OnIdentifyResponseReceived

Fungsi publik
CancelExchange(void)
Membatalkan pertukaran IdentifikasiRequest yang sedang berlangsung menunggu respons.
Init(WeaveExchangeManager *exchangeMgr)
Melakukan inisialisasi status klien Deskripsi Perangkat.
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
Mengirim pesan IdentifikasiRequest ke alamat IP tertentu.
SendIdentifyRequest(const IdentifyRequestMessage & msg)
Kirim pesan IdentifikasiRequest siaran untuk menemukan node Weave.
Shutdown(void)
Matikan Klien Deskripsi Perangkat.

Jenis publik

HandleIdentifyResponseFunct

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

Fungsi ini bertanggung jawab memproses pesan IdentityResponse.

Detail
Parameter
[in] appState
Pointer ke kumpulan status yang ditentukan aplikasi saat membuat Konteks IdentityRequest Exchange.
[in] nodeId
ID node Weave sumber pesan.
[in] nodeAddr
Alamat IP node respons.
[in] msg
Referensi ke pesanIdentifyResponse yang masuk.

Atribut publik

AppState

void * AppState

Objek status yang ditentukan aplikasi.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[HANYA BACA] Objek pengelola Exchange

FabricState

const WeaveFabricState * FabricState

[HANYA BACA] Objek status Fabric

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

Fungsi publik

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

Membatalkan pertukaran IdentifikasiRequest yang sedang berlangsung menunggu respons.

Detail
Nilai Pengembalian
WEAVE_NO_ERROR
tanpa syarat.

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Inisiasi

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Melakukan inisialisasi status klien Deskripsi Perangkat.

param[in] exchangeMgr Pointer ke Weave Exchange Manager.

Detail
Nilai Pengembalian
WEAVE_ERROR_INCORRECT_STATE
Saat server pertemuan pasif jarak jauh telah terdaftar.
WEAVE_NO_ERROR
Setelah berhasil.

SendIdentifyRequest

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

Mengirim pesan IdentifikasiRequest ke alamat IP tertentu.

Detail
Parameter
[in] nodeAddr
Referensi ke alamat IP node Weave yang akan ditelusuri.
[in] msg
Referensi ke pesanIdentifyRequest yang akan dikirim.
Nilai Pengembalian
WEAVE_ERROR_NO_MEMORY
Jika alokasi konteks pertukaran buffering paket gagal.
WEAVE_NO_ERROR
Setelah berhasil.
other
Kode error Weave atau khusus platform lainnya yang menunjukkan bahwa terjadi error yang mencegah pengirimanIdentifyRequest.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

Kirim pesan IdentifikasiRequest siaran untuk menemukan node Weave.

Detail
Parameter
[in] msg
Referensi ke pesanIdentifyRequest yang akan dikirim.

Nonaktif

WEAVE_ERROR Shutdown(
  void
)

Matikan Klien Deskripsi Perangkat.

Fungsi ini menutup semua konteks pertukaran aktif dan mereset pointer. Objek ini dapat digunakan kembali dengan memanggil metode Init lagi.

Detail
Nilai Pengembalian
WEAVE_NO_ERROR
tanpa syarat.