nl::Weave::Binding

Menangkap target yang diinginkan dari komunikasi Weave dan informasi konfigurasi terkait.

Ringkasan

Objek Binding mengidentifikasi target komunikasi Weave yang dimaksud (juga dikenal sebagai "peer"), beserta kumpulan parameter konfigurasi yang menjelaskan cara melakukan komunikasi dengan peer. Pengikatan tidak bergantung pada protokol aplikasi yang diucapkan antara kedua pihak. Dengan demikian, mereka menangkap "siapa" dan "bagaimana" dari suatu komunikasi, tetapi bukan "apa."

Konfigurasi

Aplikasi harus mengonfigurasi Binding dengan parameter khusus untuk jenis saluran komunikasi yang diinginkan. Binding menyediakan dukungan untuk berbagai transport jaringan, termasuk TCP, UDP, UDP dengan Weave Reliable Messaging, dan Weave over BLE (WoBLE). Aplikasi juga dapat meminta penggunaan mekanisme keamanan spesifik untuk melindungi pesan yang dikirim antarpihak. Ini termasuk sesi CASE dan PASE, serta kunci grup aplikasi. Antarmuka untuk mengonfigurasi Binding menggunakan gaya API deklaratif yang memungkinkan aplikasi menyatakan persyaratannya untuk komunikasi secara sederhana.

Lihat dokumentasi untuk Binding::Configuration guna mengetahui detail selengkapnya.

Persiapan

Sebelum komunikasi dilakukan, Binding harus "disiapkan". Tindakan menyiapkan Binding melibatkan penetapan status yang diperlukan agar komunikasi dapat terjadi. Hal ini dapat mencakup hal-hal seperti: menyelesaikan alamat jaringan pembanding, membuat koneksi jaringan, dan menegosiasikan kunci keamanan. Setelah dikonfigurasi oleh aplikasi, Binding akan menangani semua langkah yang diperlukan untuk mempersiapkan komunikasi, dan melakukan callback ke aplikasi saat proses selesai. Dengan cara ini, Binding menyembunyikan mekanisme komunikasi, sehingga aplikasi dapat berkonsentrasi pada interaksi tingkat tinggi.

Komunikasi

Setelah disiapkan, Binding akan siap digunakan. Dalam status ini, aplikasi (atau lebih umum, kode lapisan protokol yang bekerja atas nama aplikasi) meminta Binding untuk mengalokasikan konteks pertukaran Weave. Konteks pertukaran yang dihasilkan telah dikonfigurasi sebelumnya untuk komunikasi, sehingga aplikasi dapat segera memulai pertukaran Weave dengan peer. Aplikasi dapat terus meminta konteks pertukaran dari Binding hingga saat Binding ditutup, atau beberapa peristiwa, misalnya kegagalan jaringan, menghentikan saluran komunikasi yang mendasarinya.

Perubahan Status Binding

Selama penggunaannya, Binding akan mengirimkan peristiwa API ke aplikasi yang memberitahukan perubahan status Binding. Misalnya, saat persiapan berhasil, aplikasi akan menerima peristiwa yang menginformasikan bahwa Binding siap digunakan. Demikian pula, jika saluran komunikasi yang mendasarinya gagal, peristiwa akan dikirim ke aplikasi yang memberitahukan bahwa Binding tidak lagi dalam status siap.

Peristiwa API dikirim ke aplikasi melalui fungsi callback peristiwa yang disediakan saat Binding dialokasikan.

Masa Berlaku Binding

Binding adalah referensi yang dihitung untuk memungkinkan penggunaan bersama di beberapa komponen software. Saat Binding dialokasikan, referensi tunggal ke binding akan dibuat. Aplikasi bertanggung jawab untuk merilis referensi ini pada masa mendatang sehingga Binding bebas untuk digunakan kembali pada masa mendatang.

Setelah selesai dengan Binding, aplikasi dapat memanggil Close() di binding. Tindakan ini akan merilis referensi aplikasi ke Binding dan memblokir semua pengiriman peristiwa API lebih lanjut. Saat referensi terakhir ke Binding dirilis, referensi tersebut akan ditutup secara otomatis.

Jenis publik

 @23

void(* EventCallback)(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)

 EventType

 State

void * AppState

void AddRef(
  void
)

WEAVE_ERROR AdjustResponseTimeout(
  ExchangeContext *apExchangeContext
) const 

WEAVE_ERROR AllocateRightSizedBuffer(
  PacketBuffer *& buf,
  const uint32_t desiredSize,
  const uint32_t minSize,
  uint32_t & outMaxPayloadSize
)

Configuration BeginConfiguration()

bool CanBePrepared(
  void
) const 

void Close(
  void
)

WeaveConnection * GetConnection() const 

uint32_t GetDefaultResponseTimeout() const 

const WRMPConfig & GetDefaultWRMPConfig(
  void
) const 

uint8_t GetEncryptionType(
  void
) const 

EventCallback GetEventCallback() const 

WeaveExchangeManager * GetExchangeManager() const 

uint32_t GetKeyId(
  void
) const 

uint16_t GetLogId(
  void
) const 

uint32_t GetMaxWeavePayloadSize(
  const System::PacketBuffer *msgBuf
)

void GetPeerDescription(
  char *buf,
  uint32_t bufSize
) const 

void GetPeerIPAddress(
  nl::Inet::IPAddress & address,
  uint16_t & port,
  InterfaceId & interfaceId
) const 

uint64_t GetPeerNodeId(
  void
) const 

void GetProtocolLayerCallback(
  EventCallback & callback,
  void *& state
) const 

State GetState(
  void
) const 

bool IsAuthenticMessageFromPeer(
  const WeaveMessageInfo *msgInfo
)

bool IsConnectionTransport() const 

bool IsPreparing(
  void
) const 

bool IsReady(
  void
) const 

bool IsUDPTransport() const 

bool IsUnreliableUDPTransport() const 

bool IsWRMTransport() const 

WEAVE_ERROR NewExchangeContext(
  ExchangeContext *& appExchangeContext
)

void Release(
  void
)

WEAVE_ERROR RequestPrepare()

void Reset(
  void
)

void SetDefaultResponseTimeout(
  uint32_t msec
)

void SetDefaultWRMPConfig(
  const WRMPConfig & wrmpConfig
)

void SetEventCallback(
  EventCallback aEventCallback
)

void SetProtocolLayerCallback(
  EventCallback callback,
  void *state
)

void DefaultEventHandler(
  void *apAppState,
  EventType aEvent,
  const InEventParam & aInParam,
  OutEventParam & aOutParam
)