nl::Weave::Profiles::BDX_Development::BdxNode

ملخّص

الشركات المصنّعة والمُصنّعة
BdxNode(void)
الدالة الإنشائية التلقائية التي تعين كل الأعضاء على "NULL" (فارغة).

وظائف عامة
AllowBdxTransferToRun(bool aEnable)
void
استخدِم هذا الزر لتفعيل خادم BDX أو إيقافه بدون إغلاقه بالكامل وإعادة تشغيله.
AwaitBdxReceiveInit(ReceiveInitHandler aReceiveInitHandler)
AwaitBdxSendInit(SendInitHandler aSendInitHandler)
CanBdxTransferRun(void)
bool
يتم عرض القيمة "صحيح" في حال السماح لخادم BDX ببدء عملية النقل في الوقت الحالي، وعلى القيمة "خطأ" في الحالات الأخرى.
Init(WeaveExchangeManager *anExchangeMgr)
ضع جميع عمليات النقل في حالة تلقائية جاهزة للاستخدام، وخزِّن WeaveExchangeManager وأي موارد Weave ضرورية، واضبط السمةallowBdxTransferToRun(true).
InitBdxReceive(BDXTransfer & aXfer, bool aICanDrive, bool aUCanDrive, bool aAsyncOk, ReferencedTLVData *aMetaData)
InitBdxSend(BDXTransfer & aXfer, bool aICanDrive, bool aUCanDrive, bool aAsyncOk, ReferencedTLVData *aMetaData)
InitBdxSend(BDXTransfer & aXfer, bool aICanDrive, bool aUCanDrive, bool aAsyncOk, SendInit::MetaDataTLVWriteCallback aMetaDataWriteCallback, void *aMetaDataAppState)
IsInitialized(void)
bool
تعرض القيمة "صحيح" إذا تم إعداد BdxNode هذا من قبل.
NewTransfer(Binding *aBinding, BDXHandlers aBDXHandlers, ReferencedString & aFileDesignator, void *anAppState, BDXTransfer *& aXfer)
يمكنك الحصول على عملية BDXTransfer جديدة وإعدادها من مجموعة النقل في حال توفّرها، أو ضبطها على "NULL" بخلاف ذلك وعرض رسالة خطأ.
NewTransfer(WeaveConnection *aCon, BDXHandlers aBDXHandlers, ReferencedString & aFileDesignator, void *anAppState, BDXTransfer *& aXfer)
يمكنك الحصول على عملية BDXTransfer جديدة وإعدادها من مجموعة النقل في حال توفّرها، أو ضبطها على "NULL" بخلاف ذلك وعرض رسالة خطأ.
Shutdown(void)
يوقف جميع عمليات النقل ويطلق أي موارد Weave (يعين حاليًا mExchangeMgr على NULL).

الدوال الثابتة العامة
HandleReceiveInit(ExchangeContext *anEc, const IPPacketInfo *aPktInfo, const WeaveMessageInfo *aWeaveMsgInfo, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer *aPacketBuffer)
void
HandleSendInit(ExchangeContext *anEc, const IPPacketInfo *aPktInfo, const WeaveMessageInfo *aWeaveMsgInfo, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer *aPacketBuffer)
void
ShutdownTransfer(BDXTransfer *aXfer)
void
أوقِف كائن النقل المحدَّد وأعِده إلى وحدة التحكّم.

وظائف عامة

AllowBdxTransferToRun

void AllowBdxTransferToRun(
  bool aEnable
)

استخدِم هذا الزر لتفعيل خادم BDX أو إيقافه بدون إغلاقه بالكامل وإعادة تشغيله.

التفاصيل
المعلمات
[in] aEnable
تفعيل (صحيح) أو إيقافه (خطأ)

AwaitBdxReceiveInit

WEAVE_ERROR AwaitBdxReceiveInit(
  ReceiveInitHandler aReceiveInitHandler
)

AwaitBdxSendInit

WEAVE_ERROR AwaitBdxSendInit(
  SendInitHandler aSendInitHandler
)

BdxNode

 BdxNode(
  void
)

الدالة الإنشائية التلقائية التي تعين كل الأعضاء على "NULL" (فارغة).

لا تحاول أن تفعل أي شيء مع الخادم حتى تقوم على الأقل باستدعاء init().

CanBdxTransferRun

bool CanBdxTransferRun(
  void
)

يتم عرض القيمة "صحيح" في حال السماح لخادم BDX ببدء عملية النقل في الوقت الحالي، وعلى القيمة "خطأ" في الحالات الأخرى.

التفاصيل
المرتجعات
صحيح إذا كان نقل BDX مسموحًا به، وخطأ إذا لم يكن

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *anExchangeMgr
)

ضع جميع عمليات النقل في حالة تلقائية جاهزة للاستخدام، وخزِّن WeaveExchangeManager وأي موارد Weave ضرورية، واضبط السمةallowBdxTransferToRun(true).

التفاصيل
المعلمات
[in] anExchangeMgr
مدير تبادل لاستخدامه في عملية النقل المجمّع هذه.
قيم الإرجاع
WEAVE_NO_ERROR
إذا كانت ناجحة
WEAVE_ERROR_INCORRECT_STATE
إذا لم يكن mExchangeMgr فارغًا، فهذا يعني أنّه تم إعداده من قبل

InitBdxReceive

WEAVE_ERROR InitBdxReceive(
  BDXTransfer & aXfer,
  bool aICanDrive,
  bool aUCanDrive,
  bool aAsyncOk,
  ReferencedTLVData *aMetaData
)

InitBdxSend

WEAVE_ERROR InitBdxSend(
  BDXTransfer & aXfer,
  bool aICanDrive,
  bool aUCanDrive,
  bool aAsyncOk,
  ReferencedTLVData *aMetaData
)

InitBdxSend

WEAVE_ERROR InitBdxSend(
  BDXTransfer & aXfer,
  bool aICanDrive,
  bool aUCanDrive,
  bool aAsyncOk,
  SendInit::MetaDataTLVWriteCallback aMetaDataWriteCallback,
  void *aMetaDataAppState
)

IsInitialized

bool IsInitialized(
  void
)

تعرض القيمة "صحيح" إذا تم إعداد BdxNode هذا من قبل.

التفاصيل
المرتجعات
true إذا تم إعداد هذا الكائن

NewTransfer

WEAVE_ERROR NewTransfer(
  Binding *aBinding,
  BDXHandlers aBDXHandlers,
  ReferencedString & aFileDesignator,
  void *anAppState,
  BDXTransfer *& aXfer
)

يمكنك الحصول على عملية BDXTransfer جديدة وإعدادها من مجموعة النقل في حال توفّرها، أو ضبطها على "NULL" بخلاف ذلك وعرض رسالة خطأ.

التفاصيل
المعلمات
[in] aBinding
الربط بالعقدة التي سيتم بدء عملية النقل بها. وتُستخدم لإنشاء ExchangeContext مرتبط بعملية النقل هذه.
[in] aBDXHandlers
بنية معالِجات معاودة الاتصال بـ BDX سيتم طلبها أثناء النقل
[in] aFileDesignator
محدّد الملف للملف الذي سيتم نقله.
[in] anAppState
عنصر حالة خاص بالتطبيق يتم إرفاقه بـ BDXTransfer لكي يستخدمه تطبيق المستخدم وعمليات معاودة الاتصال المرتبطة به.
[in] aXfer
يشير هذا المصطلح إلى مؤشر مرّ عليه التوجيه إلى الكائن BDXTransfer الجديد في حال توفّره، غير أنّ NULL.
قيم الإرجاع
WEAVE_NO_ERROR
في حال العثور على عملية BDXTransfer جديدة.
WEAVE_ERROR_NO_MEMORY
في حال تعذّر إنشاء ExchangeContext
WEAVE_ERROR_TOO_MANY_CONNECTIONS
إذا كان هناك عدد كبير جدًا من عمليات النقل نشطة حاليًا وكان aXfer يكون "NULL" (فارغ)
WEAVE_ERROR_INCORRECT_STATE
في حال عدم إعداد الربط

NewTransfer

WEAVE_ERROR NewTransfer(
  WeaveConnection *aCon,
  BDXHandlers aBDXHandlers,
  ReferencedString & aFileDesignator,
  void *anAppState,
  BDXTransfer *& aXfer
)

يمكنك الحصول على عملية BDXTransfer جديدة وإعدادها من مجموعة النقل في حال توفّرها، أو ضبطها على "NULL" بخلاف ذلك وعرض رسالة خطأ.

التفاصيل
المعلمات
[in] aCon
WeaveConnection إلى العقدة التي سيتم بدء عملية النقل من خلالها. وتُستخدم لإنشاء ExchangeContext مرتبط بعملية النقل هذه.
[in] aBDXHandlers
بنية معالِجات معاودة الاتصال بـ BDX سيتم طلبها أثناء النقل
[in] aFileDesignator
محدّد الملف للملف الذي سيتم نقله.
[in] anAppState
عنصر حالة خاص بالتطبيق يتم إرفاقه بـ BDXTransfer لكي يستخدمه تطبيق المستخدم وعمليات معاودة الاتصال المرتبطة به.
[in] aXfer
يشير هذا المصطلح إلى مؤشر مرّ عليه التوجيه إلى الكائن BDXTransfer الجديد في حال توفّره، غير أنّ NULL.
قيم الإرجاع
WEAVE_NO_ERROR
في حال العثور على عملية BDXTransfer جديدة.
WEAVE_ERROR_NO_MEMORY
في حال تعذّر إنشاء ExchangeContext
WEAVE_ERROR_TOO_MANY_CONNECTIONS
إذا كان هناك عدد كبير جدًا من عمليات النقل نشطة حاليًا وكان aXfer يكون "NULL" (فارغ)
WEAVE_ERROR_INCORRECT_STATE
في حال عدم إعداد mExchangeMgr بعد أو في حال عدم اتصال aCon بنجاح

إيقاف التشغيل

WEAVE_ERROR Shutdown(
  void
)

يوقف جميع عمليات النقل ويطلق أي موارد Weave (يعين حاليًا mExchangeMgr على NULL).

لضبط AllowBdxTransferToRun(false) وقطع اتصال أي استدعاءات حالية (على سبيل المثال، SendInitHandler).

التفاصيل
المرتجعات
WEAVE_NO_ERROR في حال إيقاف التشغيل بنجاح، ورسالة خطأ أخرى إذا عرَض AwaitBdxSend/ReceiveInit رسالة خطأ

الدوال الثابتة العامة

HandleReceiveInit

void HandleReceiveInit(
  ExchangeContext *anEc,
  const IPPacketInfo *aPktInfo,
  const WeaveMessageInfo *aWeaveMsgInfo,
  uint32_t aProfileId,
  uint8_t aMessageType,
  PacketBuffer *aPacketBuffer
)

HandleSendInit

void HandleSendInit(
  ExchangeContext *anEc,
  const IPPacketInfo *aPktInfo,
  const WeaveMessageInfo *aWeaveMsgInfo,
  uint32_t aProfileId,
  uint8_t aMessageType,
  PacketBuffer *aPacketBuffer
)

ShutdownTransfer

void ShutdownTransfer(
  BDXTransfer *aXfer
)

أوقِف كائن النقل المحدَّد وأعِده إلى وحدة التحكّم.

يؤدي هذا ببساطة إلى تأجيل الإجراء إلى BDXTransfer::مفعّلة().

التفاصيل
المعلمات
[in] aXfer
إيقاف BDXTransfer