nl::Weave::Warm

تشمل مساحة الاسم هذه واجهات لعنوان ووحدة التوجيه، وهي وحدة محمولة لتكوين عناوين IP والمسارات لتطبيق Weave.

ملخّص

عمليات التعداد
ActionType{
  kActionTypeWiFiHostAddress = (1 << 0),
  kActionTypeThreadHostAddress = (1 << 1),
  kActionTypeThreadThreadAddress = (1 << 2),
  kActionTypeLegacy6LoWPANHostAddress = (1 << 3),
  kActionTypeLegacy6LoWPANThreadAddress = (1 << 4),
  kActionTypeHostRouteThread = (1 << 5),
  kActionTypeThreadAdvertisement = (1 << 6),
  kActionTypeThreadRoute = (1 << 7),
  kActionTypeTunnelHostAddress = (1 << 8),
  kActionTypeTunnelHostRoute = (1 << 9),
  kActionTypeThreadRoutePriority = (1 << 10),
  kActionTypeTunnelServiceRoute = (1 << 11),
  kActionTypeMax = (1 << 16)
} 		تعداد
InitState{
  kInitStateNotInitialized = 0
} 		تعداد
InterfaceState تعداد
تعداد القيم المحتملة لحالة الواجهة
InterfaceType{
  kInterfaceTypeLegacy6LoWPAN = 0,
  kInterfaceTypeThread,
  kInterfaceTypeWiFi,
  kInterfaceTypeTunnel,
  kInterfaceTypeCellular
} 		تعداد
تعداد لأنواع الواجهات المحتملة.
PlatformActionExecution{
  kPlatformActionExecutionContinue = false,
  kPlatformActionExecutionSuspendForAsynchOpCompletion = true
} 		تعداد
PlatformResult{
  kPlatformResultSuccess = 0,
  kPlatformResultFailure,
  kPlatformResultInProgress
} 		تعداد
تعداد للقيم المحتملة لإرجاع واجهة برمجة التطبيقات للنظام الأساسي
RoutePriority تعداد
تعداد بأولويات مسار محتمل بحيث يمكن إعطاء الأولوية لمسار على آخر.
SystemFeatureType{
  kSystemFeatureTypeIsFabricMember = (1 << 0),
  kSystemFeatureTypeWiFiConnected = (1 << 1),
  kSystemFeatureTypeThreadConnected = (1 << 2),
  kSystemFeatureTypeThreadRoutingEnabled = (1 << 3),
  kSystemFeatureTypeBorderRoutingEnabled = (1 << 4),
  kSystemFeatureTypeTunnelInterfaceEnabled = (1 << 5),
  kSystemFeatureTypeTunnelState = (1 << 6),
  kSystemFeatureTypeCellularConnected = (1 << 7),
  kSystemFeatureTypeMax = (1 << 16)
} 		تعداد

تعريف الأنواع
ActionFunction)(ActionType inAction, bool inActivate, const uint64_t &inGlobalId, const uint64_t &inInterfaceId) تعريف الكتابة
FlagsType تعريف الكتابة
uint16_t

المتغيرات
kGlobalULAPrefixLength = 48
const uint8_t
kLegacy6LoWPANULAAddressPrefixLength = 64
const uint8_t
kThreadULAAddressPrefixLength = 64
const uint8_t
kTunnelAddressPrefixLength = 128
const uint8_t
kWiFiULAAddressPrefixLength = 64
const uint8_t
sFabricStateDelegate
sState

الدوال
BorderRouterStateChange(InterfaceState inState)
void
تم استدعاء واجهة برمجة تطبيقات WARM API للإعلان عن تغيير في حالة ميزة جهاز توجيه الحدود.
CellularInterfaceStateChange(InterfaceState inState)
void
تم استدعاء واجهة برمجة تطبيقات WARM للإعلان عن تغيير الحالة لواجهة شبكة الجوّال.
FabricStateChange(InterfaceState inState)
void
دالة تسمى للإعلان عن تغيير الحالة لميزة Weave Fabric.
GetCurrentActionState(ActionType inAction)
bool
دالة ثابتة تُرجع الحالة الحالية لإجراء محدد.
GetFabricState(const WeaveFabricState *& outFabricState)
واجهة برمجة تطبيقات WARM API للحصول على عنصر FabricState الذي تم توفيره إلى Warm أثناء Init.
GetSystemFeatureState(SystemFeatureType inSystemFeature)
bool
يشير ذلك المصطلح إلى دالة ثابتة تحصل على الحالة الحالية لميزة النظام.
GetULA(InterfaceType inInterfaceType, Inet::IPAddress & outAddress)
واجهة برمجة تطبيقات WARM API للحصول على ULA لنوع واجهة معيّن.
Init(WeaveFabricState & inFabricState)
واجهة برمجة تطبيقات WARM API لإعداد الوحدات مرة واحدة
InvokeActions(void)
void
واجهة برمجة تطبيقات WARM API يتم استدعاؤها من خلال مهمة مخصصة لتنفيذ إجراءات مختلفة لواجهة برمجة التطبيقات للنظام الأساسي.
LegacyHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
إحدى طرق الإجراءات.
LegacyThreadAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
إحدى طرق الإجراءات.
MakePrefix(const uint64_t & inGlobalID, const uint16_t subnetId, const uint8_t inPrefixLen, Inet::IPPrefix & outPrefix)
void
يشير ذلك المصطلح إلى أداة لإنشاء بادئة 48 بت من مُعرّف عالمي.
MapAvailabilityToPriority(Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability)
دالة ثابتة تعرض تعيينًا من TunnelAvailability إلى RoutePriority.
RecordPlatformResult(PlatformResult inResult, ActionType inAction, bool inActionState)
يشير ذلك المصطلح إلى دالة ثابتة تسجّل نتيجة طلب إجراء بشأن واجهة برمجة التطبيقات على المنصة.
ReportActionComplete(PlatformResult inResult)
void
تم استدعاء واجهة برمجة تطبيقات WARM API للإعلان عن اكتمال طلب بيانات سابق غير متزامن من واجهة برمجة التطبيقات للنظام الأساسي.
SetCurrentActionState(ActionType inAction, bool inValue)
void
يشير ذلك المصطلح إلى دالة ثابتة تحدّد الحالة الحالية لإجراء محدّد.
SetSystemFeatureState(SystemFeatureType inSystemFeature, bool inValue)
bool
دالة ثابتة تحدد الحالة الحالية لميزة النظام.
ShouldPerformAction(ActionType inAction, FlagsType inNecessarySystemFeatureState, bool & outActivate)
bool
يشير ذلك المصطلح إلى دالة ثابتة تحدِّد ما إذا كان يجب تنفيذ الإجراء المحدّد.
SystemFeatureStateChangeHandler(SystemFeatureType inSystemFeatureType, bool inState)
void
دالة ثابتة تحدد حالة ميزات النظام وتُعلِم النظام الأساسي بتغيير حالة الحدث.
TakeActions(void)
void
دالة ثابتة تختبر حالة كل إجراء وترسل طلب واجهة برمجة تطبيقات المنصة لتغيير حالة الإجراء إذا لزم الأمر.
ThreadAdvertisementAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
إحدى طرق الإجراءات.
ThreadHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
إحدى طرق الإجراءات.
ThreadHostRouteAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
إحدى طرق الإجراءات.
ThreadInterfaceStateChange(InterfaceState inState)
void
دعت واجهة برمجة تطبيقات WARM API للإعلان عن تغيير في حالة واجهة Thread.
ThreadRoutePriorityAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
إحدى طرق الإجراءات.
ThreadRoutingStateChange(InterfaceState inState)
void
دعت واجهة برمجة تطبيقات WARM API للإعلان عن تغيير حالة ميزة Thread Router.
ThreadThreadAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
إحدى طرق الإجراءات.
ThreadThreadRouteAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
إحدى طرق الإجراءات.
TunnelHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
إحدى طرق الإجراءات.
TunnelHostRouteAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
إحدى طرق الإجراءات.
TunnelInterfaceStateChange(InterfaceState inState)
void
تم استدعاء واجهة برمجة تطبيقات WARM للإعلان عن تغيير الحالة لواجهة Weave Tunnel.
TunnelPriorityStateChange(nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability)
void
واجهة برمجة تطبيقات WARM API تم استدعاؤها لتعديل أولوية خدمة Tunnel Service.
TunnelServiceStateChange(InterfaceState inState, nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability)
void
تم استدعاء واجهة برمجة تطبيقات WARM للإعلان عن تغيير الحالة لواجهة Weave Tunnel.
WiFiHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
إحدى طرق الإجراءات.
WiFiInterfaceStateChange(InterfaceState inState)
void
تم استدعاء واجهة برمجة تطبيقات WARM للإعلان عن تغيير الحالة لواجهة WiFi.

صفوف
nl::Weave::Warm::WarmFabricStateDelegate

هذه فئة داخلية في CoolCore.

بُنى
nl::Weave::Warm::ActionEntry
nl::Weave::Warm::ModuleState

مساحات الاسم
nl::Weave::Warm::Platform

عمليات التعداد

ActionType

 ActionType
أماكن إقامة
kActionTypeHostRouteThread

إضافة | أزِل مسار IP لواجهة Thread Interface على حزمة IP للمضيف.

kActionTypeLegacy6LoWPANHostAddress

إضافة | أزِل عنوان IP لواجهة 6LowPAN القديمة على حزمة عنوان IP للمضيف.

kActionTypeLegacy6LoWPANThreadAddress

إضافة | أزِل عنوان IP لواجهة 6LowPAN القديمة في حزمة IP لوحدة Thread.

kActionTypeMax

يُرجى عدم تجاوزها؛ محجوزة لوضع علامة على الحد الأقصى لوحدات البت المتاحة.

kActionTypeThreadAdvertisement

بدء | إيقاف إعلان المسار بواسطة "وحدة Thread".

kActionTypeThreadHostAddress

إضافة | أزِل عنوان IP لواجهة Thread Interface على حزمة IP للمضيف.

kActionTypeThreadRoute

إضافة | إزالة مسار IP في وحدة Thread لدعم المسار الحدودي

kActionTypeThreadRoutePriority

تغيير أولوية المسار لمسار سلسلة المحادثات في وحدة سلاسل المحادثات

kActionTypeThreadThreadAddress

إضافة | أزِل عنوان IP لواجهة Thread Interface في حزمة IP لوحدة Thread.

kActionTypeTunnelHostAddress

إضافة | أزِل عنوان IP لواجهة النفق على حزمة IP للمضيف.

kActionTypeTunnelHostRoute

إضافة | أزِل مسار IP لواجهة النفق على حزمة عنوان IP للمضيف.

kActionTypeTunnelServiceRoute

إضافة | أزِل مسار IP 64 بت للشبكة الفرعية للخدمة على حزمة IP للمضيف.

kActionTypeWiFiHostAddress

إضافة | أزِل عنوان IP لواجهة Wi-Fi على حزمة IP للمضيف.

InitState

 InitState
أماكن إقامة
kInitStateNotInitialized

يجب أن تكون هذه القيمة 0 بحيث تكون القيمة الأولية لـ mInitState هي kInitStateNotInitialized.

InterfaceState

 InterfaceState

تعداد القيم المحتملة لحالة الواجهة

InterfaceType

 InterfaceType

تعداد لأنواع الواجهات المحتملة.

أماكن إقامة
kInterfaceTypeCellular

واجهة شبكة الجوّال

kInterfaceTypeLegacy6LoWPAN

واجهة منبّه سلسلة المحادثات

kInterfaceTypeThread

واجهة Thread.

kInterfaceTypeTunnel

واجهة النفق.

kInterfaceTypeWiFi

واجهة WiFi.

PlatformActionExecution

 PlatformActionExecution
أماكن إقامة
kPlatformActionExecutionContinue

متابعة تنفيذ الإجراء.

kPlatformActionExecutionSuspendForAsynchOpCompletion

تعليق تنفيذ الإجراء لاستكمال العملية غير المتزامنة.

PlatformResult

 PlatformResult

تعداد للقيم المحتملة لإرجاع واجهة برمجة التطبيقات للنظام الأساسي

أماكن إقامة
kPlatformResultFailure

تعذّر تنفيذ واجهة برمجة التطبيقات.

kPlatformResultInProgress

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

kPlatformResultSuccess

اكتملت واجهة برمجة التطبيقات بنجاح.

RoutePriority

 RoutePriority

تعداد بأولويات مسار محتمل بحيث يمكن إعطاء الأولوية لمسار على آخر.

SystemFeatureType

 SystemFeatureType
أماكن إقامة
kSystemFeatureTypeBorderRoutingEnabled

ميزة توجيه الحدود في النظام | غير مفعّل.

kSystemFeatureTypeCellularConnected

الواجهة الخلوية للنظام IS | غير متصل.

kSystemFeatureTypeIsFabricMember

ظهور وحدة Weave للنظام | لست عضوًا في أي نسيج.

kSystemFeatureTypeMax

يُرجى عدم تجاوزها؛ محجوزة لوضع علامة على الحد الأقصى لوحدات البت المتاحة.

kSystemFeatureTypeThreadConnected

واجهة Thread API للنظام | غير متصل.

kSystemFeatureTypeThreadRoutingEnabled

ميزة توجيه مؤشر ترابط النظام | غير مفعّل.

kSystemFeatureTypeTunnelInterfaceEnabled

واجهة نفق النظام IS | غير مفعّل.

kSystemFeatureTypeTunnelState

خدمة النفق في النظام | لم يتم تأسيسه.

kSystemFeatureTypeWiFiConnected

واجهة WiFi للنظام | غير متصل.

تعريف الأنواع

ActionFunction

PlatformResult(* ActionFunction)(ActionType inAction, bool inActivate, const uint64_t &inGlobalId, const uint64_t &inInterfaceId)

FlagsType

uint16_t FlagsType

المتغيرات

kGlobalULAPrefixLength

const uint8_t kGlobalULAPrefixLength = 48

kLegacy6LoWPANULAAddressPrefixLength

const uint8_t kLegacy6LoWPANULAAddressPrefixLength = 64

kThreadULAAddressPrefixLength

const uint8_t kThreadULAAddressPrefixLength = 64

kTunnelAddressPrefixLength

const uint8_t kTunnelAddressPrefixLength = 128

kWiFiULAAddressPrefixLength

const uint8_t kWiFiULAAddressPrefixLength = 64

sFabricStateDelegate

WarmFabricStateDelegate sFabricStateDelegate

sState

ModuleState sState

الدوال

BorderRouterStateChange

void BorderRouterStateChange(
  InterfaceState inState
)

تم استدعاء واجهة برمجة تطبيقات WARM API للإعلان عن تغيير في حالة ميزة جهاز توجيه الحدود.

التفاصيل
المعلمات
[in] inState
kInterfaceStateUp إذا كانت ميزة جهاز توجيه الحدود مشغَّلة، يمكنك استخدام kInterfaceStateDown في الحالات الأخرى.

CellularInterfaceStateChange

void CellularInterfaceStateChange(
  InterfaceState inState
)

تم استدعاء واجهة برمجة تطبيقات WARM للإعلان عن تغيير الحالة لواجهة شبكة الجوّال.

التفاصيل
المعلمات
[in] inState
kInterfaceStateUp إذا كانت الواجهة الخلوية للأعلى، kInterfaceStateDown في الحالات الأخرى.

FabricStateChange

void FabricStateChange(
  InterfaceState inState
)

دالة تسمى للإعلان عن تغيير الحالة لميزة Weave Fabric.

التفاصيل
المعلمات
[in] inState
kInterfaceStateUp إذا كان النظام عضوًا في نسيج Weave، وبخلاف ذلك، kInterfaceStateDown.

GetCurrentActionState

bool GetCurrentActionState(
  ActionType inAction
)

دالة ثابتة تُرجع الحالة الحالية لإجراء محدد.

التفاصيل
المعلمات
[in] inAction
نوع الإجراء المطلوب طلب البحث عنه.
المرتجعات
true إذا تم تعيين الإجراء، وعلى false في الحالات الأخرى.

GetFabricState

WEAVE_ERROR GetFabricState(
  const WeaveFabricState *& outFabricState
)

واجهة برمجة تطبيقات WARM API للحصول على عنصر FabricState الذي تم توفيره إلى Warm أثناء Init.

التفاصيل
المعلمات
[out] outFabricState
يشير هذا المصطلح إلى إشارة مؤشر إلى كائن defaultState.
قيم الإرجاع
WEAVE_NO_ERROR
عند النجاح.
WEAVE_ERROR_INCORRECT_STATE
في حال استدعاء واجهة برمجة التطبيقات هذه قبل إعداد WARM.

GetSystemFeatureState

bool GetSystemFeatureState(
  SystemFeatureType inSystemFeature
)

يشير ذلك المصطلح إلى دالة ثابتة تحصل على الحالة الحالية لميزة النظام.

التفاصيل
المعلمات
[in] inSystemFeature
ميزة النظام المطلوب الاستعلام عنها.
المرتجعات
true إذا كانت ميزة النظام مُفعَّلة، أو على false في الحالات الأخرى.

GetULA

WEAVE_ERROR GetULA(
  InterfaceType inInterfaceType,
  Inet::IPAddress & outAddress
)

واجهة برمجة تطبيقات WARM API للحصول على ULA لنوع واجهة معيّن.

التفاصيل
المعلمات
[in] inInterfaceType
يشير ذلك المصطلح إلى نوع الواجهة المطلوبة للحصول على ترخيص ULA.
[out] outAddress
كائن عنوان يُستخدَم للاحتفاظ بنموذج ULA الناتج.
قيم الإرجاع
WEAVE_NO_ERROR
عند النجاح.
WEAVE_ERROR_INCORRECT_STATE
إذا تم استدعاء واجهة برمجة التطبيقات هذه ولم يكن WARM عضوًا في Fabric.
WEAVE_ERROR_INVALID_ARGUMENT
إذا تم استدعاء واجهة برمجة التطبيقات هذه باستخدام نوع واجهة غير صالح.

Init

WEAVE_ERROR Init(
  WeaveFabricState & inFabricState
)

واجهة برمجة تطبيقات WARM API لإعداد الوحدات مرة واحدة

التفاصيل
المعلمات
[in] inFabricState
مرجع إلى WeaveFabricState صالح.
قيم الإرجاع
WEAVE_NO_ERROR
عند الإعداد بنجاح.
WEAVE_ERROR_INCORRECT_STATE
عندما يتم استدعاء Init أكثر من مرة.
other
رمز خطأ في الحالات الأخرى.
المرتجعات
WEAVE_NO_ERROR في ما يتعلق بنجاح، رمز الخطأ في الحالات الأخرى.

InvokeActions

void InvokeActions(
  void
)

واجهة برمجة تطبيقات WARM API يتم استدعاؤها من خلال مهمة مخصصة لتنفيذ إجراءات مختلفة لواجهة برمجة التطبيقات للنظام الأساسي.

يمثل هذا نقطة الدخول لتنفيذ الإجراءات اللازمة التي تلبي حالة النظام الحالية. على سبيل المثال، إذا تم نقل حزمة سلسلة المحادثات من "غير مفعّلة" إلى "مفعَّلة"، ستُجري هذه الدالة طلبات النظام الأساسي اللازمة لتحديد عنوان مضيف سلسلة المحادثات وما إلى ذلك. ويجب استدعاء هذه الدالة من خلال رمز النظام الأساسي فقط استجابةً لطلب Warm إلى RequestInvokeActions. سيؤدي استدعاء InvokeActions إلى إرسال طلب واحد أو أكثر إلى واجهات برمجة التطبيقات nl::Warm::Platform. ولذلك، على المطوّرين تنفيذ إجراءات RequestInvokeActions واستدعاء الدالة InvokeActions() على نحو سليم. قد يكون من المناسب تطبيق RequestInvokeActions نشر حدث في المهمة التي قد تستدعي InvokeActions() على سبيل المثال. وبالعكس، إذا كان النظام يتضمّن سلسلة محادثات واحدة، يمكن تنفيذ RequestInvokeActions لاستدعاء InvokeActions() مباشرةً.

LegacyHostAddressAction

PlatformResult LegacyHostAddressAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

إحدى طرق الإجراءات.

لضبط عنوان المضيف للواجهة القديمة.

التفاصيل
المعلمات
[in] inAction
نوع الإجراء.
[in] inActivate
حالة الحالة المطلوبة true == enable, false == حماية
[in] inGlobalId
مرجع إلى معرّف Weave العالمي إذا كان من الضروري حساب عنوان.
[in] inInterfaceId
مرجع إلى رقم تعريف واجهة الجهاز إذا كان من الضروري حساب عنوان.
المرتجعات
لإعادة توجيه النتيجة من Platform::HostAddress().

LegacyThreadAddressAction

PlatformResult LegacyThreadAddressAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

إحدى طرق الإجراءات.

لضبط عنوان سلسلة المحادثات لواجهة 6LoWPAN القديمة

التفاصيل
المعلمات
[in] inAction
نوع الإجراء.
[in] inActivate
حالة الحالة المطلوبة true == enable, false == حماية
[in] inGlobalId
مرجع إلى معرّف Weave العالمي إذا كان من الضروري حساب عنوان.
[in] inInterfaceId
مرجع إلى رقم تعريف واجهة الجهاز إذا كان من الضروري حساب عنوان.
المرتجعات
لإعادة توجيه النتيجة من Platform::ThreadAddress().

MakePrefix

void MakePrefix(
  const uint64_t & inGlobalID,
  const uint16_t subnetId,
  const uint8_t inPrefixLen,
  Inet::IPPrefix & outPrefix
)

يشير ذلك المصطلح إلى أداة لإنشاء بادئة 48 بت من مُعرّف عالمي.

التفاصيل
المعلمات
[in] inGlobalID
إشارة إلى معرّف Weave العالمي.
[out] outPrefix
البادئة المطلوب إعدادها.

MapAvailabilityToPriority

RoutePriority MapAvailabilityToPriority(
  Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability
)

دالة ثابتة تعرض تعيينًا من TunnelAvailability إلى RoutePriority.

التفاصيل
المعلمات
[in] inAvailability
وضع مدى توفّر نفق Weave
المرتجعات
القيمة التي تم تحديد الأولوية لها.

RecordPlatformResult

PlatformActionExecution RecordPlatformResult(
  PlatformResult inResult,
  ActionType inAction,
  bool inActionState
)

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

تقدِّم هذه الوحدة طلبات لتنفيذ إجراءات عبر واجهات برمجة التطبيقات الخاصة بالنظام الأساسي. يجب تضمين واجهات برمجة التطبيقات للإبلاغ عن نتيجة kPlatformResultSuccess|kPlatformResultFailure|kPlatformResultInProgress لطلب الإجراء هذا. تسجل هذه الدالة النتيجة وتعرض "صحيح" إذا كانت النتيجة قيد التقدم وينبغي تأخير الإجراءات الأخرى.

التفاصيل
المعلمات
[in] inResult
نتيجة واجهة برمجة التطبيقات للنظام الأساسي.
[in] inAction
الإجراء الذي حاولت واجهة برمجة التطبيقات للنظام الأساسي استخدامه.
[in] inActionState
الحالة الجديدة للإجراء إذا كانت النتيجة ناجحة.
المرتجعات
true، تعالج واجهة برمجة التطبيقات للنظام الأساسي الطلب بشكل غير متزامن، أو غير ذلك.

ReportActionComplete

void ReportActionComplete(
  PlatformResult inResult
)

تم استدعاء واجهة برمجة تطبيقات WARM API للإعلان عن اكتمال طلب بيانات سابق غير متزامن من واجهة برمجة التطبيقات للنظام الأساسي.

من المفترض أنّ واجهات برمجة التطبيقات للإجراء على مستوى المنصة قد تحتاج إلى تنفيذ عمليات غير متزامنة. في هذه الحالة، ستعرض واجهة برمجة التطبيقات للنظام الأساسي kPlatformResultInProgress. وعندما يحدث ذلك، سيتم تعليق إجراءات العنوان والتوجيه الجديدة إلى أن يستدعي النظام ReportActionComplete للإعلان عن اكتمال العملية.

التفاصيل
المعلمات
[in] inResult
نتيجة الإجراء في انتظار المراجعة. يجب أن تكون واحدة مما يلي: {kPlatformResultSuccess | kPlatformResultFailure}

SetCurrentActionState

void SetCurrentActionState(
  ActionType inAction,
  bool inValue
)

يشير ذلك المصطلح إلى دالة ثابتة تحدّد الحالة الحالية لإجراء محدّد.

التفاصيل
المعلمات
[in] inAction
نوع الإجراء المطلوب تغييره.
[in] inValue
قيمة الولاية الجديدة المطلوب اعتمادها

SetSystemFeatureState

bool SetSystemFeatureState(
  SystemFeatureType inSystemFeature,
  bool inValue
)

دالة ثابتة تحدد الحالة الحالية لميزة النظام.

التفاصيل
المعلمات
[in] inSystemFeature
تشير هذه السمة إلى SystemFeature المطلوب ضبطها.
[in] inValue
قيمة الولاية الجديدة المطلوب اعتمادها
المرتجعات
true إذا تم تغيير ميزة النظام، أو على false في الحالات الأخرى.

ShouldPerformAction

bool ShouldPerformAction(
  ActionType inAction,
  FlagsType inNecessarySystemFeatureState,
  bool & outActivate
)

يشير ذلك المصطلح إلى دالة ثابتة تحدِّد ما إذا كان يجب تنفيذ الإجراء المحدّد.

تفحص هذه الدالة حالة علامات حالة ميزات النظام وتحدّد ما إذا كان يجب تفعيل الإجراء المحدّد أو إيقافه. تفحص الدالة بعد ذلك الحالة الحالية للإجراء وإذا لم يتم ضبط الإجراء على القيمة المطلوبة بواسطة حالة ميزة النظام، تعرض الدالة القيمة true مع حالة الإجراء المطلوبة في outActivate.

التفاصيل
المعلمات
[in] inAction
الإجراء المطلوب البحث عنه.
[in] inNecessarySystemFeatureState
علامات الولاية اللازمة لتفعيل الإجراء
[out] outActivate
الحالة المطلوبة للإجراء.
المرتجعات
true إذا لم يكن الإجراء في الحالة المطلوبة حاليًا، أو false بخلاف ذلك.

SystemFeatureStateChangeHandler

void SystemFeatureStateChangeHandler(
  SystemFeatureType inSystemFeatureType,
  bool inState
)

دالة ثابتة تحدد حالة ميزات النظام وتُعلِم النظام الأساسي بتغيير حالة الحدث.

يتم استدعاءها بواسطة واجهات برمجة التطبيقات EventStateChange لإجراء عمليات التفاعل اللازمة.

التفاصيل
المعلمات
[in] inSystemFeatureType
الحالة التي تغيّرت بما يتوافق مع واجهة برمجة التطبيقات التي تم طلبها.
[in] inState
القيمة الجديدة للولاية.

TakeActions

void TakeActions(
  void
)

دالة ثابتة تختبر حالة كل إجراء وترسل طلب واجهة برمجة تطبيقات المنصة لتغيير حالة الإجراء إذا لزم الأمر.

تستخدم هذه الدالة ShouldPerformAction() لتحديد ما إذا كان يجب تغيير حالة الإجراء أو اتخاذه. إذا عرضت ShouldPerformAction() القيمة "صحيح"، ستستدعي الدالة واجهة برمجة التطبيقات للإجراء المناسب لتنفيذ الإجراء لوضعه في الحالة المطلوبة. يتم تمرير نتيجة طلب بيانات من واجهة برمجة التطبيقات إلى RecordPlatformResult() ، وإذا كانت هذه الدالة تُظهر القيمة true، يتم إنهاء تنفيذ هذه الدالة.

ThreadAdvertisementAction

PlatformResult ThreadAdvertisementAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

إحدى طرق الإجراءات.

ضبط حالة إعلان سلسلة المحادثات

التفاصيل
المعلمات
[in] inAction
نوع الإجراء.
[in] inActivate
حالة الحالة المطلوبة true == enable, false == حماية
[in] inGlobalId
مرجع إلى معرّف Weave العالمي إذا كان من الضروري حساب عنوان.
[in] inInterfaceId
مرجع إلى رقم تعريف واجهة الجهاز إذا كان من الضروري حساب عنوان.
المرتجعات
لإعادة توجيه النتيجة من Platform::ThreadAdvertisingment().

ThreadHostAddressAction

PlatformResult ThreadHostAddressAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

إحدى طرق الإجراءات.

لضبط عنوان المضيف لواجهة Thread.

التفاصيل
المعلمات
[in] inAction
نوع الإجراء.
[in] inActivate
حالة الحالة المطلوبة true == enable, false == حماية
[in] inGlobalId
مرجع إلى معرّف Weave العالمي إذا كان من الضروري حساب عنوان.
[in] inInterfaceId
مرجع إلى رقم تعريف واجهة الجهاز إذا كان من الضروري حساب عنوان.
المرتجعات
لإعادة توجيه النتيجة من Platform::HostAddress().

ThreadHostRouteAction

PlatformResult ThreadHostRouteAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

إحدى طرق الإجراءات.

لضبط مسار المضيف لواجهة Thread.

التفاصيل
المعلمات
[in] inAction
نوع الإجراء.
[in] inActivate
حالة الحالة المطلوبة true == enable, false == حماية
[in] inGlobalId
مرجع إلى معرّف Weave العالمي إذا كان من الضروري حساب عنوان.
[in] inInterfaceId
مرجع إلى رقم تعريف واجهة الجهاز إذا كان من الضروري حساب عنوان.
المرتجعات
لإعادة توجيه النتيجة من Platform::HostRoute().

ThreadInterfaceStateChange

void ThreadInterfaceStateChange(
  InterfaceState inState
)

دعت واجهة برمجة تطبيقات WARM API للإعلان عن تغيير في حالة واجهة Thread.

التفاصيل
المعلمات
[in] inState
kInterfaceStateUp إذا كانت واجهة Thread أعلى، kInterfaceStateDown في الحالات الأخرى.

ThreadRoutePriorityAction

PlatformResult ThreadRoutePriorityAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

إحدى طرق الإجراءات.

تضبط هذه السياسة أولوية مسار سلسلة المحادثات بناءً على مدى توفُّر النفق.

التفاصيل
المعلمات
[in] inAction
نوع الإجراء.
[in] inActivate
حالة الحالة المطلوبة true == enable, false == حماية
[in] inGlobalId
مرجع إلى معرّف Weave العالمي إذا كان من الضروري حساب عنوان.
[in] inInterfaceId
مرجع إلى رقم تعريف واجهة الجهاز إذا كان من الضروري حساب عنوان.
المرتجعات
لإعادة توجيه النتيجة من Platform::ThreadRoutePriority().

ThreadRoutingStateChange

void ThreadRoutingStateChange(
  InterfaceState inState
)

دعت واجهة برمجة تطبيقات WARM API للإعلان عن تغيير حالة ميزة Thread Router.

التفاصيل
المعلمات
[in] inState
kInterfaceStateUp إذا كانت ميزة توجيه مؤشر الترابط قيد التشغيل، يمكنك استخدام kInterfaceStateDown في الحالات الأخرى.

ThreadThreadAddressAction

PlatformResult ThreadThreadAddressAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

إحدى طرق الإجراءات.

لضبط عنوان سلسلة المحادثات لواجهة Thread Interface

التفاصيل
المعلمات
[in] inAction
نوع الإجراء.
[in] inActivate
حالة الحالة المطلوبة true == enable, false == حماية
[in] inGlobalId
مرجع إلى معرّف Weave العالمي إذا كان من الضروري حساب عنوان.
[in] inInterfaceId
مرجع إلى رقم تعريف واجهة الجهاز إذا كان من الضروري حساب عنوان.
المرتجعات
لإعادة توجيه النتيجة من Platform::ThreadAddress().

ThreadThreadRouteAction

PlatformResult ThreadThreadRouteAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

إحدى طرق الإجراءات.

تضبط هذه السياسة مسار سلسلة المحادثات لحزمة سلاسل المحادثات.

التفاصيل
المعلمات
[in] inAction
نوع الإجراء.
[in] inActivate
حالة الحالة المطلوبة true == enable, false == حماية
[in] inGlobalId
مرجع إلى معرّف Weave العالمي إذا كان من الضروري حساب عنوان.
[in] inInterfaceId
مرجع إلى رقم تعريف واجهة الجهاز إذا كان من الضروري حساب عنوان.
المرتجعات
لإعادة توجيه النتيجة من Platform::ThreadRoute().

TunnelHostAddressAction

PlatformResult TunnelHostAddressAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

إحدى طرق الإجراءات.

لضبط HostAddress لواجهة النفق.

التفاصيل
المعلمات
[in] inAction
نوع الإجراء.
[in] inActivate
حالة الحالة المطلوبة true == enable, false == حماية
[in] inGlobalId
مرجع إلى معرّف Weave العالمي إذا كان من الضروري حساب عنوان.
[in] inInterfaceId
مرجع إلى رقم تعريف واجهة الجهاز إذا كان من الضروري حساب عنوان.
المرتجعات
لإعادة توجيه النتيجة من Platform::HostAddress().

TunnelHostRouteAction

PlatformResult TunnelHostRouteAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

إحدى طرق الإجراءات.

لضبط HostRoute الخاص بواجهة النفق.

التفاصيل
المعلمات
[in] inAction
نوع الإجراء.
[in] inActivate
حالة الحالة المطلوبة true == enable, false == حماية
[in] inGlobalId
مرجع إلى معرّف Weave العالمي إذا كان من الضروري حساب عنوان.
[in] inInterfaceId
مرجع إلى رقم تعريف واجهة الجهاز إذا كان من الضروري حساب عنوان.
المرتجعات
لإعادة توجيه النتيجة من Platform::HostRoute().

TunnelInterfaceStateChange

void TunnelInterfaceStateChange(
  InterfaceState inState
)

تم استدعاء واجهة برمجة تطبيقات WARM للإعلان عن تغيير الحالة لواجهة Weave Tunnel.

التفاصيل
المعلمات
[in] inState
kInterfaceStateUp إذا كانت واجهة Weave Tunnel أعلى، kInterfaceStateDown بخلاف ذلك.

TunnelPriorityStateChange

void TunnelPriorityStateChange(
  nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability
)

واجهة برمجة تطبيقات WARM API تم استدعاؤها لتعديل أولوية خدمة Tunnel Service.

.

التفاصيل
المعلمات
[in] inAvailability
القيمة الجديدة لحالة مدى توفّر النفق.

TunnelServiceStateChange

void TunnelServiceStateChange(
  InterfaceState inState,
  nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability
)

تم استدعاء واجهة برمجة تطبيقات WARM للإعلان عن تغيير الحالة لواجهة Weave Tunnel.

التفاصيل
المعلمات
[in] inState
kInterfaceStateUp إذا تم إنشاء خدمة Weave Tunnel، أو kInterfaceStateDown بخلاف ذلك.
[in] inAvailability
حالة مدى التوفّر التي سيتم استخدامها لاحقًا في ضبط الاتصال النفقي.

WiFiHostAddressAction

PlatformResult WiFiHostAddressAction(
  ActionType inAction,
  bool inActivate,
  const uint64_t & inGlobalId,
  const uint64_t & inInterfaceId
)

إحدى طرق الإجراءات.

لضبط عنوان المضيف لواجهة WiFi.

التفاصيل
المعلمات
[in] inAction
نوع الإجراء.
[in] inActivate
حالة الحالة المطلوبة true == enable, false == حماية
[in] inGlobalId
مرجع إلى معرّف Weave العالمي إذا كان من الضروري حساب عنوان.
[in] inInterfaceId
مرجع إلى رقم تعريف واجهة الجهاز إذا كان من الضروري حساب عنوان.
المرتجعات
لإعادة توجيه النتيجة من Platform::HostAddress().

WiFiInterfaceStateChange

void WiFiInterfaceStateChange(
  InterfaceState inState
)

تم استدعاء واجهة برمجة تطبيقات WARM للإعلان عن تغيير الحالة لواجهة WiFi.

التفاصيل
المعلمات
[in] inState
kInterfaceStateUp إذا كانت واجهة WiFi أعلى، kInterfaceStateDown في الحالات الأخرى.