nl:: Weave:: WeaveConnection
#include <src/lib/core/WeaveMessageLayer.h>
تعريف فئة Weave Connection.
الملخّص
وتُمثِّل هذه السمة اتصال TCP أو BLE مع عقدة Weave أخرى.
الأنواع المتاحة للجميع |
|
---|---|
@58{
|
تعداد |
ConnectionClosedFunct)(WeaveConnection *con, WEAVE_ERROR conErr)
|
typedefvoid(*
هذه الدالة هي استدعاء التطبيق الذي تم استدعاؤه عند إغلاق الاتصال. |
ConnectionCompleteFunct)(WeaveConnection *con, WEAVE_ERROR conErr)
|
typedefvoid(*
وهذه الدالة هي استدعاء التطبيق الذي تم استدعاؤه عند اكتمال إعداد الاتصال. |
MessageReceiveFunct)(WeaveConnection *con, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
|
typedefvoid(*
هذه الدالة هي استدعاء التطبيق الذي تم استدعاؤه عند تلقي رسالة عبر اتصال Weave. |
NetworkType{
|
تعداد نوع الشبكة لكائن اتصال Weave. |
ReceiveErrorFunct)(WeaveConnection *con, WEAVE_ERROR err)
|
typedefvoid(*
هذه الدالة هي استدعاء التطبيق الذي تم استدعاؤه عند ظهور خطأ عند تلقّي رسالة Weave. |
State{
|
تعداد حالة كائن اتصال Weave. |
TunneledMsgReceiveFunct)(WeaveConnection *con, const WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
|
typedefvoid(*
هذه الدالة هي استدعاء التطبيق الذي تم استدعاؤه عند استلام حزمة بيانات نفق عبر اتصال Weave. |
السمات العامة |
|
---|---|
AppState
|
void *
مؤشر إلى كائن الحالة الخاص بالتطبيق.
|
AuthMode
|
WeaveAuthMode
[للقراءة فقط] وضع المصادقة المستخدم لإنشاء مفاتيح التشفير التلقائية للاتصال.
|
DefaultEncryptionType
|
uint8_t
نوع التشفير التلقائي للرسائل.
|
DefaultKeyId
|
uint16_t
مفتاح التشفير التلقائي المراد استخدامه عند إرسال الرسائل.
|
MessageLayer
|
[للقراءة فقط] الكائن WeaveMessageLayer المرتبط.
|
NetworkType
|
uint8_t
[للقراءة فقط] نوع شبكة نقطة النهاية المرتبطة.
|
OnConnectionClosed
|
|
OnConnectionComplete
|
|
OnMessageReceived
|
|
OnReceiveError
|
|
OnTunneledMessageReceived
|
|
PeerAddr
|
IPAddress
[للقراءة فقط] عنوان IP للعقدة المشابهة.
|
PeerNodeId
|
uint64_t
[للقراءة فقط] معرِّف العُقدة للنظراء.
|
PeerPort
|
uint16_t
[للقراءة فقط] رقم منفذ عقدة الزملاء.
|
ReceiveEnabled
|
bool
[للقراءة فقط] يتم الضبط على "صحيح" في حال تفعيل الاستلام، في حال لم يكن صحيحًا.
|
SendDestNodeId
|
bool
صحيح إذا كانت جميع الرسائل المرسلة عبر هذا الاتصال يجب أن تتضمن معرّف عقدة وجهة مشفرًا صراحةً، على "خطأ" بخلاف.
|
SendSourceNodeId
|
bool
صحيح إذا كانت جميع الرسائل المرسلة عبر هذا الاتصال يجب أن تتضمن معرّف عقدة مصدر مشفرًا صراحةً، أو "خطأ" بخلاف.
|
State
|
uint8_t
[للقراءة فقط] حالة الكائن WeaveConnection.
|
وظائف عامة |
|
---|---|
Abort(void)
|
void
يؤدّي هذا الخيار إغلاقًا سلسًا باستخدام WeaveConnection استنادًا إلى بروتوكول TCP أو BLE، مع تجاهل أي بيانات قد تكون أثناء الطيران من الصندوق وإليه.
|
AddRef(void)
|
void
حجز مرجع إلى كائن WeaveConnection.
|
Close(void)
|
إجراء إغلاق سلس لمنع حظر WeaveConnection المستند إلى بروتوكول TCP أو BLE، من خلال تقديم أي بيانات صادرة متبقية قبل إبلاغ المضيف البعيد عن بُعد إعادة ضبط الاتصال.
|
Close(bool suppressCloseLog)
|
إجراء إغلاق سلس لمنع حظر WeaveConnection المستند إلى بروتوكول TCP أو BLE، من خلال تقديم أي بيانات صادرة متبقية قبل إبلاغ المضيف البعيد عن بُعد إعادة ضبط الاتصال.
|
Connect(uint64_t peerNodeId)
|
اتصل بعقدة Weave باستخدام عنوان IP قماشي مشتق من معرّف العقدة المحدد.
|
Connect(uint64_t peerNodeId, const IPAddress & peerAddr, uint16_t peerPort)
|
الاتصال بعقدة Weave باستخدام معرِّف عقدة و/أو عنوان IP.
|
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, const IPAddress & peerAddr, uint16_t peerPort, InterfaceId intf)
|
الاتصال بعقدة Weave باستخدام معرّف عقدة و/أو عنوان IP على واجهة معيّنة.
|
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t defaultPort)
|
اتصل بعقدة Weave باستخدام معرِّف عقدة و/أو اسم مضيف سلسلة.
|
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t peerAddrLen, uint16_t defaultPort)
|
اتصل بعقدة Weave باستخدام معرّف عقدة و/أو عنوان نظير للسلسلة.
|
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t peerAddrLen, uint8_t dnsOptions, uint16_t defaultPort)
|
اتصل بعقدة Weave باستخدام معرّف عقدة و/أو عنوان نظير للسلسلة.
|
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, HostPortList hostPortList, InterfaceId intf)
|
اربط بعقدة Weave باستخدام معرِّف العقدة و/أو قائمة اسم المضيف والمنافذ.
|
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, HostPortList hostPortList, uint8_t dnsOptions, InterfaceId intf)
|
اربط بعقدة Weave باستخدام معرِّف العقدة و/أو قائمة اسم المضيف والمنافذ.
|
DisableKeepAlive(void)
|
|
DisableReceive(void)
|
void
إيقاف التلقي عبر WeaveConnection.
|
EnableKeepAlive(uint16_t interval, uint16_t timeoutCount)
|
|
EnableReceive(void)
|
void
تفعيل الاستلام عبر WeaveConnection.
|
GetPeerAddressInfo(IPPacketInfo & addrInfo)
|
الحصول على معلومات عنوان IP للأقران
|
GetPeerDescription(char *buf, size_t bufSize) const
|
void
إنشاء سلسلة تصف عقدة الزملاء المرتبطة بالاتصال.
|
GetTCPEndPoint(void) const
|
TCPEndPoint *
|
IsIncoming(void) const
|
bool
|
LogId(void) const
|
uint16_t
|
Release(void)
|
void
تقليل عدد المراجع على الكائن WeaveConnection.
|
ResetUserTimeout(void)
|
|
SendMessage(WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
|
إرسال رسالة Weave من خلال اتصال مُثبَت
|
SendTunneledMessage(WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
|
وظيفة لإرسال حزمة نفق عبر اتصال Weave.
|
SetConnectTimeout(const uint32_t connTimeoutMsecs)
|
void
يمكنك تحديد مهلة لكي تتمكّن "ملتقى المرشدين المحليين" من النجاح أو عرض رسالة خطأ.
|
SetIdleTimeout(uint32_t timeoutMS)
|
إعداد مهلة عدم النشاط على اتصال طبقة الشبكة الأساسية.
|
SetIncoming(bool val)
|
void
|
SetUserTimeout(uint32_t userTimeoutMillis)
|
|
Shutdown(void)
|
إجراء عملية إيقاف إرسال بروتوكول TCP أنيقة، لضمان إرسال جميع البيانات الصادرة واستلامها من خلال حزمة TCP's TCPs.
|
الأنواع المتاحة للجميع
@58
@58
أماكن إقامة | |
---|---|
kGetPeerDescription_MaxLength
|
الحد الأقصى لطول السلسلة (بما في ذلك حرف NUL) الذي يتم عرضه بواسطة GetPeerDescription(). |
قناة ConnectionClosedFunct
void(* ConnectionClosedFunct)(WeaveConnection *con, WEAVE_ERROR conErr)
هذه الدالة هي استدعاء التطبيق الذي تم استدعاؤه عند إغلاق الاتصال.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
FunCompleteFunct
void(* ConnectionCompleteFunct)(WeaveConnection *con, WEAVE_ERROR conErr)
وهذه الدالة هي استدعاء التطبيق الذي تم استدعاؤه عند اكتمال إعداد الاتصال.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
رسالة الاستلام
void(* MessageReceiveFunct)(WeaveConnection *con, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
هذه الدالة هي استدعاء التطبيق الذي تم استدعاؤه عند تلقي رسالة عبر اتصال Weave.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلَمات |
|
نوع الشبكة
NetworkType
نوع الشبكة لكائن اتصال Weave.
أماكن إقامة | |
---|---|
kNetworkType_BLE
|
نوع شبكة BLE |
kNetworkType_IP
|
نوع شبكة TCP/IP. |
kNetworkType_Unassigned
|
لم يتم تخصيص نوع الشبكة. |
GetErrorFunct
void(* ReceiveErrorFunct)(WeaveConnection *con, WEAVE_ERROR err)
هذه الدالة هي استدعاء التطبيق الذي تم استدعاؤه عند ظهور خطأ عند تلقّي رسالة Weave.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
الولاية
State
حالة كائن اتصال Weave.
أماكن إقامة | |
---|---|
kState_Closed
|
تحديد حالة إغلاق الاتصال. |
kState_Connected
|
تحديد وقت إنشاء الاتصال. |
kState_Connecting
|
يُرجى الإشارة إلى حالة محاولة الاتصال. |
kState_EstablishingSession
|
تحديد وقت إجراء جلسة آمنة. |
kState_ReadyToConnect
|
الحالة بعد إعداد اتصال Weave. |
kState_Resolving
|
تحديد حالة إجراء تحليل اسم نظام أسماء النطاقات. |
kState_SendShutdown
|
تحديد حالة انقطاع الاتصال |
تذكرة لأنبوب الاستقبال
void(* TunneledMsgReceiveFunct)(WeaveConnection *con, const WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
هذه الدالة هي استدعاء التطبيق الذي تم استدعاؤه عند استلام حزمة بيانات نفق عبر اتصال Weave.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلَمات |
|
السمات العامة
حالة التطبيق
void * AppState
مؤشر إلى كائن الحالة الخاص بالتطبيق.
وضع المصادقة
WeaveAuthMode AuthMode
[للقراءة فقط] وضع المصادقة المستخدم لإنشاء مفاتيح التشفير التلقائية للاتصال.
نوع التشفير الافتراضي
uint8_t DefaultEncryptionType
نوع التشفير التلقائي للرسائل.
معرّف المفتاح التلقائي
uint16_t DefaultKeyId
مفتاح التشفير التلقائي المراد استخدامه عند إرسال الرسائل.
نوع الشبكة
uint8_t NetworkType
[للقراءة فقط] نوع شبكة نقطة النهاية المرتبطة.
OnConnectionClosed
ConnectionClosedFunct OnConnectionClosed
OnConnectionComplete
ConnectionCompleteFunct OnConnectionComplete
OnMessageReceived
MessageReceiveFunct OnMessageReceived
خطأ في الاستلام
ReceiveErrorFunct OnReceiveError
OnTunneledMessageReceived
TunneledMsgReceiveFunct OnTunneledMessageReceived
قناة PeerAddr
IPAddress PeerAddr
[للقراءة فقط] عنوان IP للعقدة المشابهة.
رقم تعريف PeerNode
uint64_t PeerNodeId
[للقراءة فقط] معرِّف العُقدة للنظراء.
منفذ PeerPort
uint16_t PeerPort
[للقراءة فقط] رقم منفذ عقدة الزملاء.
EnableEnabled
bool ReceiveEnabled
[للقراءة فقط] يتم الضبط على "صحيح" في حال تفعيل الاستلام، في حال لم يكن صحيحًا.
SendDestNodeId
bool SendDestNodeId
صحيح إذا كانت جميع الرسائل المرسلة عبر هذا الاتصال يجب أن تتضمن معرّف عقدة وجهة مشفرًا صراحةً، على "خطأ" بخلاف.
SendSourceNodeId
bool SendSourceNodeId
صحيح إذا كانت جميع الرسائل المرسلة عبر هذا الاتصال يجب أن تتضمن معرّف عقدة مصدر مشفرًا صراحةً، أو "خطأ" بخلاف.
وظائف عامة
إلغاء
void Abort( void )
يؤدّي هذا الخيار إغلاقًا سلسًا باستخدام WeaveConnection استنادًا إلى بروتوكول TCP أو BLE، مع تجاهل أي بيانات قد تكون أثناء الطيران من الصندوق وإليه.
تؤدي مكالمة Abort() إلى إنهاء الاتصال الأساسي على الفور. بعد هذه المرحلة، لن يكون من الممكن استخدام كائن WeaveConnection لإجراء المزيد من الاتصالات.
يؤدي استدعاء Abort() إلى تقليل عدد المراجع المرتبطة بكائن WeaveConnection، سواء كان الاتصال مفتوحًا/نشطًا في وقت استدعاء الطريقة أم لا. إذا أدى ذلك إلى وصول عدد المراجع إلى صفر، يتم تحرير الموارد المرتبطة بكائن الاتصال. وعند حدوث ذلك، يجب ألا يكون للتطبيق أي تفاعلات أخرى مع الكائن.
يمكنك أيضًا الاطِّلاع على:Shutdown() وAbort() وAddRef() وRelease().
إضافة مرجع
void AddRef( void )
حجز مرجع إلى كائن WeaveConnection.
تزيد الطريقة AddRef() من عدد المراجع المرتبط بالكائن WeaveConnection. بالنسبة إلى كل استدعاء لـ AddRef()، يكون التطبيق مسؤولاً عن إجراء طلب مقابل لأي من Release() أو Close() أو Abort().
إغلاق
WEAVE_ERROR Close( void )
إجراء إغلاق سلس لمنع حظر WeaveConnection المستند إلى بروتوكول TCP أو BLE، من خلال تقديم أي بيانات صادرة متبقية قبل إبلاغ المضيف البعيد عن بُعد إعادة ضبط الاتصال.
لا تضمن هذه الطريقة استلام أي رسائل صادرة على مستوى بروتوكول التطبيق لم يتم قبولها على مستوى بروتوكول التطبيقات البعيدة. بالنسبة إلى كل من بروتوكولَي TCP وBLE، ستبذل حِزمة البروتوكول الأساسية أفضل جهد لتسليم أي بيانات صادرة في انتظار المراجعة قبل إعادة ضبط الاتصال. بالنسبة إلى بروتوكول TCP، يجب استخدام Shutdown() قبل Close() في حال كانت مطلوبة إيصال استلام رسالة طبقة النقل قبل إغلاق الاتصال. لا تقدم اتصالات BLE ما يعادل Shutdown().
بالنسبة إلى الاتصالات المستندة إلى بروتوكول BLE، يغلق Close() WeaveConnection ويتم إرجاعه على الفور، ولكنه قد يتسبب في بقاء كائن BLEEndPoint الأساسي حتى يتم إرسال جميع البيانات الصادرة. هذا تأثير جانبي لتطبيق بروتوكول النقل Weave over BLE الحالي ضمن Weave BleLayer.
بعد استدعاء Close()، لا يمكن استخدام الكائن WeaveConnection لإجراء المزيد من الاتصالات.
يقلل استدعاء Close() من عدد المراجع المرتبط بكائن WeaveConnection، سواء كان الاتصال مفتوحًا/نشطًا في وقت استدعاء الطريقة أم لا. إذا أدى ذلك إلى وصول عدد المراجع إلى صفر، يتم تحرير الموارد المرتبطة بكائن الاتصال. وعند حدوث ذلك، يجب ألا يكون للتطبيق أي تفاعلات أخرى مع الكائن.
التفاصيل | |
---|---|
المرتجعات |
WEAVE_NO_ERROR بدون شرط.
|
Shutdown() وAbort() وAddRef() وRelease().
إغلاق
WEAVE_ERROR Close( bool suppressCloseLog )
إجراء إغلاق سلس لمنع حظر WeaveConnection المستند إلى بروتوكول TCP أو BLE، من خلال تقديم أي بيانات صادرة متبقية قبل إبلاغ المضيف البعيد عن بُعد إعادة ضبط الاتصال.
لا تضمن هذه الطريقة استلام أي رسائل صادرة على مستوى بروتوكول التطبيق لم يتم قبولها على مستوى بروتوكول التطبيقات البعيدة. بالنسبة إلى كل من بروتوكولَي TCP وBLE، ستبذل حِزمة البروتوكول الأساسية أفضل جهد لتسليم أي بيانات صادرة في انتظار المراجعة قبل إعادة ضبط الاتصال. بالنسبة إلى بروتوكول TCP، يجب استخدام Shutdown() قبل Close() في حال كانت مطلوبة إيصال استلام رسالة طبقة النقل قبل إغلاق الاتصال. لا تقدم اتصالات BLE ما يعادل Shutdown().
بالنسبة إلى الاتصالات المستندة إلى بروتوكول BLE، يغلق Close() WeaveConnection ويتم إرجاعه على الفور، ولكنه قد يتسبب في بقاء كائن BLEEndPoint الأساسي حتى يتم إرسال جميع البيانات الصادرة. هذا تأثير جانبي لتطبيق بروتوكول النقل Weave over BLE الحالي ضمن Weave BleLayer.
بعد استدعاء Close()، لا يمكن استخدام الكائن WeaveConnection لإجراء المزيد من الاتصالات.
يقلل استدعاء Close() من عدد المراجع المرتبط بكائن WeaveConnection، سواء كان الاتصال مفتوحًا/نشطًا في وقت استدعاء الطريقة أم لا. إذا أدى ذلك إلى وصول عدد المراجع إلى صفر، يتم تحرير الموارد المرتبطة بكائن الاتصال. وعند حدوث ذلك، يجب ألا يكون للتطبيق أي تفاعلات أخرى مع الكائن.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
||
المرتجعات |
WEAVE_NO_ERROR بدون شرط.
|
Shutdown() وAbort() وAddRef() وRelease().
ربط
WEAVE_ERROR Connect( uint64_t peerNodeId )
اتصل بعقدة Weave باستخدام عنوان IP قماشي مشتق من معرّف العقدة المحدد.
التفاصيل | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||||
قيم الإرجاع |
|
ربط
WEAVE_ERROR Connect( uint64_t peerNodeId, const IPAddress & peerAddr, uint16_t peerPort )
الاتصال بعقدة Weave باستخدام معرِّف عقدة و/أو عنوان IP.
التفاصيل | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||||
قيم الإرجاع |
|
ربط
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, const IPAddress & peerAddr, uint16_t peerPort, InterfaceId intf )
الاتصال بعقدة Weave باستخدام معرّف عقدة و/أو عنوان IP على واجهة معيّنة.
التفاصيل | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||||
قيم الإرجاع |
|
ربط
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t defaultPort )
اتصل بعقدة Weave باستخدام معرِّف عقدة و/أو اسم مضيف سلسلة.
في حال توفّره، يمكن أن تكون divAddr أيًا من:
: : [ ]:
التفاصيل | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||||
قيم الإرجاع |
|
ربط
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t peerAddrLen, uint16_t defaultPort )
اتصل بعقدة Weave باستخدام معرّف عقدة و/أو عنوان نظير للسلسلة.
في حال توفّره، يمكن أن تكون divAddr أيًا من:
: : [ ]:
التفاصيل | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||||
قيم الإرجاع |
|
ربط
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t peerAddrLen, uint8_t dnsOptions, uint16_t defaultPort )
اتصل بعقدة Weave باستخدام معرّف عقدة و/أو عنوان نظير للسلسلة.
في حال توفّره، يمكن أن تكون divAddr أيًا من:
: : [ ]:
التفاصيل | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||||||
قيم الإرجاع |
|
ربط
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, HostPortList hostPortList, InterfaceId intf )
اربط بعقدة Weave باستخدام معرِّف العقدة و/أو قائمة اسم المضيف والمنافذ.
التفاصيل | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||||
قيم الإرجاع |
|
ربط
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, HostPortList hostPortList, uint8_t dnsOptions, InterfaceId intf )
اربط بعقدة Weave باستخدام معرِّف العقدة و/أو قائمة اسم المضيف والمنافذ.
التفاصيل | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||||
قيم الإرجاع |
|
إيقاف KeepAlive
WEAVE_ERROR DisableKeepAlive( void )
WeaveConnection::DisableKeepAlive.
إيقاف تحقيقات التحقّق من الاتصال عبر بروتوكول TCP في اتصال بروتوكول TCP الأساسي.
ملاحظة: لا يمكن استدعاء هذه الطريقة إلا من خلال اتصال Weave مدعوم باتصال TCP. لا يمكن استدعاء هذه الطريقة إلا عندما يكون الاتصال في حالة تسمح بالإرسال.
لا تفعل هذه الطريقة أي شيء إذا لم يتم تفعيل رسائل التحقق من الاتصال في الاتصال.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
قيم الإرجاع |
|
إيقاف الاستلام
void DisableReceive( void )
إيقاف التلقي عبر WeaveConnection.
يستخدم التطبيق هذه الطريقة للإشارة إلى أنها ليست جاهزة لتلقي أي بيانات واردة من خلال اتصال بروتوكول TCP. لإعادة تفعيل التلقي، يحتاج التطبيق إلى استدعاء EnableReceived() للسماح لـ WeaveConnection بتسليم أي بيانات مستلمة عن طريق استدعاء عمليات استدعاء مناسبة.
يُرجى الاطِّلاع أيضًا على:EnableReceived()
تفعيل KeepAlive
WEAVE_ERROR EnableKeepAlive( uint16_t interval, uint16_t timeoutCount )
WeaveConnection::EnableKeepAlive.
تفعيل تحقيقات التحقّق من الاتصال عبر بروتوكول TCP في اتصال بروتوكول TCP الأساسي.
ملاحظة:- لا يمكن استدعاء هذه الطريقة إلا من خلال اتصال Weave متوافق مع اتصال TCP. - لا يمكن استدعاء هذه الطريقة إلا عندما يكون الاتصال في حالة تسمح بالإرسال.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
- يمكن استدعاء هذه الطريقة عدة مرات لضبط الفاصل الزمني لرسالة التحقّق من الاتصال أو عدد المهلة.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
قيم الإرجاع |
|
تفعيل الاستلام
void EnableReceive( void )
تفعيل الاستلام عبر WeaveConnection.
يستخدم هذا التطبيق التطبيق للإشارة إلى عنصر WeaveConnection بأنه جاهز لتلقي أي بيانات تصل عبر اتصال TCP.
يمكنك أيضًا الاطِّلاع على ما يلي:DisableReceive()
الحصول على معلومات العنوان
WEAVE_ERROR GetPeerAddressInfo( IPPacketInfo & addrInfo )
الحصول على معلومات عنوان IP للأقران
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
||||
قيم الإرجاع |
|
وصف GetPeer
void GetPeerDescription( char *buf, size_t bufSize ) const
إنشاء سلسلة تصف عقدة الزملاء المرتبطة بالاتصال.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
GetTCPEndPoint
TCPEndPoint * GetTCPEndPoint( void ) const
واردة
bool IsIncoming( void ) const
رقم تعريف التسجيل
uint16_t LogId( void ) const
عند إصدار العمل الفنّي
void Release( void )
تقليل عدد المراجع على الكائن WeaveConnection.
تُنقص طريقة Release() العدد المرجعي المرتبط بالكائن WeaveConnection. وإذا أدى ذلك إلى بلوغ عدد المراجع صفرًا، يتم إغلاق الاتصال وتحرير كائن الاتصال. وعند حدوث ذلك، يجب ألا يكون للتطبيق أي تفاعلات أخرى مع الكائن.
إعادة ضبط مهلة المستخدم
WEAVE_ERROR ResetUserTimeout( void )
WeaveConnection::ResetUserTimeout.
إعادة ضبط خيار مقبس مهلة مستخدم TCP على الإعداد التلقائي للنظام.
ملاحظة:- لا يمكن استدعاء هذه الطريقة إلا من خلال اتصال Weave متوافق مع اتصال TCP. - لا يمكن استدعاء هذه الطريقة إلا عندما يكون الاتصال في حالة تسمح بالإرسال.
-لا تفعل هذه الطريقة أي شيء إذا لم يتم تعيين مهلة المستخدم على الاتصال.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
قيم الإرجاع |
|
إرسال رسالة
WEAVE_ERROR SendMessage( WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
إرسال رسالة Weave من خلال اتصال مُثبَت
التفاصيل | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||||
قيم الإرجاع |
|
إرسال رسالة نفقية
WEAVE_ERROR SendTunneledMessage( WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
وظيفة لإرسال حزمة نفق عبر اتصال Weave.
إرسال رسالة Weave نفقية عبر اتصال منشأ.
التفاصيل | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
المعلَمات |
|
||||||||||
قيم الإرجاع |
|
تحديد مهلة الاتصال
void SetConnectTimeout( const uint32_t connTimeoutMsecs )
يمكنك تحديد مهلة لكي تتمكّن "ملتقى المرشدين المحليين" من النجاح أو عرض رسالة خطأ.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
تحديد مهلة
WEAVE_ERROR SetIdleTimeout( uint32_t timeoutMS )
إعداد مهلة عدم النشاط على اتصال طبقة الشبكة الأساسية.
التفاصيل | |||||
---|---|---|---|---|---|
المعلَمات |
|
||||
قيم الإرجاع |
|
ضبط الوارد
void SetIncoming( bool val )
تحديد مهلة المستخدم
WEAVE_ERROR SetUserTimeout( uint32_t userTimeoutMillis )
WeaveConnection::SetUserTimeout.
حدِّد خيار مقبس مهلة مستخدم TCP.
عندما تكون القيمة أكبر من 0، فإنها تحدد الحد الأقصى للمدة بالمللي ثانية التي قد تظل فيها البيانات المنقولة غير معروفة قبل إغلاق TCP بفرض الاتصال المقابل. إذا تم تحديد قيمة الخيار على 0، سيستخدم TCP القيمة التلقائية للنظام. اطّلِع على RFC 5482 لمزيد من التفاصيل.
التفاصيل | |||
---|---|---|---|
المعلَمات |
|
ملاحظة:- لا يمكن استدعاء هذه الطريقة إلا من خلال اتصال Weave متوافق مع اتصال TCP. - لا يمكن استدعاء هذه الطريقة إلا عندما يكون الاتصال في حالة تسمح بالإرسال.
- يمكن استدعاء هذه الطريقة عدة مرات لتعديل مهلة مستخدم TCP.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
قيم الإرجاع |
|
إيقاف التشغيل
WEAVE_ERROR Shutdown( void )
إجراء عملية إيقاف إرسال بروتوكول TCP أنيقة، لضمان إرسال جميع البيانات الصادرة واستلامها من خلال حزمة TCP's TCPs.
مع معظم عمليات تنفيذ بروتوكول TCP (وليس كلها)، سيؤدي استلام إيقاف تشغيل الإرسال إلى إيقاف المضيف عن بُعد أيضًا من جانب الاتصال، مما يؤدي إلى إغلاق الاتصال. ستؤدي المكالمة التالية إلى Close() إلى إنهاء WeaveConnection.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
قيم الإرجاع |
|
Close() وAbort().