nl::Weave::Warm

تشمل مساحة الاسم هذه واجهات لـ عنوان Weave ووحدة التوجيه، وهي وحدة محمولة لإعداد عناوين ومسارات Weave IP.

ملخّص

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

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) typedef
FlagsType typedef
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 للإعلان عن تغيير حالة لميزة جهاز توجيه الحدود.
CellularInterfaceStateChange(InterfaceState inState)
void
تم طلب واجهة برمجة تطبيقات WARM للإعلان عن تغيير الحالة للواجهة الخلوية.
FabricStateChange(InterfaceState inState)
void
دالة تسمى للإعلان عن تغيير الحالة لميزة Weave Fabric.
GetCurrentActionState(ActionType inAction)
bool
دالة ثابتة تعرض الحالة الحالية لأحد الإجراءات.
GetFabricState(const WeaveFabricState *& outFabricState)
واجهة برمجة تطبيقات WARM للحصول على كائن FabricState الذي تم تقديمه إلى Warm أثناء Init.
GetSystemFeatureState(SystemFeatureType inSystemFeature)
bool
يشير ذلك المصطلح إلى دالة ثابتة تحصل على الحالة الحالية لإحدى ميزات النظام.
GetULA(InterfaceType inInterfaceType, Inet::IPAddress & outAddress)
واجهة برمجة تطبيقات WARM للحصول على ULA لنوع واجهة محدّد
Init(WeaveFabricState & inFabricState)
واجهة برمجة تطبيقات WARM تعمل على إعداد وحدات لمرة واحدة
InvokeActions(void)
void
يشير هذا المصطلح إلى واجهة برمجة تطبيقات WARM يتم استدعاؤها من خلال مَهمّة مخصَّصة لتنفيذ العديد من الإجراءات المتعلّقة بواجهة برمجة التطبيقات على مستوى النظام الأساسي.
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 بت من GlobalID.
MapAvailabilityToPriority(Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability)
دالة ثابتة تعرض تعيينًا من Tunnelavailability إلى RoutePriority.
RecordPlatformResult(PlatformResult inResult, ActionType inAction, bool inActionState)
يشير ذلك المصطلح إلى دالة ثابتة تسجِّل نتيجة طلب البيانات من واجهة برمجة التطبيقات على النظام الأساسي.
ReportActionComplete(PlatformResult inResult)
void
تم استدعاء واجهة برمجة تطبيقات WARM للإعلان عن اكتمال استدعاء سابق غير متزامن من واجهة برمجة التطبيقات للنظام الأساسي.
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 للإعلان عن تغيير حالة واجهة سلسلة المحادثات.
ThreadRoutePriorityAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
أحد أساليب الإجراء.
ThreadRoutingStateChange(InterfaceState inState)
void
تم استدعاء واجهة برمجة تطبيقات WARM للإعلان عن تغيير حالة لميزة "توجيه سلسلة المحادثات".
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 تم استدعاءها لتعديل أولوية خدمة النفق.
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 لواجهة سلسلة التعليمات على حزمة عناوين IP للمضيف

kActionTypeLegacy6LoWPANHostAddress

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

kActionTypeLegacy6LoWPANThreadAddress

إضافة | إزالة عنوان IP لواجهة 6LowPAN القديمة في حزمة عناوين IP لوحدة سلسلة المحادثات

kActionTypeMax

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

kActionTypeThreadAdvertisement

بدء | إيقاف إعلان التوجيه عن طريق وحدة سلاسل المحادثات

kActionTypeThreadHostAddress

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

kActionTypeThreadRoute

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

kActionTypeThreadRoutePriority

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

kActionTypeThreadThreadAddress

إضافة | إزالة عنوان IP لواجهة Thread في حزمة عناوين IP الخاصة بوحدة سلسلة المحادثات

kActionTypeTunnelHostAddress

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

kActionTypeTunnelHostRoute

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

kActionTypeTunnelServiceRoute

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

kActionTypeWiFiHostAddress

إضافة | إزالة عنوان IP لواجهة WiFi من حزمة عناوين IP للمضيف.

InitState

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

يجب أن تكون القيمة 0 لكي تكون القيمة الأولية لـ mInitState هي kInitStateNotConfig.

InterfaceState

 InterfaceState

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

InterfaceType

 InterfaceType

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

أماكن إقامة
kInterfaceTypeCellular

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

kInterfaceTypeLegacy6LoWPAN

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

kInterfaceTypeThread

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

kInterfaceTypeTunnel

واجهة النفق.

kInterfaceTypeWiFi

واجهة WiFi.

PlatformActionExecution

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

مواصلة تنفيذ الإجراء.

kPlatformActionExecutionSuspendForAsynchOpCompletion

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

PlatformResult

 PlatformResult

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

أماكن إقامة
kPlatformResultFailure

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

kPlatformResultInProgress

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

kPlatformResultSuccess

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

RoutePriority

 RoutePriority

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

SystemFeatureType

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

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

kSystemFeatureTypeCellularConnected

نسبة ظهور الإعلان بالواجهة الخلوية للنظام | لم يتم الاتصال.

kSystemFeatureTypeIsFabricMember

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

kSystemFeatureTypeMax

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

kSystemFeatureTypeThreadConnected

يتم رصد واجهة سلسلة محادثات النظام | لم يتم الاتصال.

kSystemFeatureTypeThreadRoutingEnabled

ميزة "توجيه سلسلة التعليمات" في النظام | لم يتم تفعيلها.

kSystemFeatureTypeTunnelInterfaceEnabled

نسبة ظهور إعلانات واجهة نفق النظام | لم يتم تفعيلها.

kSystemFeatureTypeTunnelState

نسبة ظهور إعلانات خدمة نفق النظام | لم يتم تأسيسها.

kSystemFeatureTypeWiFiConnected

واجهة Wi-Fi للنظام | لم يتم الاتصال.

تحديدات النوع

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 للإعلان عن تغيير حالة لميزة جهاز توجيه الحدود.

التفاصيل
المَعلمات
[in] inState
kInterfaceStateUp إذا كانت ميزة جهاز التوجيه Border ردًا على واجهة برمجة التطبيقات، أو 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 للحصول على كائن FabricState الذي تم تقديمه إلى Warm أثناء Init.

التفاصيل
المَعلمات
[out] outFabricState
إشارة مؤشر إلى كائن FashState
قيم الإرجاع
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 للحصول على ULA لنوع واجهة محدّد

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

إنت

WEAVE_ERROR Init(
  WeaveFabricState & inFabricState
)

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

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

InvokeActions

void InvokeActions(
  void
)

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

ويمثل هذا نقطة الدخول لتنفيذ الإجراءات اللازمة التي ستتوافق مع حالة النظام الحالية. على سبيل المثال، إذا تم نقل حزمة Thread من "غير مفعّل" إلى "مفعّل"، ستجري هذه الدالة استدعاءات النظام الأساسي اللازمة لتحديد عنوان مضيف سلسلة المحادثات وما إلى ذلك. ويجب استدعاء هذه الدالة من خلال رمز النظام الأساسي فقط استجابةً لاستدعاء 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 == activate, false == disabled.
[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 == activate, false == disabled.
[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 بت من GlobalID.

التفاصيل
المَعلمات
[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
الحالة الجديدة للإجراء إذا كانت النتيجة ناجحة.
المرتجعات
صحيح، تعالج واجهة برمجة تطبيقات النظام الأساسي الطلب بشكل غير متزامن، وإلا فإن الخطأ "خطأ".

ReportActionComplete

void ReportActionComplete(
  PlatformResult inResult
)

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

من المفترض أنّ واجهات برمجة التطبيقات لإجراءات النظام الأساسي قد تحتاج إلى تنفيذ عمليات غير متزامنة. إذا كان هذا صحيحًا، فستعرض واجهة برمجة التطبيقات للنظام الأساسي 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
ميزة النظام المطلوب ضبطها.
[in] inValue
قيمة "الحالة" الجديدة المطلوب استخدامها.
المرتجعات
true إذا تم تغيير ميزة النظام، أو false بخلاف ذلك.

ShouldPerformAction

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

دالة ثابتة تحدد ما إذا كان يجب تنفيذ الإجراء المحدد أم لا.

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

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

SystemFeatureStateChangeHandler

void SystemFeatureStateChangeHandler(
  SystemFeatureType inSystemFeatureType,
  bool inState
)

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

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

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

TakeActions

void TakeActions(
  void
)

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

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

ThreadAdvertisementAction

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

أحد أساليب الإجراء.

تعيين حالة إعلان سلسلة المحادثات

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

ThreadHostAddressAction

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

أحد أساليب الإجراء.

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

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

ThreadHostRouteAction

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

أحد أساليب الإجراء.

لضبط مسار المضيف لواجهة سلسلة المحادثات.

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

ThreadInterfaceStateChange

void ThreadInterfaceStateChange(
  InterfaceState inState
)

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

التفاصيل
المَعلمات
[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 == activate, false == disabled.
[in] inGlobalId
مرجع إلى معرّف Weave العالمي إذا كان من الضروري حساب عنوان.
[in] inInterfaceId
مرجع إلى رقم تعريف واجهة الجهاز إذا كان حساب العنوان ضروريًا.
المرتجعات
إعادة توجيه النتيجة من Platform::ThreadRoutePriority().

ThreadRoutingStateChange

void ThreadRoutingStateChange(
  InterfaceState inState
)

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

التفاصيل
المَعلمات
[in] inState
kInterfaceStateUp إذا كانت ميزة "توجيه سلسلة المحادثات" للأعلى، أو kInterfaceStateDown

ThreadThreadAddressAction

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

أحد أساليب الإجراء.

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

التفاصيل
المَعلمات
[in] inAction
نوع الإجراء.
[in] inActivate
الحالة المطلوبة true == activate, false == disabled.
[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 == activate, false == disabled.
[in] inGlobalId
مرجع إلى معرّف Weave العالمي إذا كان من الضروري حساب عنوان.
[in] inInterfaceId
مرجع إلى رقم تعريف واجهة الجهاز إذا كان حساب العنوان ضروريًا.
المرتجعات
إعادة توجيه النتيجة من Platform::ThreadRoute().

TunnelHostAddressAction

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

أحد أساليب الإجراء.

تعيِّن عنوان المضيف لواجهة النفق.

التفاصيل
المَعلمات
[in] inAction
نوع الإجراء.
[in] inActivate
الحالة المطلوبة true == activate, false == disabled.
[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 == activate, false == disabled.
[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 تم استدعاءها لتعديل أولوية خدمة النفق.

التفاصيل
المَعلمات
[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
)

أحد أساليب الإجراء.

ضبط عنوان المضيف لواجهة Wi-Fi.

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

WiFiInterfaceStateChange

void WiFiInterfaceStateChange(
  InterfaceState inState
)

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

التفاصيل
المَعلمات
[in] inState
kInterfaceStateUp إذا كانت واجهة Wi-Fi مرتفعة، وإذا لم تكن الواجهة هي kInterfaceStateDown