דף זה תורגם על ידי Cloud Translation API.

nl::Weave::Warm

מרחב השמות הזה כולל ממשקים עבור מודול הניתוב והכתובת של Weave, מודול נייד להגדרת כתובות 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) }	טיפוסים בני מנייה (enum)
`InitState{ kInitStateNotInitialized = 0 }`	טיפוסים בני מנייה (enum)
`InterfaceState`	טיפוסים בני מנייה (enum) טיפוסים בני מנייה (enum) של ערכים אפשריים של מצב ממשק.
`InterfaceType{ kInterfaceTypeLegacy6LoWPAN = 0, kInterfaceTypeThread, kInterfaceTypeWiFi, kInterfaceTypeTunnel, kInterfaceTypeCellular }`	טיפוסים בני מנייה (enum) טיפוסים בני מנייה (enum) של סוגי ממשק אפשריים.
`PlatformActionExecution{ kPlatformActionExecutionContinue = false, kPlatformActionExecutionSuspendForAsynchOpCompletion = true }`	טיפוסים בני מנייה (enum)
`PlatformResult{ kPlatformResultSuccess = 0, kPlatformResultFailure, kPlatformResultInProgress }`	טיפוסים בני מנייה (enum) מספר גדול של ערכי החזרות API אפשריים בפלטפורמה.
`RoutePriority`	טיפוסים בני מנייה (enum) טיפוסים בני מנייה (enum) של עדיפויות אפשריות למסלולים, כך שניתן לקבל עדיפות על פני מסלול אחר.
`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) }`	טיפוסים בני מנייה (enum)

Typedefs
`ActionFunction)(ActionType inAction, bool inActivate, const uint64_t &inGlobalId, const uint64_t &inInterfaceId)`	typedef `PlatformResult(*`
`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`	`WarmFabricStateDelegate`
`sState`	`ModuleState`

פונקציות
`BorderRouterStateChange(InterfaceState inState)`	`void` ממשק API של WARM שנקרא כדי להודיע על שינוי מצב בתכונה 'נתב Border'.
`CellularInterfaceStateChange(InterfaceState inState)`	`void` WARM API שנקרא כדי להכריז על שינוי מצב בממשק של Cellular.
`FabricStateChange(InterfaceState inState)`	`void` פונקציה שנקראת כדי להכריז על שינוי מצב בתכונה Weave Fabric.
`GetCurrentActionState(ActionType inAction)`	`bool` פונקציה סטטית שמחזירה את המצב הנוכחי של פעולה שצוינה.
`GetFabricState(const WeaveFabricState *& outFabricState)`	`WEAVE_ERROR` WARM API כדי לקבל את אובייקט FabricState שסופק ל-Warm במהלך Init.
`GetSystemFeatureState(SystemFeatureType inSystemFeature)`	`bool` פונקציה סטטית שמקבלת את המצב הנוכחי של מאפיין מערכת.
`GetULA(InterfaceType inInterfaceType, Inet::IPAddress & outAddress)`	`WEAVE_ERROR` WARM API לקבלת ULA לסוג ממשק ספציפי.
`Init(WeaveFabricState & inFabricState)`	`WEAVE_ERROR` WARM API לביצוע אתחול של מודול חד-פעמי.
`InvokeActions(void)`	`void` ממשק API של WARM שנקרא על ידי משימה ייעודית לביצוע פעולות API שונות בפלטפורמה.
`LegacyHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` אחת מ-methods של פעולות.
`LegacyThreadAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` אחת מ-methods של פעולות.
`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)`	`RoutePriority` פונקציה סטטית שמחזירה מיפוי מ-TunnelAvailability ל-RoutePriority.
`RecordPlatformResult(PlatformResult inResult, ActionType inAction, bool inActionState)`	`PlatformActionExecution` פונקציה סטטית שמתעדת את התוצאה של קריאה לפעולה מסוג API בפלטפורמה.
`ReportActionComplete(PlatformResult inResult)`	`void` בוצעה קריאה של WARM API כדי להודיע על השלמת קריאה קודמת ל-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` פונקציה סטטית שבודקת את המצב של כל פעולה ומבצעת קריאה ל-API של הפלטפורמה כדי לשנות את מצב הפעולה במקרה הצורך.
`ThreadAdvertisementAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` אחת מ-methods של פעולות.
`ThreadHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` אחת מ-methods של פעולות.
`ThreadHostRouteAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` אחת מ-methods של פעולות.
`ThreadInterfaceStateChange(InterfaceState inState)`	`void` API של WARM שנקרא כדי להכריז על שינוי מצב בממשק של פרוטוקול Thread.
`ThreadRoutePriorityAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` אחת מ-methods של פעולות.
`ThreadRoutingStateChange(InterfaceState inState)`	`void` API של WARM נקרא כדי להודיע על שינוי מצב בתכונה 'ניתוב שרשורים'.
`ThreadThreadAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` אחת מ-methods של פעולות.
`ThreadThreadRouteAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` אחת מ-methods של פעולות.
`TunnelHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` אחת מ-methods של פעולות.
`TunnelHostRouteAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` אחת מ-methods של פעולות.
`TunnelInterfaceStateChange(InterfaceState inState)`	`void` ממשק API של WARM שנקרא כדי להכריז על שינוי מצב בממשק של Weave Tunnel.
`TunnelPriorityStateChange(nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability)`	`void` קריאה של WARM API לעדכון העדיפות של שירות המנהרה.
`TunnelServiceStateChange(InterfaceState inState, nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability)`	`void` ממשק API של WARM שנקרא כדי להכריז על שינוי מצב בממשק של Weave Tunnel.
`WiFiHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)`	`PlatformResult` אחת מ-methods של פעולות.
`WiFiInterfaceStateChange(InterfaceState inState)`	`void` WARM API שנקרא כדי להכריז על שינוי מצב בממשק ה-Wi-Fi.

שיעורים
nl::Weave::Warm::WarmFabricStateDelegate	זוהי כיתה פנימית ל-warCore.

מבנים
nl::Weave::Warm::ActionEntry
nl::Weave::Warm::ModuleState

מרחבי שמות
nl::Weave::Warm::Platform

ערכים של ספירה

ActionType

 ActionType

מאפיינים
`kActionTypeHostRouteThread`	הוספה \| הסרת נתיב ה-IP של ממשק ה-Thread במקבץ ה-IP של המארח.
`kActionTypeLegacy6LoWPANHostAddress`	הוספה \| הסרת כתובת ה-IP של ממשק 6LowPAN מדור קודם מסטאק ה-IP של המארח.
`kActionTypeLegacy6LoWPANThreadAddress`	הוספה \| מסירים את כתובת ה-IP של ממשק 6LowPAN מדור קודם מסטאק ה-IP של מודול ה-Thread.
`kActionTypeMax`	אין לחרוג; שמורה לסימון המספר המרבי של הביטים הזמינים.
`kActionTypeThreadAdvertisement`	התחלה \| עוצרים את הפרסום של המסלול באמצעות מודול ה-thread.
`kActionTypeThreadHostAddress`	הוספה \| הסרה של כתובת ה-IP של ממשק ה-Thread ממקבץ ה-IP של המארח.
`kActionTypeThreadRoute`	הוספה \| מסירים את נתיב ה-IP במודול Thread לתמיכה במסלול גבול.
`kActionTypeThreadRoutePriority`	משנים את העדיפות של מסלול השרשור במודול השרשור.
`kActionTypeThreadThreadAddress`	הוספה \| מסירים את כתובת ה-IP של ממשק ה-Thread במקבץ ה-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

טיפוסים בני מנייה (enum) של ערכים אפשריים של מצב ממשק.

InterfaceType

 InterfaceType

טיפוסים בני מנייה (enum) של סוגי ממשק אפשריים.

מאפיינים
`kInterfaceTypeCellular`	הממשק של הרשת הסלולרית.
`kInterfaceTypeLegacy6LoWPAN`	ממשק של התראת פרוטוקול Thread.
`kInterfaceTypeThread`	ממשק של פרוטוקול Thread.
`kInterfaceTypeTunnel`	ממשק המנהרה.
`kInterfaceTypeWiFi`	ממשק ה-Wi-Fi.

PlatformActionExecution

 PlatformActionExecution

מאפיינים
`kPlatformActionExecutionContinue`	המשך ביצוע הפעולה.
`kPlatformActionExecutionSuspendForAsynchOpCompletion`	השעיה של ביצוע פעולה כדי להשלים פעולה אסינכרונית.

PlatformResult

 PlatformResult

מספר גדול של ערכי החזרות API אפשריים בפלטפורמה.

מאפיינים
`kPlatformResultFailure`	הפעלת ה-API נכשלה.
`kPlatformResultInProgress`	הפעולה מתבצעת ותסתיים באופן אסינכרוני.
`kPlatformResultSuccess`	ממשק ה-API הושלם.

RoutePriority

 RoutePriority

טיפוסים בני מנייה (enum) של עדיפויות אפשריות למסלולים, כך שניתן לקבל עדיפות על פני מסלול אחר.

SystemFeatureType

 SystemFeatureType

מאפיינים
`kSystemFeatureTypeBorderRoutingEnabled`	נתח החשיפות של מערכת ניתוב הגבולות של המערכת \| אינו מופעל.
`kSystemFeatureTypeCellularConnected`	נתח חשיפות של הממשק הסלולרי של המערכת \| לא מחובר.
`kSystemFeatureTypeIsFabricMember`	נתח חשיפות של המערכת \| המוצר אינו חלק מבד.
`kSystemFeatureTypeMax`	אין לחרוג; שמורה לסימון המספר המרבי של הביטים הזמינים.
`kSystemFeatureTypeThreadConnected`	נתח חשיפות של ממשק Thread של המערכת \| לא מחובר.
`kSystemFeatureTypeThreadRoutingEnabled`	תכונת ניתוב פרוטוקול Thread של המערכת \| אינו מופעל.
`kSystemFeatureTypeTunnelInterfaceEnabled`	נתח חשיפות של ממשק המנהרה של המערכת \| אינו מופעל.
`kSystemFeatureTypeTunnelState`	נתח חשיפות של שירות המנהרה של המערכת \| IS לא הוקמה.
`kSystemFeatureTypeWiFiConnected`	נתח חשיפות של ממשק Wi-Fi של המערכת \| לא מחובר.

Typedefs

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
)

ממשק API של WARM שנקרא כדי להודיע על שינוי מצב בתכונה 'נתב Border'.

פרטים

פרמטרים

[in] inState

kInterfaceStateUp אם התכונה 'נתב Border' פועלת, kInterfaceStateDown במקרים אחרים.

CellularInterfaceStateChange

void CellularInterfaceStateChange(
  InterfaceState inState
)

WARM API שנקרא כדי להכריז על שינוי מצב בממשק של Cellular.

פרטים

פרמטרים

[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

הפניה של מצביע לאובייקט audienceState.

מוחזר ערכים

`WEAVE_NO_ERROR`	הצלחה.
`WEAVE_ERROR_INCORRECT_STATE`	אם ה-API הזה נקרא לפני האתחול של 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`	אם מתבצעת קריאה ל-API הזה בזמן ש-WARM לא חבר ב-Fabric.
`WEAVE_ERROR_INVALID_ARGUMENT`	אם ה-API הזה נקרא עם סוג ממשק לא חוקי.

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
)

ממשק API של WARM שמופעל על ידי משימה ייעודית כדי לבצע פעולות API שונות בפלטפורמה.

הערך הזה מייצג את נקודת הכניסה לביצוע הפעולות הנדרשות כדי לעמוד במצב המערכת הנוכחי. לדוגמה, אם מחסנית ה-thread עברה ממושבתת למופעלת, הפונקציה הזו תבצע את קריאות הפלטפורמה הדרושות כדי להקצות את כתובת המארח של ה-thread וכו'. צריך לקרוא לפונקציה הזו באמצעות קוד פלטפורמה רק בתגובה לקריאה של Warm ל-RequestInvokeActions. קריאה ל-InvokeActions תגרום לקריאה אחת או יותר ל-nl::Warm::Platform API. לכן, המפתחים צריכים להטמיע את RequestInvokeActions ואת מבצע הקריאה החוזרת של InvokeActions() בהתאם. יכול להיות שמתאים ש-RequestInvokeActions יפרסם אירוע למשימה שיקרא InvokeActions(), לדוגמה. לעומת זאת, אם המערכת בעלת שרשור יחיד, ניתן יהיה להטמיע את RequestInvokeActions כדי לקרוא ישירות ל-InvokeActions().

LegacyHostAddressAction

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

אחת מ-methods של פעולות.

מגדיר את כתובת המארח עבור הממשק מדור קודם.

פרטים

פרמטרים

`[in] inAction`	סוג הפעולה.
`[in] inActivate`	המצב הרצוי: true == enabled, false == disabled.
`[in] inGlobalId`	הפניה ל-Weave Global ID, אם יש צורך לחשב כתובת.
`[in] inInterfaceId`	הפניה למזהה הממשק של המכשיר, אם יש צורך לחשב כתובת.

החזרות

מעבירה את התוצאה מ-Platform::HostAddress().

LegacyThreadAddressAction

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

אחת מ-methods של פעולות.

הגדרת כתובת פרוטוקול Thread לממשק 6LoWPAN מדור קודם.

פרטים

פרמטרים

`[in] inAction`	סוג הפעולה.
`[in] inActivate`	המצב הרצוי: true == enabled, false == disabled.
`[in] inGlobalId`	הפניה ל-Weave Global ID, אם יש צורך לחשב כתובת.
`[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
)

פונקציה סטטית שמתעדת את התוצאה של קריאה לפעולה מסוג API בפלטפורמה.

המודול הזה שולח בקשות לבצע פעולות באמצעות ממשקי API ספציפיים לפלטפורמה. ממשקי ה-API נדרשים לדווח על התוצאה kPlatformresults|kProductPlatformFailure|kPlatformProductInProgress של בקשת הפעולה הזו. הפונקציה הזו מתעדת את התוצאה ומחזירה את הערך True אם התוצאה בתהליך ויש עיכוב בפעולות נוספות.

פרטים

פרמטרים

`[in] inResult`	התוצאה של ה-API של הפלטפורמה.
`[in] inAction`	הפעולה שה-API של הפלטפורמה ניסה לבצע.
`[in] inActionState`	המצב החדש של הפעולה, אם התוצאה הצליחה.

החזרות

True API של הפלטפורמה מעבד את הבקשה באופן אסינכרוני, אחרת False.

ReportActionComplete

void ReportActionComplete(
  PlatformResult inResult
)

בוצעה קריאה של WARM API כדי להודיע על השלמת קריאה קודמת ל-API של פלטפורמה אסינכרונית.

ההנחה היא שממשקי ה-API של פעולת הפלטפורמה יצטרכו לבצע פעולות אסינכרוניות. אם הערך הוא True, ה-API של הפלטפורמה יחזיר את הערך kPlatformresultsInProgress. לאחר מכן, נשעה פעולות חדשות של כתובת וניתוב עד שהמערכת תפעיל את ReportActionComplete כדי להודיע על השלמת הפעולה.

פרטים

פרמטרים

[in] inResult

התוצאה של הפעולה שבהמתנה. חייב להיות אחד מהערכים הבאים: {kPlatformPlatformSuccess | 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 API כדי לבצע את פעולות התגובה הנדרשות.

פרטים

פרמטרים

`[in] inSystemFeatureType`	המצב שהשתנה בהתאם ל-API שנקרא.
`[in] inState`	הערך החדש של המדינה.

TakeActions

void TakeActions(
  void
)

פונקציה סטטית שבודקת את המצב של כל פעולה ומבצעת קריאה ל-API של הפלטפורמה כדי לשנות את מצב הפעולה במקרה הצורך.

הפונקציה הזו משתמשת ב- להשביתPerformAction() כדי לקבוע אם צריך לשנות/לקחת מצב פעולה. אם הפונקציה PausePerformAction() מחזירה True, הפונקציה קוראת לממשק ה-API המתאים של הפעולה כדי לבצע את הפעולה במטרה להציב אותה במצב הרצוי. התוצאה של הקריאה לפעולה ל-API מועברת אל RecordPlatformPlatform()

ThreadAdvertisementAction

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

אחת מ-methods של פעולות.

הגדרת מצב הפרסום של שרשור

פרטים

פרמטרים

`[in] inAction`	סוג הפעולה.
`[in] inActivate`	המצב הרצוי: true == enabled, false == disabled.
`[in] inGlobalId`	הפניה ל-Weave Global ID, אם יש צורך לחשב כתובת.
`[in] inInterfaceId`	הפניה למזהה הממשק של המכשיר, אם יש צורך לחשב כתובת.

החזרות

מעביר את התוצאה מ-Platform::ThreadAdvertisingment().

ThreadHostAddressAction

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

אחת מ-methods של פעולות.

מגדירה את כתובת המארח עבור ממשק ה-Thread.

פרטים

פרמטרים

`[in] inAction`	סוג הפעולה.
`[in] inActivate`	המצב הרצוי: true == enabled, false == disabled.
`[in] inGlobalId`	הפניה ל-Weave Global ID, אם יש צורך לחשב כתובת.
`[in] inInterfaceId`	הפניה למזהה הממשק של המכשיר, אם יש צורך לחשב כתובת.

החזרות

מעבירה את התוצאה מ-Platform::HostAddress().

ThreadHostRouteAction

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

אחת מ-methods של פעולות.

מגדיר את הנתיב למארח עבור ממשק ה-Thread.

פרטים

פרמטרים

`[in] inAction`	סוג הפעולה.
`[in] inActivate`	המצב הרצוי: true == enabled, false == disabled.
`[in] inGlobalId`	הפניה ל-Weave Global ID, אם יש צורך לחשב כתובת.
`[in] inInterfaceId`	הפניה למזהה הממשק של המכשיר, אם יש צורך לחשב כתובת.

החזרות

העברת התוצאה מ-Platform::HostRoute().

ThreadInterfaceStateChange

void ThreadInterfaceStateChange(
  InterfaceState inState
)

API של WARM שנקרא כדי להכריז על שינוי מצב בממשק של פרוטוקול Thread.

פרטים

פרמטרים

[in] inState

kInterfaceStateUp אם ממשק ה-Thread פועל, אחרת kInterfaceStateDown.

ThreadRoutePriorityAction

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

אחת מ-methods של פעולות.

מגדירה את העדיפות של נתיב פרוטוקול Thread על סמך זמינות המנהרה.

פרטים

פרמטרים

`[in] inAction`	סוג הפעולה.
`[in] inActivate`	המצב הרצוי: true == enabled, false == disabled.
`[in] inGlobalId`	הפניה ל-Weave Global ID, אם יש צורך לחשב כתובת.
`[in] inInterfaceId`	הפניה למזהה הממשק של המכשיר, אם יש צורך לחשב כתובת.

החזרות

מעביר את התוצאה מ-Platform::ThreadRoutePriority().

ThreadRoutingStateChange

void ThreadRoutingStateChange(
  InterfaceState inState
)

API של WARM נקרא כדי להודיע על שינוי מצב בתכונה 'ניתוב שרשורים'.

פרטים

פרמטרים

[in] inState

kInterfaceStateUp אם תכונת הניתוב של Thread פועל, אחרת kInterfaceStateDown.

ThreadThreadAddressAction

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

אחת מ-methods של פעולות.

מגדיר את כתובת ה-thread של ממשק ה-Thread.

פרטים

פרמטרים

`[in] inAction`	סוג הפעולה.
`[in] inActivate`	המצב הרצוי: true == enabled, false == disabled.
`[in] inGlobalId`	הפניה ל-Weave Global ID, אם יש צורך לחשב כתובת.
`[in] inInterfaceId`	הפניה למזהה הממשק של המכשיר, אם יש צורך לחשב כתובת.

החזרות

מעבירה את התוצאה מ-Platform::ThreadAddress().

ThreadThreadRouteAction

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

אחת מ-methods של פעולות.

מגדיר את נתיב ה-thread של מקבץ השרשורים.

פרטים

פרמטרים

`[in] inAction`	סוג הפעולה.
`[in] inActivate`	המצב הרצוי: true == enabled, false == disabled.
`[in] inGlobalId`	הפניה ל-Weave Global ID, אם יש צורך לחשב כתובת.
`[in] inInterfaceId`	הפניה למזהה הממשק של המכשיר, אם יש צורך לחשב כתובת.

החזרות

מעביר את התוצאה מ-Platform::ThreadRoute().

TunnelHostAddressAction

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

אחת מ-methods של פעולות.

מגדיר את HostAddress עבור ממשק המנהרה.

פרטים

פרמטרים

`[in] inAction`	סוג הפעולה.
`[in] inActivate`	המצב הרצוי: true == enabled, false == disabled.
`[in] inGlobalId`	הפניה ל-Weave Global ID, אם יש צורך לחשב כתובת.
`[in] inInterfaceId`	הפניה למזהה הממשק של המכשיר, אם יש צורך לחשב כתובת.

החזרות

מעבירה את התוצאה מ-Platform::HostAddress().

TunnelHostRouteAction

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

אחת מ-methods של פעולות.

מגדיר את HostRoute עבור ממשק המנהרה.

פרטים

פרמטרים

`[in] inAction`	סוג הפעולה.
`[in] inActivate`	המצב הרצוי: true == enabled, false == disabled.
`[in] inGlobalId`	הפניה ל-Weave Global ID, אם יש צורך לחשב כתובת.
`[in] inInterfaceId`	הפניה למזהה הממשק של המכשיר, אם יש צורך לחשב כתובת.

החזרות

העברת התוצאה מ-Platform::HostRoute().

TunnelInterfaceStateChange

void TunnelInterfaceStateChange(
  InterfaceState inState
)

ממשק API של WARM שנקרא כדי להכריז על שינוי מצב בממשק של Weave Tunnel.

פרטים

פרמטרים

[in] inState

kInterfaceStateUp אם ממשק Weave Tunnel פועל, אחרת kInterfaceStateDown.

TunnelPriorityStateChange

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

קריאה של WARM API לעדכון העדיפות של שירות המנהרה.

פרטים

פרמטרים

[in] inAvailability

הערך החדש של סטטוס הזמינות של המנהרה.

TunnelServiceStateChange

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

ממשק API של 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
)

אחת מ-methods של פעולות.

מגדיר את 'כתובת המארח' עבור ממשק ה-Wi-Fi.

פרטים

פרמטרים

`[in] inAction`	סוג הפעולה.
`[in] inActivate`	המצב הרצוי: true == enabled, false == disabled.
`[in] inGlobalId`	הפניה ל-Weave Global ID, אם יש צורך לחשב כתובת.
`[in] inInterfaceId`	הפניה למזהה הממשק של המכשיר, אם יש צורך לחשב כתובת.

החזרות

מעבירה את התוצאה מ-Platform::HostAddress().

WiFiInterfaceStateChange

void WiFiInterfaceStateChange(
  InterfaceState inState
)

WARM API שנקרא כדי להכריז על שינוי מצב בממשק ה-Wi-Fi.

פרטים

פרמטרים

[in] inState

kInterfaceStateUp אם ממשק ה-Wi-Fi פועל, אחרת kInterfaceStateDown.

nl::Weave::Warm

סיכום

ערכים של ספירה

Typedefs

משתנים

פונקציות

שיעורים

מבנים

מרחבי שמות

ערכים של ספירה

ActionType

InitState

InterfaceState

InterfaceType

PlatformActionExecution

PlatformResult

RoutePriority

SystemFeatureType

Typedefs

ActionFunction

FlagsType

משתנים

kGlobalULAPrefixLength

kLegacy6LoWPANULAAddressPrefixLength

kThreadULAAddressPrefixLength

kTunnelAddressPrefixLength

kWiFiULAAddressPrefixLength

sFabricStateDelegate

sState

פונקציות

BorderRouterStateChange

CellularInterfaceStateChange

FabricStateChange

GetCurrentActionState

GetFabricState

GetSystemFeatureState

GetULA

Init

InvokeActions

LegacyHostAddressAction

LegacyThreadAddressAction

MakePrefix

MapAvailabilityToPriority

RecordPlatformResult

ReportActionComplete

SetCurrentActionState

SetSystemFeatureState

ShouldPerformAction

SystemFeatureStateChangeHandler

TakeActions

ThreadAdvertisementAction

ThreadHostAddressAction

ThreadHostRouteAction

ThreadInterfaceStateChange

ThreadRoutePriorityAction

ThreadRoutingStateChange

ThreadThreadAddressAction

ThreadThreadRouteAction

TunnelHostAddressAction

TunnelHostRouteAction

TunnelInterfaceStateChange

TunnelPriorityStateChange

TunnelServiceStateChange

WiFiHostAddressAction

WiFiInterfaceStateChange