nl::Weave::Profiles::DeviceDescription::DeviceDescriptionServer

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

Objek server untuk merespons permintaan Deskripsi Perangkat.

Ringkasan

Inheritance

Mewarisi dari: nl::Weave::WeaveServerBase
Subclasses yang Diketahui Langsung: nl::Weave::DeviceLayer::Internal::DeviceDescriptionServer

Konstruktor dan Destruktor
DeviceDescriptionServer(void)

Jenis publik
HandleIdentifyRequestFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyRequestMessage &reqMsg, bool &sendResp, IdentifyResponseMessage &respMsg) typedef
void(*

Atribut publik
AppState
void *
Pointer status yang ditetapkan aplikasi untuk memberikan konteks bagi callback.
OnIdentifyRequestReceived
HandleIdentifyRequestFunct
Fungsi ini bertanggung jawab memproses pesan IdentityRequest.

Fungsi publik
Init(WeaveExchangeManager *exchangeMgr)
Melakukan inisialisasi status Server Deskripsi Perangkat dan mendaftar untuk menerima pesan Deskripsi Perangkat.
Shutdown(void)
Matikan Server Deskripsi Perangkat.

Jenis publik

HandleIdentifyRequestFunct

void(* HandleIdentifyRequestFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyRequestMessage &reqMsg, bool &sendResp, IdentifyResponseMessage &respMsg)

Atribut publik

AppState

void * AppState

Pointer status yang ditetapkan aplikasi untuk memberikan konteks bagi callback.

OnIdentifyRequestReceived

HandleIdentifyRequestFunct OnIdentifyRequestReceived

Fungsi ini bertanggung jawab memproses pesan IdentityRequest.

Detail
Parameter
[in] appState
Pointer ke status yang ditentukan aplikasi yang ditetapkan saat mendaftar untuk menerima pesan jenis ini.
[in] nodeId
ID node Weave sumber pesan.
[in] nodeAddr
Alamat IP sumber pesan.
[in] reqMsg
Referensi ke pesanIdentifyRequest yang masuk.
[out] sendResp
Referensi ke boolean yang harus ditetapkan ke true jika pesan respons harus dikirim ke inisiator.
[out] respMsg
Referensi ke pesan IdentityResponse yang akan dikirim ke inisiator.

Fungsi publik

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

Inisiasi

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Melakukan inisialisasi status Server Deskripsi Perangkat dan mendaftar untuk menerima pesan 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_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Jika terlalu banyak pengendali pesan yang tidak diminta didaftarkan.
WEAVE_NO_ERROR
Setelah berhasil.

Nonaktif

WEAVE_ERROR Shutdown(
  void
)

Matikan Server Deskripsi Perangkat.

Detail
Nilai Pengembalian
WEAVE_NO_ERROR
tanpa syarat.