nl :: نسج:: مظهر:: صدى_التالي :: WeaveEchoServer
#include <src/lib/profiles/echo/Next/WeaveEchoServer.h>
Accepts EchoRequest messages from a peer node and responds with an EchoResponse message.
ملخص
و WeaveEchoServer تنفذ الطبقة الجانب الرد على البروتوكول نسج صدى. على غرار بروتوكول ping الخاص بـ ICMP ، يمكن استخدام بروتوكول Weave Echo لاختبار فعالية وإمكانية الوصول إلى عقدة Weave.
يمكن للتطبيقات استخدام WeaveEchoServer فئة لتمكين استجابة تلقائية على الرسائل الواردة EchoRequest. توجد فئة المقابلة لبدء طلبات صدى (انظر WeaveEchoClient ).
افتراضيا WeaveEchoServer يستجيب فورا إلى EchoRequest مع استجابة تحتوي على نفس الحمولة كما طلب. ومع ذلك ، يمكن تغيير هذا السلوك بواسطة التطبيق أثناء معالجة حدث واجهة برمجة التطبيقات EchoRequestReceived.
أحداث API
أثناء عملها، و WeaveEchoServer وجوه الدعوة إلى التطبيق على الإجراءات المحددة التي طلب أو تقديم إخطارات الأحداث الهامة. يتم إجراء استدعاءات حدث API هذه لوظيفة رد الاتصال المكونة حاليًا على كائن الخادم. باستثناء ما هو مذكور ، فإن التطبيقات حرة في تغيير حالة الخادم أثناء رد اتصال الحدث. استثناء واحد العام هو الكائن إيقاف () الأسلوب، الذي لا يجوز أبدا أن يطلق خلال الاستدعاء.
تم تحديد أحداث API التالية:
EchoRequest تم تلقيه
تم استلام رسالة EchoRequest من نظير. تحتوي الوسائط الخاصة بالحدث على حمولة الطلب وسياق التبادل الذي تم استلام الرسالة من خلاله والمعلومات الوصفية حول رسالة الطلب.
إذا اختار التطبيق ، فقد يغير وسيطات الإخراج إلى الحدث لفرض تأخير في الاستجابة أو لمنع الاستجابة تمامًا. بالإضافة إلى ذلك ، قد يغير محتويات المخزن المؤقت للحمولة الصافية ، والذي سيصبح حمولة لرسالة الاستجابة.
EchoResponseSent
تم إرسال رسالة EchoResponse أو فشل إرسالها. تحتوي وسائط الحدث على الخطأ الذي نتج عن إرسال الرسالة (إن وجد) وسياق التبادل الذي تم إرسال الرسالة من خلاله.
ميراث
يرث من: NL :: :: نسج WeaveServerBaseتوجيه الفئات الفرعية المعروفة: NL :: :: نسج DeviceLayer :: :: الداخلية EchoServer
البنائين والمدمرين | |
---|---|
WeaveEchoServer (void) المنشئ الافتراضي لل WeaveEchoServer . |
الأنواع العامة | |
---|---|
EchoFunct )(uint64_t nodeId, IPAddress nodeAddr, PacketBuffer *payload) | typedefvoid(* |
EventCallback )(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam) | typedefvoid(* |
EventType { | تعداد |
السمات العامة | |
---|---|
AppState | void * مؤشر إلى البيانات الخاصة بالتطبيق. |
OnEchoRequestReceived | EchoFunct |
الوظائف العامة | |
---|---|
GetEventCallback (void) const | EventCallback ترجع مؤشر إلى وظيفة رد الاتصال الحدث API تكوينها حاليا في WeaveEchoServer الكائن. |
Init ( WeaveExchangeManager *exchangeMgr, EventCallback eventCallback, void *appState) | تهيئة WeaveEchoServer الكائن. |
Init ( WeaveExchangeManager *exchangeMgr) | تهيئة WeaveEchoServer الكائن. |
SetEventCallback (EventCallback eventCallback) | void يحدد وظيفة رد الاتصال الحدث API على WeaveEchoServer الكائن. |
Shutdown (void) | إيقاف لتهيئة سابقا WeaveEchoServer الكائن. |
وظائف ثابتة عامة | |
---|---|
DefaultEventHandler (void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam) | void معالج الافتراضي لل WeaveEchoServer أحداث API. |
الهياكل | |
---|---|
نيكولا لانغ :: :: نسج الملامح :: :: Echo_Next WeaveEchoServer :: InEventParam | معلمات الإدخال إلى WeaveEchoServer الحدث API. |
نيكولا لانغ :: :: نسج الملامح :: :: Echo_Next WeaveEchoServer :: OutEventParam | معلمات الإخراج إلى WeaveEchoServer الحدث API. |
الأنواع العامة
صدى
void(* EchoFunct)(uint64_t nodeId, IPAddress nodeAddr, PacketBuffer *payload)
حدث
void(* EventCallback)(void *appState, EventType eventType, const InEventParam &inParam, OutEventParam &outParam)
نوع الحدث
EventType
السمات العامة
AppState
void * AppState
مؤشر إلى البيانات الخاصة بالتطبيق.
تم استلام طلب OnEchoRequest
EchoFunct OnEchoRequestReceived
الوظائف العامة
GetEventCallback
EventCallback GetEventCallback( void ) const
ترجع مؤشر إلى وظيفة رد الاتصال الحدث API تكوينها حاليا في WeaveEchoServer الكائن.
فيه
WEAVE_ERROR Init( WeaveExchangeManager *exchangeMgr, EventCallback eventCallback, void *appState )
تهيئة WeaveEchoServer الكائن.
تهيئة WeaveEchoServer الكائن إلى الاستجابة إلى صدى رسائل من الأقران.
تفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلمات |
|
فيه
WEAVE_ERROR Init( WeaveExchangeManager *exchangeMgr )
تهيئة WeaveEchoServer الكائن.
تهيئة WeaveEchoServer الكائن إلى الاستجابة إلى صدى رسائل من الأقران.
DEPRECATED: الرجاء استخدام التهيئة (WeaveExchangeManager * exchangeMgr، EventCallback eventCallback، الفراغ * appState) .
تفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلمات |
|
SetEventCallback
void SetEventCallback( EventCallback eventCallback )
يحدد وظيفة رد الاتصال الحدث API على WeaveEchoServer الكائن.
اغلق
WEAVE_ERROR Shutdown( void )
إيقاف لتهيئة سابقا WeaveEchoServer الكائن.
لاحظ أن هذا الأسلوب يمكن أن يسمى إلا إذا كانت التهيئة () تم استدعاء أسلوب سابقا.
وظائف ثابتة عامة
DefaultEventHandler
void DefaultEventHandler( void *appState, EventType eventType, const InEventParam & inParam, OutEventParam & outParam )
معالج الافتراضي لل WeaveEchoServer أحداث API.
يُطلب من التطبيقات استدعاء هذه الطريقة لأي أحداث API لا يتعرفون عليها أو يتعاملون معها. يجب أن تكون المعلمات المتوفرة هي نفسها التي تم تمريرها بواسطة كائن الخادم إلى وظيفة معالج الحدث للتطبيق.
تفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلمات |
|
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجّلة لشركة Oracle و/أو شركائها التابعين، وThread هي علامة تجارية مسجّلة لشركة .Thread Group, Inc.
تاريخ التعديل الأخير: 2019-09-14 (حسب التوقيت العالمي المتفَّق عليه)