nl:: Menenun:: Profil:: Echo_Selanjutnya:: WeaveEchoServer
#include <src/lib/profiles/echo/Next/WeaveEchoServer.h>
Accepts EchoRequest messages from a peer node and responds with an EchoResponse message.
Ringkasan
The WeaveEchoServer kelas mengimplementasikan sisi responder dari protokol Weave Echo. Mirip dengan protokol ping ICMP, protokol Weave Echo dapat digunakan untuk menguji liveness dan reachability dari node Weave.
Aplikasi dapat menggunakan WeaveEchoServer kelas untuk mengaktifkan respon otomatis ke pesan EchoRequest masuk. Sebuah kelas yang sesuai ada untuk memulai permintaan echo (lihat WeaveEchoClient ).
Secara default WeaveEchoServer merespon segera ke EchoRequest dengan respon yang mengandung muatan yang sama seperti permintaan. Namun perilaku ini dapat diubah oleh aplikasi selama pemrosesan acara API EchoRequestReceived.
Acara API
Selama operasi, yang WeaveEchoServer objek akan memanggil untuk aplikasi untuk tindakan tertentu permintaan atau menyampaikan pemberitahuan dari peristiwa-peristiwa penting. Panggilan peristiwa API ini dibuat ke fungsi panggilan balik yang saat ini dikonfigurasi pada objek server. Kecuali jika disebutkan, aplikasi bebas mengubah status server selama panggilan balik peristiwa. Satu pengecualian keseluruhan objek Shutdown () metode, yang mungkin tidak akan pernah disebut selama callback.
Peristiwa API berikut ditentukan:
EchoRequestDiterima
Pesan EchoRequest diterima dari rekan. Argumen ke acara berisi payload permintaan, konteks pertukaran di mana pesan diterima dan meta-informasi tentang pesan permintaan.
Jika aplikasi memilih, itu dapat mengubah argumen output ke acara untuk memaksa penundaan dalam merespons atau untuk menekan respons sama sekali. Selain itu, ini dapat mengubah isi buffer payload, yang akan menjadi payload untuk pesan respons.
EchoResponseTerkirim
Pesan EchoResponse telah dikirim, atau gagal dikirim. Argumen ke acara berisi kesalahan yang dihasilkan dari pengiriman pesan (jika ada) dan konteks pertukaran tempat pesan dikirim.
Warisan
Mewarisi dari: nl :: Weave :: WeaveServerBaseLangsung Subclass Dikenal: nl :: Weave :: DeviceLayer :: internal :: EchoServer
Konstruktor dan Destruktor | |
---|---|
WeaveEchoServer (void) Konstruktor default untuk WeaveEchoServer . |
Tipe publik | |
---|---|
EchoFunct )(uint64_t nodeId, IPAddress nodeAddr, PacketBuffer *payload) | typedefvoid(* |
EventCallback )(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam) | typedefvoid(* |
EventType { | enum |
Atribut publik | |
---|---|
AppState | void * Pointer ke data khusus aplikasi. |
OnEchoRequestReceived | EchoFunct |
Fungsi publik | |
---|---|
GetEventCallback (void) const | EventCallback Mengembalikan pointer ke API fungsi event callback saat ini dikonfigurasi pada WeaveEchoServer objek. |
Init ( WeaveExchangeManager *exchangeMgr, EventCallback eventCallback, void *appState) | Menginisialisasi WeaveEchoServer objek. |
Init ( WeaveExchangeManager *exchangeMgr) | Menginisialisasi WeaveEchoServer objek. |
SetEventCallback (EventCallback eventCallback) | void Mengatur fungsi panggilan balik API acara di WeaveEchoServer objek. |
Shutdown (void) | Shutdown sebelumnya diinisialisasi WeaveEchoServer objek. |
Fungsi statis publik | |
---|---|
DefaultEventHandler (void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam) | void Handler default untuk WeaveEchoServer API acara. |
Struktur | |
---|---|
nl :: Weave :: Profil :: Echo_Next :: WeaveEchoServer :: InEventParam | Parameter masukan untuk WeaveEchoServer API acara. |
nl :: Weave :: Profil :: Echo_Next :: WeaveEchoServer :: OutEventParam | Parameter output untuk WeaveEchoServer API acara. |
Tipe publik
Fungsi Gema
void(* EchoFunct)(uint64_t nodeId, IPAddress nodeAddr, PacketBuffer *payload)
AcaraCallback
void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
Jenis Acara
EventType
Atribut publik
Status Aplikasi
void * AppState
Pointer ke data khusus aplikasi.
SatuEchoRequestDiterima
EchoFunct OnEchoRequestReceived
Fungsi publik
DapatkanAcaraCallback
EventCallback GetEventCallback( void ) const
Mengembalikan pointer ke API fungsi event callback saat ini dikonfigurasi pada WeaveEchoServer objek.
init
WEAVE_ERROR Init( WeaveExchangeManager *exchangeMgr, EventCallback eventCallback, void *appState )
Menginisialisasi WeaveEchoServer objek.
Menginisialisasi WeaveEchoServer objek untuk merespon gema pesan dari rekan.
rincian | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
init
WEAVE_ERROR Init( WeaveExchangeManager *exchangeMgr )
Menginisialisasi WeaveEchoServer objek.
Menginisialisasi WeaveEchoServer objek untuk merespon gema pesan dari rekan.
TIDAK BERLAKU LAGI: Gunakan Init (WeaveExchangeManager * exchangeMgr, EventCallback eventCallback, void * AppState) .
rincian | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
AturAcaraCallback
void SetEventCallback( EventCallback eventCallback )
Mengatur fungsi panggilan balik API acara di WeaveEchoServer objek.
Menutup
WEAVE_ERROR Shutdown( void )
Shutdown sebelumnya diinisialisasi WeaveEchoServer objek.
Perhatikan bahwa metode ini hanya bisa disebut jika Init () metode telah disebut sebelumnya.
Fungsi statis publik
DefaultEventHandler
void DefaultEventHandler( void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam )
Handler default untuk WeaveEchoServer API acara.
Aplikasi diharuskan memanggil metode ini untuk setiap peristiwa API yang tidak mereka kenali atau tangani. Parameter yang disediakan harus sama dengan yang diteruskan oleh objek server ke fungsi pengendali peristiwa aplikasi.
rincian | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|