gpg:: NearbyConnections
#include <nearby_connections.h>
يشير ذلك المصطلح إلى واجهة برمجة تطبيقات يتم استخدامها لإنشاء الاتصالات والتواصل بين التطبيقات على الشبكة المحلية نفسها.
ملخّص
الشركات المصنّعة والمُصنّعة |
|
---|---|
NearbyConnections()
|
|
~NearbyConnections()
|
وظائف عامة |
|
---|---|
AcceptConnectionRequest(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, IMessageListener *listener)
|
void
يقبل طلب الربط.
|
AcceptConnectionRequest(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, MessageListenerHelper helper)
|
void
يقبل طلب الربط.
|
Disconnect(const std::string & remote_endpoint_id)
|
void
يتم قطع الاتصال بنقطة النهاية البعيدة باستخدام المعرّف المحدّد.
|
RejectConnectionRequest(const std::string & remote_endpoint_id)
|
void
يرفض طلب اتصال.
|
SendConnectionRequest(const std::string & name, const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, ConnectionResponseCallback callback, IMessageListener *listener)
|
void
تطلب إنشاء اتصال باستخدام نقطة نهاية بعيدة.
|
SendConnectionRequest(const std::string & name, const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, ConnectionResponseCallback callback, MessageListenerHelper helper)
|
void
تطلب الاتصال بنقطة نهاية بعيدة.
|
SendReliableMessage(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload)
|
void
تُرسِل رسالة موثوقة إلى نقطة النهاية البعيدة باستخدام المعرّف المحدّد.
|
SendReliableMessage(const std::vector< std::string > & remote_endpoint_ids, const std::vector< uint8_t > & payload)
|
void
تُرسِل رسالة موثوقة إلى نقاط النهاية البعيدة باستخدام أرقام التعريف المحدّدة.
|
SendUnreliableMessage(const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload)
|
void
تُرسِل رسالة غير موثوقة إلى نقطة النهاية البعيدة باستخدام المعرّف المحدَّد.
|
SendUnreliableMessage(const std::vector< std::string > & remote_endpoint_ids, const std::vector< uint8_t > & payload)
|
void
تُرسِل رسالة غير موثوق بها إلى نقاط النهاية البعيدة باستخدام أرقام التعريف المحدَّدة.
|
StartAdvertising(const std::string & name, const std::vector< AppIdentifier > & app_identifiers, Duration duration, StartAdvertisingCallback start_advertising_callback, ConnectionRequestCallback request_callback)
|
void
يبدأ الإعلان عن نقطة نهاية لتطبيق محلي.
|
StartDiscovery(const std::string & service_id, Duration duration, IEndpointDiscoveryListener *listener)
|
void
يعثر على نقاط النهاية البعيدة باستخدام معرّف الخدمة المحدّد، ويستدعي المستمع بشكل متكرر عندما يعثر التطبيق على نقاط النهاية ويفقدها.
|
StartDiscovery(const std::string & service_id, Duration duration, EndpointDiscoveryListenerHelper helper)
|
void
تبحث عن نقاط النهاية البعيدة باستخدام معرّف الخدمة المحدّد.
|
Stop()
|
void
انقطاع الاتصال بجميع نقاط النهاية البعيدة ويوقف أي إعلان أو اكتشاف يحدث.
|
StopAdvertising()
|
void
لإيقاف الإعلان عن نقطة النهاية المحلية.
|
StopDiscovery(const std::string & service_id)
|
void
لإيقاف العثور على نقاط نهاية بعيدة لمعرّف خدمة محدّد مسبقًا.
|
صفوف |
|
---|---|
gpg:: |
الفئة Builder التي تُستخدَم لإنشاء عناصر NearbyConnections. |
وظائف عامة
AcceptConnectionRequest
void AcceptConnectionRequest( const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, IMessageListener *listener )
يقبل طلب الربط.
بعد ذلك، يمكن للتطبيق إرسال رسائل إلى نقطة النهاية المحددة واستلامها منها. ويمكنها إجراء ذلك باستخدام listener
إلى أن ينقطع اتصال التطبيق بنقطة النهاية الأخرى. يجب أن يتطابق remote_endpoint_id
مع رقم تعريف نقطة النهاية البعيدة التي طلبت الاتصال. يوفّر ConnectionRequestCallback
رقم التعريف هذا. يمكن لـ "payload
" تجميد الرسالة لإرسالها مع رد الاتصال. تُحدِّد الدالة listener
أداة استماع يتم إشعارها بالأحداث الخاصة بعملية الربط هذه.
AcceptConnectionRequest
void AcceptConnectionRequest( const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, MessageListenerHelper helper )
يقبل طلب الربط.
تختلف هذه الدالة عن AcceptConnectionRequest
فقط في أنّها تستخدم MessageListenerHelper
، بدلاً من IMessageListener
.
قطع الاتصال
void Disconnect( const std::string & remote_endpoint_id )
يتم قطع الاتصال بنقطة النهاية البعيدة باستخدام المعرّف المحدّد.
NearbyConnections
NearbyConnections()
RejectConnectionRequest
void RejectConnectionRequest( const std::string & remote_endpoint_id )
يرفض طلب اتصال.
يجب أن يتطابق remote_endpoint_id
مع رقم تعريف نقطة النهاية البعيدة التي طلبت الاتصال. يوفّر ConnectionRequestCallback
رقم التعريف هذا.
SendConnectionRequest
void SendConnectionRequest( const std::string & name, const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, ConnectionResponseCallback callback, IMessageListener *listener )
تطلب إنشاء اتصال باستخدام نقطة نهاية بعيدة.
name
هو اسم يمكن للتطبيق عرضه للمستخدمين على الجهاز الآخر لتحديد نقطة النهاية هذه. إذا حدَّدت سلسلة فارغة، سيتم استخدام اسم الجهاز. remote_endpoint_id
هو رقم تعريف نقطة النهاية البعيدة التي يرسل إليها هذا التطبيق طلبًا للاتصال. يمكن لـ "payload
" تجميد رسالة مخصّصة لإرسالها مع طلب الربط. بدلاً من حمولة البيانات، يمكن لتطبيقك تمرير متجه بايت فارغ. تستدعي هذه الدالة معاودة الاتصال المحددة استجابةً للطلب. إذا نجحت العملية، فسوف تعرض رسالة "تم قبول الاتصال" أو "تم رفض الاتصال" الاستجابة. وإلّا، فسيتم إنشاء رسالة إخفاق. في حال توفّر اتصال مقبول، يمكن للتطبيق إرسال رسائل إلى نقطة النهاية البعيدة، ويستدعي التطبيق المستمع المحدَّد عند استلام رسالة أو انقطاع الاتصال بنقطة النهاية البعيدة.
SendConnectionRequest
void SendConnectionRequest( const std::string & name, const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload, ConnectionResponseCallback callback, MessageListenerHelper helper )
تطلب الاتصال بنقطة نهاية بعيدة.
يختلف عن SendConnectionRequest
فقط من حيث استخدام MessageListenerHelper
بدلاً من IMessageListener
.
SendReliableMessage
void SendReliableMessage( const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload )
تُرسِل رسالة موثوقة إلى نقطة النهاية البعيدة باستخدام المعرّف المحدّد.
SendReliableMessage
void SendReliableMessage( const std::vector< std::string > & remote_endpoint_ids, const std::vector< uint8_t > & payload )
تُرسِل رسالة موثوقة إلى نقاط النهاية البعيدة باستخدام أرقام التعريف المحدّدة.
SendUnreliableMessage
void SendUnreliableMessage( const std::string & remote_endpoint_id, const std::vector< uint8_t > & payload )
تُرسِل رسالة غير موثوقة إلى نقطة النهاية البعيدة باستخدام المعرّف المحدَّد.
SendUnreliableMessage
void SendUnreliableMessage( const std::vector< std::string > & remote_endpoint_ids, const std::vector< uint8_t > & payload )
تُرسِل رسالة غير موثوق بها إلى نقاط النهاية البعيدة باستخدام أرقام التعريف المحدَّدة.
StartAdvertising
void StartAdvertising( const std::string & name, const std::vector< AppIdentifier > & app_identifiers, Duration duration, StartAdvertisingCallback start_advertising_callback, ConnectionRequestCallback request_callback )
يبدأ الإعلان عن نقطة نهاية لتطبيق محلي.
يمكن أن تكون name
اسمًا يعرضه التطبيق للمستخدمين لتحديد نقطة النهاية. إذا حدَّدت سلسلة فارغة، سيتم استخدام اسم الجهاز. وفي حال تحديد السياسة، سيحدّد app_identifiers
طريقة تثبيت هذا التطبيق أو تشغيله على أنظمة أساسية مختلفة. تحدّد duration
المدة (بالمللي ثانية) التي سيتم خلالها عرض الإعلان، ما لم يستدعي التطبيق StopAdvertising()
أو Stop()
قبل انتهاء المدة. إذا كانت قيمة duration
تساوي gpg::Duration::zero()
، سيستمر عرض الإعلانات إلى أجل غير مسمى إلى أن يطلب التطبيق StopAdvertising()
. تستدعي هذه الدالة start_advertising_callback
عند بدء الإعلان أو تعذُّر عرضه. يتلقى رد الاتصال هذا معلومات نقطة النهاية عند النجاح أو رمز خطأ عند الفشل. تستدعي هذه الدالة request_callback
عندما تطلب نقطة نهاية عن بُعد اتصالاً بنقطة نهاية التطبيق. تواصل هذه الدالة الإعلان عن توفّر نقطة النهاية هذه إلى أن يطلب التطبيق StopAdvertising
أو تنقضي المدة. إذا سبق أن تم الإعلان عن نقطة نهاية، لن تنجح عملية الاتصال هذه.
StartDiscovery
void StartDiscovery( const std::string & service_id, Duration duration, IEndpointDiscoveryListener *listener )
يعثر على نقاط النهاية البعيدة باستخدام معرّف الخدمة المحدّد، ويستدعي المستمع بشكل متكرر عندما يعثر التطبيق على نقاط النهاية ويفقدها.
يستمر ذلك إلى أن يستدعي التطبيق StopDiscovery
باستخدام معرّف الخدمة المحدّد. يجب أن تتطابق السمة service_id
مع القيمة التي تقدّمها التطبيقات عند عرض الإعلانات من خلال StartAdvertising
. تحدّد duration
الحد الأقصى لمدة الاكتشاف (بالمللي ثانية) لبدء تشغيل الاكتشاف (قد يتوقف بشكل أسرع إذا استدعى التطبيق StopDiscovery()
). إذا كانت قيمة Duration
تساوي gpg::Duration::zero()
، ستستمر عملية الاكتشاف إلى أجل غير مسمى إلى أن يطلب التطبيق StopDiscovery()
أو Stop()
. إذا سبق أن تم تسجيل أداة معالجة ملاحظات للعثور على نقاط نهاية لمعرّف الخدمة المحدّد، سيتعذّر إجراء هذا الطلب.
StartDiscovery
void StartDiscovery( const std::string & service_id, Duration duration, EndpointDiscoveryListenerHelper helper )
تبحث عن نقاط النهاية البعيدة باستخدام معرّف الخدمة المحدّد.
تختلف هذه الدالة عن StartDiscovery
فقط في أنّها تستخدم EndpointDiscoveryListenerHelper
بدلاً من IEndpointDiscoveryListener
.
إيقاف
void Stop()
انقطاع الاتصال بجميع نقاط النهاية البعيدة ويوقف أي إعلان أو اكتشاف يحدث.
محو الحالة الداخلية.
StopAdvertising
void StopAdvertising()
لإيقاف الإعلان عن نقطة النهاية المحلية.
ولا يؤدي ذلك إلى قطع الاتصالات الحالية.
StopDiscovery
void StopDiscovery( const std::string & service_id )
لإيقاف العثور على نقاط نهاية بعيدة لمعرّف خدمة محدّد مسبقًا.
~NearbyConnections
~NearbyConnections()