nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::ConnectRequest

#include <src/lib/profiles/service-directory/ServiceDirectory.h>

وتمثّل هذه الفئة معاملة واحدة يُديرها مدير الخدمة.

ملخّص

السمات العامة

mAppState
void *
mAuthMode
WeaveAuthMode
mConnIntf
InterfaceId
الواجهة التي سيتم إعداد الاتصال عليها.
mConnectTimeoutMsecs
uint32_t
المهلة قبل نجاح استدعاء الاتصال أو عرض خطأ.
mConnection
اتصال للتخزين هنا أثناء انتظار اكتماله.
mConnectionCompleteHandler
يشير ذلك المصطلح إلى مؤشر يشير إلى دالة يمكن استدعاؤها عند اكتمال الاتصال بنقطة نهاية الخدمة الوجهة.
mServiceEp
uint64_t
mStatusHandler
يشير ذلك المصطلح إلى مؤشر يشير إلى دالة يمكن استدعاؤها عند تلقّي تقرير حالة.

الدوال العامة

finalize(void)
void
تنظّف هذه الطريقة الحالة الداخلية، بما في ذلك إغلاق الاتصال.
free(void)
void
تؤدي هذه الطريقة إلى تحرير كائن طلب الاتصال، وإعادته إلى المجموعة.
init(WeaveServiceManager *aManager, const uint64_t & aServiceEp, WeaveAuthMode aAuthMode, void *aAppState, StatusHandler aStatusHandler, WeaveConnection::ConnectionCompleteFunct aCompleteHandler, const uint32_t aConnectTimeoutMsecs, const InterfaceId aConnIntf)
تعمل هذه الطريقة على إعداد مثيل ConnectRequest مع الوسيطات التي تم تمريرها.
isAllocatedTo(const uint64_t & aServiceEp, void *aAppState)
bool
تختبر هذه الدالة ما إذا كان طلب الاتصال هذا قيد الاستخدام حاليًا للاتصال بنقطة نهاية خدمة معيّنة لكيان تطبيق معيّن.
isFree(void)
bool
تختبر هذه الدالة ما إذا كان طلب الربط غير مخصص حاليًا.
onConnectionComplete(WEAVE_ERROR aError)
void
تُستخدم هذه الطريقة في نقل الترامبولين إلى طبقة التطبيق لحدث اكتمل الربط.

السمات العامة

mAppState

void * mAppState

mAuthMode

WeaveAuthMode mAuthMode

mConnIntf

InterfaceId mConnIntf

الواجهة التي سيتم إعداد الاتصال عليها.

mConnectTimeoutMsecs

uint32_t mConnectTimeoutMsecs

المهلة قبل نجاح استدعاء الاتصال أو عرض خطأ.

mConnection

WeaveConnection * mConnection

اتصال للتخزين هنا أثناء انتظار اكتماله.

mConnectionCompleteHandler

WeaveConnection::ConnectionCompleteFunct mConnectionCompleteHandler

يشير ذلك المصطلح إلى مؤشر يشير إلى دالة يمكن استدعاؤها عند اكتمال الاتصال بنقطة نهاية الخدمة الوجهة.

mServiceEp

uint64_t mServiceEp

mStatusHandler

StatusHandler mStatusHandler

يشير ذلك المصطلح إلى مؤشر يشير إلى دالة يمكن استدعاؤها عند تلقّي تقرير حالة.

الدوال العامة

finalize

void finalize(
  void
)

تنظّف هذه الطريقة الحالة الداخلية، بما في ذلك إغلاق الاتصال.

مجانًا

void free(
  void
)

تؤدي هذه الطريقة إلى تحرير كائن طلب الاتصال، وإعادته إلى المجموعة.

init

WEAVE_ERROR init(
  WeaveServiceManager *aManager,
  const uint64_t & aServiceEp,
  WeaveAuthMode aAuthMode,
  void *aAppState,
  StatusHandler aStatusHandler,
  WeaveConnection::ConnectionCompleteFunct aCompleteHandler,
  const uint32_t aConnectTimeoutMsecs,
  const InterfaceId aConnIntf
)

تعمل هذه الطريقة على إعداد مثيل ConnectRequest مع الوسيطات التي تم تمريرها.

التفاصيل
المَعلمات
[in] aManager
مؤشر إلى مدير الخدمة الذي يتضمن الصورة
[in] aServiceEp
رقم تعريف لنقطة نهاية الخدمة المقصودة لطلب الاتصال هذا.
[in] aAuthMode
واصف لطريقة المصادقة التي يجب استخدامها لهذا الاتصال.
[in] aAppState
يشير ذلك المصطلح إلى مؤشر عشوائي يتم تمريره مرة أخرى في عمليات معاودة الاتصال.
[in] aStatusHandler
يشير ذلك المصطلح إلى مؤشر لدالة معاودة الاتصال يعالج تقرير الحالة استجابةً لطلب بحث في نقطة نهاية الخدمة.
[in] aCompleteHandler
يشير ذلك المصطلح إلى مؤشر لدالة معاودة الاتصال التي تعالج حدث اكتمال الاتصال.
[in] aConnectTimeoutMsecs
المهلة قبل نجاح استدعاء الاتصال أو عرض خطأ.
[in] aConnectIntf
تمثّل هذه السمة الواجهة التي سيتم إنشاء الاتصال من خلالها.
المرتجعات
WEAVE_NO_ERROR عند النجاح، وبخلاف ذلك، يتم عرض رمز خطأ ذي صلة.

isAllocatedTo

bool isAllocatedTo(
  const uint64_t & aServiceEp,
  void *aAppState
)

تختبر هذه الدالة ما إذا كان طلب الاتصال هذا قيد الاستخدام حاليًا للاتصال بنقطة نهاية خدمة معيّنة لكيان تطبيق معيّن.

التفاصيل
المَعلمات
[in] aServiceEp
رقم تعريف نقطة نهاية خدمة تتم مقارنته بما يتضمنه طلب الربط هذا.
[in] aAppState
يشير هذا المصطلح إلى مؤشر لحالة التطبيق، ويتم استخدامه للمقارنة بما يتضمّنه طلب الربط هذا.
المرتجعات
true إذا اجتاز الاختبار، أو false إذا لم ينجح ذلك.

isFree

bool isFree(
  void
)

تختبر هذه الدالة ما إذا كان طلب الربط غير مخصص حاليًا.

التفاصيل
المرتجعات
true إذا اجتاز الاختبار، أو false إذا لم ينجح ذلك.

onConnectionComplete

void onConnectionComplete(
  WEAVE_ERROR aError
)

تُستخدم هذه الطريقة في نقل الترامبولين إلى طبقة التطبيق لحدث اكتمل الربط.

تستدعي معالج اكتمال الاتصال المعين في lookupAndConnect() .