nl::Weave::WeaveServerBase

#include <src/lib/core/WeaveServerBase.h>

Objek dasar umum untuk menerapkan responden (server) yang tidak diminta profil Weave yang mengenkapsulasi validasi permintaan yang diautentikasi dan mengirim laporan status serta menyediakan penyimpanan anggota data umum untuk status fabric dan pengelola pertukaran.

Ringkasan

Inheritance

Subclass yang Dikenal Dikenal Langsung:
  nl::Weave::Profiles::DeviceControl::DeviceControlServer
  nl::Weave::Profiles::DeviceDescription::DeviceDescriptionServer







nl::Weave::Profiles::Echo_Next::WeaveEchoServernl::Weave::Profiles::FabricProvisioning::FabricProvisioningServernl::Weave::Profiles::Heartbeat::WeaveHeartbeatReceivernl::Weave::Profiles::NetworkProvisioning::NetworkProvisioningServernl::Weave::Profiles::ServiceProvisioning::ServiceProvisioningServernl::Weave::Profiles::TokenPairing::TokenPairingServernl::Weave::Profiles::Vendor::Nestlabs::DropcamLegacyPairing::DropcamLegacyPairingServernl::Weave::Profiles::WeaveEchoServer

Atribut publik
ExchangeMgr
[HANYA BACA] Objek pengelola Exchange
FabricState
[HANYA BACA] Objek status Fabric

Fungsi statis publik
SendStatusReport(ExchangeContext *ec, uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError)
Kirim laporan status Weave dengan tanda pesan default kepada inisiator di bursa tertentu yang berisi kode status pada error sistem dan profil tertentu.
SendStatusReport(ExchangeContext *ec, uint32_t statusProfileId, uint16_t statusCode, WEAVE_ERROR sysError, uint16_t sendFlags)
Kirim laporan status Weave dengan flag pesan yang diberikan kepada inisiator di pertukaran yang ditentukan yang berisi kode status dalam profil yang ditentukan dan error sistem.

Fungsi yang dilindungi
EnforceAccessControl(ExchangeContext *ec, uint32_t msgProfileId, uint8_t msgType, const WeaveMessageInfo *msgInfo, WeaveServerDelegateBase *delegate)
bool
Menentukan apakah pesan permintaan masuk ke server Weave harus diterima atau dihapus.
WeaveServerBase(void)

Atribut publik

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[HANYA BACA] Objek pengelola Exchange

FabricState

WeaveFabricState * FabricState

[HANYA BACA] Objek status Fabric

Fungsi statis publik

SendStatusReport

WEAVE_ERROR SendStatusReport(
  ExchangeContext *ec,
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError
)

Kirim laporan status Weave dengan tanda pesan default kepada inisiator di bursa tertentu yang berisi kode status pada error sistem dan profil tertentu.

Detail
Parameter
[in] ec
Pointer ke konteks pertukaran untuk mengirim laporan status.
[in] statusProfileId
Profil untuk kode status yang ditentukan.
[in] statusCode
Kode status yang akan dikirim.
[in] sysError
Error sistem yang terkait atau berkorelasi dengan kode status.

SendStatusReport

WEAVE_ERROR SendStatusReport(
  ExchangeContext *ec,
  uint32_t statusProfileId,
  uint16_t statusCode,
  WEAVE_ERROR sysError,
  uint16_t sendFlags
)

Kirim laporan status Weave dengan flag pesan yang diberikan kepada inisiator di pertukaran yang ditentukan yang berisi kode status dalam profil yang ditentukan dan error sistem.

Detail
Parameter
[in] ec
Pointer ke konteks pertukaran untuk mengirim laporan status.
[in] statusProfileId
Profil untuk kode status yang ditentukan.
[in] statusCode
Kode status yang akan dikirim.
[in] sysError
Error sistem yang terkait atau berkorelasi dengan kode status.
[in] sendFlags
Flag yang ditetapkan oleh aplikasi untuk laporan status Weave yang dikirim.

Fungsi yang dilindungi

EnforceAccessControl

bool EnforceAccessControl(
  ExchangeContext *ec,
  uint32_t msgProfileId,
  uint8_t msgType,
  const WeaveMessageInfo *msgInfo,
  WeaveServerDelegateBase *delegate
)

Menentukan apakah pesan permintaan masuk ke server Weave harus diterima atau dihapus.

Metode ini dimaksudkan untuk digunakan oleh implementasi server Weave untuk menerapkan kebijakan kontrol akses yang dapat diperluas untuk pesan permintaan yang masuk. Implementasi server yang mengandalkan objek delegasi harus memanggil metode ini di awal pemrosesan pesan untuk menentukan apakah pemrosesan pesan harus dilanjutkan.

Metode ini memanggil metode WeaveServerDelegateBase::EnforceAccessControl() virtual pada delegasi yang disediakan untuk mengevaluasi kebijakan kontrol akses untuk pesan. Class delegasi server Weave, dan delegasi khusus aplikasi yang berasal dari class server standar, harus mengganti metode virtual untuk menerapkan kebijakan kontrol akses tertentu.

Detail
Parameter
[in] ec
ExchangeContext tempat pesan diterima.
[in] msgProfileId
ID profil pesan yang diterima.
[in] msgType
Jenis pesan dari pesan yang diterima.
[in] msgInfo
Struktur WeaveMessageInfo yang berisi informasi tentang pesan yang diterima.
[in] delegate
Objek delegasi yang disediakan oleh aplikasi yang dapat digunakan untuk mengganti kebijakan kontrol akses pesan default.
Nilai yang Ditampilkan
true
Jika pesan harus diterima dan diproses seperti biasa.
false
Jika pemrosesan pesan harus dihentikan dan pesan harus dihapus.

WeaveServerBase

 WeaveServerBase(
  void
)