nl::Weave::Warm::Platform

ملخّص

الدوال

AddRemoveHostAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, uint8_t inPrefixLength, bool inAdd)
واجهة برمجة تطبيقات نظام أساسي تطلبها Warm لإضافة / إزالة عنوان IP للمضيف إلى الواجهة المحددة على حزمة TCP/IP للمضيف.
AddRemoveHostRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
واجهة برمجة تطبيقات نظام أساسي تطلبها Warm لإضافة / إزالة مسار IP للواجهة المحددة على حزمة TCP/IP للمضيف.
AddRemoveThreadAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, bool inAdd)
واجهة برمجة تطبيقات نظام أساسي تطلبها Warm لإضافة / إزالة عنوان IP إلى الواجهة المحددة على حزمة Thread TCP/IP.
AddRemoveThreadRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
واجهة برمجة تطبيقات نظام أساسي تطلبها Warm لإضافة / إزالة مسار IP للواجهة المحدّدة على حزمة Thread TCP/IP.
CriticalSectionEnter(void)
void
واجهة برمجة تطبيقات نظام أساسي تطلب Warm الاتصال بها لحماية الوصول إلى الحالة الداخلية.
CriticalSectionExit(void)
void
هي واجهة برمجة تطبيقات للنظام الأساسي تطلبها Warm لإصدار الوصول المحمي إلى الحالة الداخلية.
Init(WarmFabricStateDelegate *inFabricStateDelegate)
واجهة برمجة تطبيقات نظام أساسي سيتم الاتصال بها بواسطة Warm كجزء من عملية تنفيذ nl::Warm::Init.
RequestInvokeActions(void)
void
واجهة برمجة تطبيقات لمنصة Warm ستتصل بها الخدمة للإعلان عن ضرورة استدعاء النظام الأساسي InvokeActions.
SetThreadRoutePriority(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority)
واجهة برمجة تطبيقات نظام أساسي يستدعيها Warm لتغيير أولوية مسار IP الحالي للواجهة المحددة على حزمة Thread TCP/IP.
StartStopThreadAdvertisement(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, bool inStart)
واجهة برمجة تطبيقات نظام أساسي تطلبها Warm لبدء الإعلان عن بادئة IP أو إيقافها على واجهة Thread.

الدوال

AddRemoveHostAddress

PlatformResult AddRemoveHostAddress(
  InterfaceType inInterfaceType,
  const Inet::IPAddress & inAddress,
  uint8_t inPrefixLength,
  bool inAdd
)

واجهة برمجة تطبيقات نظام أساسي تطلبها Warm لإضافة / إزالة عنوان IP للمضيف إلى الواجهة المحددة على حزمة TCP/IP للمضيف.

وبعد الانتهاء، يتعين على المنصة استدعاء ReportActionComplete مع النتيجة النهائية.

التفاصيل
المعلمات
[in] inInterfaceType
الواجهة المطلوب تعديلها.
[in] inAddress
عنوان IP المطلوب إضافته أو إزالته
[in] inPrefixLength
طول بادئة inAddress.
[in] inAdd
true لإضافة العنوان، وعلى false لإزالة العنوان.
قيم الإرجاع
kPlatformResultSuccess
اكتملت العملية بنجاح.
kPlatformResultFailure
تعذّر إتمام العملية.
kPlatformResultInProgress
ستكتمل العملية بشكل غير متزامن.

AddRemoveHostRoute

PlatformResult AddRemoveHostRoute(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  RoutePriority inPriority,
  bool inAdd
)

واجهة برمجة تطبيقات نظام أساسي تطلبها Warm لإضافة / إزالة مسار IP للواجهة المحددة على حزمة TCP/IP للمضيف.

وبعد الانتهاء، يتعين على المنصة استدعاء ReportActionComplete مع النتيجة النهائية.

التفاصيل
المعلمات
[in] inInterfaceType
الواجهة المطلوب تعديلها.
[in] inPrefix
بادئة عنوان IP المطلوب إضافتها أو إزالتها.
[in] inPriority
أولوية الاستخدام عند تعيين المسار.
[in] inAdd
true لإضافة البادئة كمسار، وعلى false لإزالة البادئة كمسار.
قيم الإرجاع
kPlatformResultSuccess
اكتملت العملية بنجاح.
kPlatformResultFailure
تعذّر إتمام العملية.
kPlatformResultInProgress
ستكتمل العملية بشكل غير متزامن.

AddRemoveThreadAddress

PlatformResult AddRemoveThreadAddress(
  InterfaceType inInterfaceType,
  const Inet::IPAddress & inAddress,
  bool inAdd
)

واجهة برمجة تطبيقات نظام أساسي تطلبها Warm لإضافة / إزالة عنوان IP إلى الواجهة المحددة على حزمة Thread TCP/IP.

وبعد الانتهاء، يتعين على المنصة استدعاء ReportActionComplete مع النتيجة النهائية.

التفاصيل
المعلمات
[in] inInterfaceType
الواجهة المطلوب تعديلها.
[in] inAddress
عنوان IP المطلوب إضافته أو إزالته
[in] inAdd
true لإضافة العنوان، وعلى false لإزالة العنوان.
قيم الإرجاع
kPlatformResultSuccess
اكتملت العملية بنجاح.
kPlatformResultFailure
تعذّر إتمام العملية.
kPlatformResultInProgress
ستكتمل العملية بشكل غير متزامن.

AddRemoveThreadRoute

PlatformResult AddRemoveThreadRoute(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  RoutePriority inPriority,
  bool inAdd
)

واجهة برمجة تطبيقات نظام أساسي تطلبها Warm لإضافة / إزالة مسار IP للواجهة المحدّدة على حزمة Thread TCP/IP.

وبعد الانتهاء، يتعين على المنصة استدعاء ReportActionComplete مع النتيجة النهائية.

التفاصيل
المعلمات
[in] inInterfaceType
الواجهة المطلوب تعديلها.
[in] inPrefix
بادئة عنوان IP المطلوب تحديدها أو إزالتها.
[in] inPriority
أولوية الاستخدام عند تعيين المسار.
[in] inAdd
true لإضافة البادئة كمسار، وعلى false لإزالة البادئة كمسار.
قيم الإرجاع
kPlatformResultSuccess
اكتملت العملية بنجاح.
kPlatformResultFailure
تعذّر إتمام العملية.
kPlatformResultInProgress
ستكتمل العملية بشكل غير متزامن.

CriticalSectionEnter

void CriticalSectionEnter(
  void
)

واجهة برمجة تطبيقات نظام أساسي تطلب Warm الاتصال بها لحماية الوصول إلى الحالة الداخلية.

CriticalSectionExit

void CriticalSectionExit(
  void
)

هي واجهة برمجة تطبيقات للنظام الأساسي تطلبها Warm لإصدار الوصول المحمي إلى الحالة الداخلية.

Init

WEAVE_ERROR Init(
  WarmFabricStateDelegate *inFabricStateDelegate
)

واجهة برمجة تطبيقات نظام أساسي سيتم الاتصال بها بواسطة Warm كجزء من عملية تنفيذ nl::Warm::Init.

التفاصيل
المعلمات
[in] inFabricStateDelegate
يشير هذا المصطلح إلى مؤشر الماوس الناجمة عن الكائن defaultStateDelegate الذي تستخدمه Warm لتلقّي آخر المعلومات حول حالة النسيج.
المرتجعات
WEAVE_NO_ERROR في ما يتعلق بنجاح، رمز الخطأ في الحالات الأخرى.

RequestInvokeActions

void RequestInvokeActions(
  void
)

واجهة برمجة تطبيقات لمنصة Warm ستتصل بها الخدمة للإعلان عن ضرورة استدعاء النظام الأساسي InvokeActions.

SetThreadRoutePriority

PlatformResult SetThreadRoutePriority(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  RoutePriority inPriority
)

واجهة برمجة تطبيقات نظام أساسي يستدعيها Warm لتغيير أولوية مسار IP الحالي للواجهة المحددة على حزمة Thread TCP/IP.

وبعد الانتهاء، يتعين على المنصة استدعاء ReportActionComplete مع النتيجة النهائية.

التفاصيل
المعلمات
[in] inInterfaceType
الواجهة المطلوب تعديلها.
[in] inPrefix
بادئة عنوان IP المطلوب تعديلها.
[in] inPriority
الأولوية الجديدة التي سيتم تطبيقها على المسار.
قيم الإرجاع
kPlatformResultSuccess
اكتملت العملية بنجاح.
kPlatformResultFailure
تعذّر إتمام العملية.
kPlatformResultInProgress
ستكتمل العملية بشكل غير متزامن.

StartStopThreadAdvertisement

PlatformResult StartStopThreadAdvertisement(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  bool inStart
)

واجهة برمجة تطبيقات نظام أساسي تطلبها Warm لبدء عرض إعلان لبادئة IP أو إيقافها على واجهة Thread.

وبعد الانتهاء، يتعين على المنصة استدعاء ReportActionComplete مع النتيجة النهائية.

التفاصيل
المعلمات
[in] inInterfaceType
الواجهة المطلوب تعديلها.
[in] inPrefix
بادئة عنوان IP التي يجب بدء / إيقاف الإعلان لها.
[in] inStart
صحيح لبدء الإعلان، وخطأ لإيقاف الإعلان.
قيم الإرجاع
kPlatformResultSuccess
اكتملت العملية بنجاح.
kPlatformResultFailure
تعذّر إتمام العملية.
kPlatformResultInProgress
ستكتمل العملية بشكل غير متزامن.