nl::Weave::Warm

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

ערכי דף
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
ממשק API של WARM נקרא כדי להודיע על שינוי מצב בתכונה 'נתב גבול'.
CellularInterfaceStateChange(InterfaceState inState)
void
ממשק API של WARM נקרא כדי להכריז על שינוי מצב בממשק הסלולרי.
FabricStateChange(InterfaceState inState)
void
פונקציה שנקראה כדי להודיע על שינוי מצב בתכונה 'בד Weave'.
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)
ממשק API של WARM לביצוע אתחול מודול חד-פעמי.
InvokeActions(void)
void
ממשק API 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)
פונקציה סטטית שמתעדת את התוצאה של קריאה לפעולה של Platform 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)
אחת משיטות הפעולה.
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
ממשק API של WARM נקרא כדי להכריז על שינוי מצב בממשק של Thread.
ThreadRoutePriorityAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
אחת משיטות הפעולה.
ThreadRoutingStateChange(InterfaceState inState)
void
ממשק API WARM שנקרא כדי להכריז על שינוי במצב של התכונה Thread Routing.
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 API נקרא כדי להכריז על שינוי מצב בממשק Weave Tunnel.
TunnelPriorityStateChange(nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability)
void
ממשק API WARM שנקרא כדי לעדכן את העדיפות של שירות Tunnel.
TunnelServiceStateChange(InterfaceState inState, nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability)
void
WARM API נקרא כדי להכריז על שינוי מצב בממשק Weave Tunnel.
WiFiHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
אחת משיטות הפעולה.
WiFiInterfaceStateChange(InterfaceState inState)
void
ממשק API של WARM נקרא כדי להכריז על שינוי מצב בממשק ה-Wi-Fi.

מחלקות
nl::Weave::Warm::WarmFabricStateDelegate

זוהי כיתה פנימית ל-WumCore.

מבנים
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 של מודול ה-Thread.

kActionTypeMax

אין לחרוג; שמורה לסימון המספר המקסימלי של הסיביות הזמינות.

kActionTypeThreadAdvertisement

התחלה | עוצרים את פרסום המסלול באמצעות מודול Thread.

kActionTypeThreadHostAddress

הוספה | הסרת כתובת ה-IP של ממשק השרשורים בסטאק ה-IP של המארח.

kActionTypeThreadRoute

הוספה | הסרה של נתיב ה-IP במודול Thread לתמיכה בנתיבי גבול.

kActionTypeThreadRoutePriority

שינוי עדיפות הנתיב של נתיב השרשור במודול השרשור.

kActionTypeThreadThreadAddress

הוספה | הסרת כתובת ה-IP של ממשק ה-Thread בסטאק ה-IP של מודול השרשור.

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

ממשק ה-Wi-Fi.

PlatformActionExecution

 PlatformActionExecution
תכונות
kPlatformActionExecutionContinue

המשך בביצוע הפעולה.

kPlatformActionExecutionSuspendForAsynchOpCompletion

השעה את ביצוע הפעולה לביצוע פעולה אסינכרונית.

PlatformResult

 PlatformResult

enum של ערכים אפשריים להחזרה של Platform API.

תכונות
kPlatformResultFailure

הפעלת ה-API נכשלה.

kPlatformResultInProgress

הפעולה מתבצעת ותושלם באופן אסינכרוני.

kPlatformResultSuccess

ממשק ה-API הושלם בהצלחה.

RoutePriority

 RoutePriority

רשימה של עדיפויות אפשריות למסלול, כך שנתיב אחד יקבל עדיפות על פני מסלול אחר.

SystemFeatureType

 SystemFeatureType
תכונות
kSystemFeatureTypeBorderRoutingEnabled

התכונה של ניתוב הגבול של המערכת היא | אינה מופעלת.

kSystemFeatureTypeCellularConnected

הממשק הסלולרי של המערכת | לא מחובר.

kSystemFeatureTypeIsFabricMember

מודול ה-Weave של המערכת | אינו חלק מבד.

kSystemFeatureTypeMax

אין לחרוג; שמורה לסימון המספר המקסימלי של הסיביות הזמינות.

kSystemFeatureTypeThreadConnected

ממשק Thread של המערכת | אינו מחובר.

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
)

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

פרטים
פרמטרים
[in] inState
kInterfaceStateUp אם התכונה Border Router פועלת. אחרת, צריך לבצע kInterfaceStateDown.

CellularInterfaceStateChange

void CellularInterfaceStateChange(
  InterfaceState inState
)

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

פרטים
פרמטרים
[in] inState
kInterfaceStateUp אם הממשק Cellular פועל. אחרת, kInterfaceStateDown.

FabricStateChange

void FabricStateChange(
  InterfaceState inState
)

פונקציה שנקראה כדי להודיע על שינוי מצב בתכונה 'בד Weave'.

פרטים
פרמטרים
[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
הפניה של מצביע לאובייקט audioState.
ערכים מוחזרים
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 הזה הופעל סוג ממשק לא חוקי.

הפעלה

WEAVE_ERROR Init(
  WeaveFabricState & inFabricState
)

ממשק API של WARM לביצוע אתחול מודול חד-פעמי.

פרטים
פרמטרים
[in] inFabricState
הפניה אל WeaveFabricState חוקית.
ערכים מוחזרים
WEAVE_NO_ERROR
כשהאתחול בוצע בהצלחה.
WEAVE_ERROR_INCORRECT_STATE
כשמתבצעת קריאה ל-Init יותר מפעם אחת.
other
אחרת, יש להזין את קוד השגיאה.
החזרות
WEAVE_NO_ERROR הצלחה. אחרת, קוד השגיאה.

InvokeActions

void InvokeActions(
  void
)

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

הוא מייצג את נקודת הכניסה לביצוע הפעולות הדרושות כדי להתאים למצב המערכת הנוכחי. לדוגמה, אם מחסנית השרשורים הועברה ממצב 'מושבת' למצב מופעל, הפונקציה הזו תבצע את קריאות הפלטפורמה הנדרשות כדי להקצות את כתובת המארח של ה-thread וכו'. יש להפעיל את הפונקציה הזו באמצעות קוד פלטפורמה רק בתגובה לקריאה חמה ל-RequestInvokeActions. קריאה ל-InvokeActions תגרום להפעלה אחת או יותר של ה-API מסוג 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
)

אחת משיטות הפעולה.

מגדיר את הכתובת לשרשורים לממשק Legacy 6LoWPAN.

פרטים
פרמטרים
[in] inAction
סוג הפעולה.
[in] inActivate
המצב הרצוי True == enable, false == האירוע מושבת.
[in] inGlobalId
הפניה למזהה הגלובלי של Weave, אם יש צורך לחשב כתובת.
[in] inInterfaceId
הפניה למזהה הממשק של המכשיר, אם יש צורך לחשב כתובת.
החזרות
מעביר את התוצאה מפלטפורמה::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
)

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

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

פרטים
פרמטרים
[in] inResult
תוצאת ה-Platform API.
[in] inAction
הפעולה שמשתמש ה-Platform API ניסה.
[in] inActionState
המצב החדש של הפעולה, אם התוצאה הצליחה.
החזרות
true, ה-API של הפלטפורמה מעבד את הבקשה באופן אסינכרוני. אחרת, הוא false.

ReportActionComplete

void ReportActionComplete(
  PlatformResult inResult
)

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

ההנחה היא שממשקי ה-API של פעולת הפלטפורמה עשויים לבצע פעולות אסינכרוניות. אם זה נכון, ה-Platform API יחזיר את הערך kPlatformResultsInProgress. במקרה כזה, יושעו כתובות חדשות ופעולות ניתוב חדשות עד שהמערכת תבצע קריאה ל-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
)

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

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

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

TakeActions

void TakeActions(
  void
)

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

בפונקציה הזו נעשה שימוש ב-כדאי לבצעAction() כדי לקבוע אם יש לשנות או לנקוט מצב פעולה מסוים. אםצריך לבצעAction() כדי להחזיר את הערך true, הפונקציה תקרא ל-API של הפעולה המתאים כדי לבצע את הפעולה במטרה להעביר אותה למצב הרצוי. התוצאה של הקריאה לפעולה ל-API מועברת אל RecordPlatformResults() , ואם הפונקציה מחזירה את הערך 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::ThreadAdvertisement().

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
)

ממשק API של WARM נקרא כדי להכריז על שינוי מצב בממשק של 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
)

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

פרטים
פרמטרים
[in] inState
kInterfaceStateUp אם תכונת הניתוב Thread פועלת. אחרת, צריך לבצע kInterfaceStateDown.

ThreadThreadAddressAction

PlatformResult ThreadThreadAddressAction(
  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
הפניה למזהה הממשק של המכשיר, אם יש צורך לחשב כתובת.
החזרות
מעביר את התוצאה מפלטפורמה::ThreadAddress().

ThreadThreadRouteAction

PlatformResult ThreadThreadRouteAction(
  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::ThreadRoute().

TunnelHostAddressAction

PlatformResult TunnelHostAddressAction(
  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().

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 API נקרא כדי להכריז על שינוי מצב בממשק Weave Tunnel.

פרטים
פרמטרים
[in] inState
kInterfaceStateUp אם ממשק ה-Weave Tunnel פועל, אחרת kInterfaceStateDown.

TunnelPriorityStateChange

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

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

פרטים
פרמטרים
[in] inAvailability
הערך החדש של סטטוס זמינות המנהרה.

TunnelServiceStateChange

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

WARM API נקרא כדי להכריז על שינוי מצב בממשק 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 == enable, false == האירוע מושבת.
[in] inGlobalId
הפניה למזהה הגלובלי של Weave, אם יש צורך לחשב כתובת.
[in] inInterfaceId
הפניה למזהה הממשק של המכשיר, אם יש צורך לחשב כתובת.
החזרות
מעביר את התוצאה מ-Platform::HostAddress().

WiFiInterfaceStateChange

void WiFiInterfaceStateChange(
  InterfaceState inState
)

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

פרטים
פרמטרים
[in] inState
kInterfaceStateUp אם ממשק ה-Wi-Fi פועל, אחרת kInterfaceStateDown.