nl:: بافت:: گرم

این فضای نام شامل رابط‌هایی برای Weave Address و Routing Module، یک ماژول قابل حمل برای پیکربندی آدرس‌های 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
تعدادی از مقادیر بازگشتی 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

Typedefs

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 گرم برای اعلام تغییر وضعیت برای ویژگی روتر Border فراخوانی شده است.
CellularInterfaceStateChange ( InterfaceState inState)
void
یک API گرم برای اعلام تغییر وضعیت برای رابط سلولی فراخوانی شده است.
FabricStateChange ( InterfaceState inState)
void
تابعی فراخوانی شده تا تغییر حالت را برای ویژگی Weave Fabric اعلام کند.
GetCurrentActionState ( ActionType inAction)
bool
یک تابع استاتیک که وضعیت فعلی یک عمل مشخص را برمی گرداند.
GetFabricState (const WeaveFabricState *& outFabricState)
یک API WARM برای بدست آوردن شی FabricState که در طول Init در اختیار Warm قرار گرفت.
GetSystemFeatureState ( SystemFeatureType inSystemFeature)
bool
یک تابع استاتیک که وضعیت فعلی یک ویژگی سیستم را دریافت می کند.
GetULA ( InterfaceType inInterfaceType, Inet::IPAddress & outAddress)
یک API گرم برای به دست آوردن ULA برای یک نوع رابط مشخص.
Init ( WeaveFabricState & inFabricState)
یک API گرم برای انجام یک بار مقدار دهی اولیه ماژول.
InvokeActions (void)
void
یک API گرم که توسط یک وظیفه اختصاصی برای انجام اقدامات 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)
یک تابع ثابت که نتیجه تماس API Action پلت فرم را ثبت می کند.
ReportActionComplete ( PlatformResult inResult)
void
یک 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 گرم برای اعلام تغییر وضعیت برای رابط Thread فراخوانی شده است.
ThreadRoutePriorityAction ( ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
یکی از روش های اقدام
ThreadRoutingStateChange ( InterfaceState inState)
void
یک API گرم برای اعلام تغییر وضعیت برای ویژگی 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
یک API گرم برای اعلام تغییر وضعیت برای رابط Weave Tunnel فراخوانی شده است.
TunnelPriorityStateChange ( nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability)
void
یک API گرم برای به روز رسانی اولویت سرویس تونل فراخوانی شده است.
TunnelServiceStateChange ( InterfaceState inState, nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability)
void
یک API گرم برای اعلام تغییر وضعیت برای رابط Weave Tunnel فراخوانی شده است.
WiFiHostAddressAction ( ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
یکی از روش های اقدام
WiFiInterfaceStateChange ( InterfaceState inState)
void
یک API گرم برای اعلام تغییر وضعیت برای رابط WiFi فراخوانی شده است.

کلاس ها

nl:: بافت:: گرم:: WarmFabricStateDelegate

این یک کلاس داخلی برای WarmCore است.

سازه ها

nl:: بافت:: گرم:: ActionEntry
nl:: بافت:: گرم:: ModuleState

فضاهای نام

nl:: بافت:: گرم:: سکو

شمارش ها

نوع اقدام 

 ActionType
خواص
kActionTypeHostRouteThread

اضافه کردن | مسیر IP را برای Thread Interface در پشته IP میزبان حذف کنید.

kActionTypeLegacy6LoWPANHostAddress

اضافه کردن | آدرس IP رابط Legacy 6LowPAN را در پشته IP میزبان حذف کنید.

kActionTypeLegacy6LoWPANThreadAddress

اضافه کردن | آدرس IP رابط Legacy 6LowPAN را در پشته IP ماژول Thread حذف کنید.

kActionTypeMax

تجاوز نکنید؛ برای علامت گذاری حداکثر بیت های موجود رزرو شده است.

kActionTypeThreadAdvertisement

شروع | تبلیغات مسیر را توسط ماژول Thread متوقف کنید.

kActionTypeThreadHostAddress

اضافه کردن | آدرس IP مربوط به Thread Interface را در پشته IP میزبان حذف کنید.

kActionTypeThreadRoute

اضافه کردن | مسیر IP را در Thread Module برای پشتیبانی از Border Route حذف کنید.

kActionTypeThreadRoutePriority

اولویت مسیر Thread Route را در ماژول Thread تغییر دهید.

kActionTypeThreadThreadAddress

اضافه کردن | آدرس IP رابط Thread را در پشته IP ماژول Thread حذف کنید.

kActionTypeTunnelHostAddress

اضافه کردن | آدرس IP رابط تونل را در پشته IP میزبان حذف کنید.

kActionTypeTunnelHostRoute

اضافه کردن | مسیر IP را برای رابط تونل در پشته IP میزبان حذف کنید.

kActionTypeTunnelServiceRoute

اضافه کردن | مسیر IP 64 بیتی را برای زیرشبکه Service در پشته IP میزبان حذف کنید.

kActionTypeWiFiHostAddress

اضافه کردن | آدرس IP رابط WiFi را در پشته IP میزبان حذف کنید.

InitState 

 InitState
خواص
kInitStateNotInitialized

این باید 0 باشد تا مقدار اولیه mInitState kInitStateNotInitialized شود.

حالت رابط

 InterfaceState

تعدادی از مقادیر ممکن حالت رابط.

نوع رابط

 InterfaceType

تعدادی از انواع رابط های ممکن

خواص
kInterfaceTypeCellular

رابط سلولی

kInterfaceTypeLegacy6LoWPAN

رابط زنگ موضوع.

kInterfaceTypeThread

رابط موضوع.

kInterfaceTypeTunnel

رابط تونل.

kInterfaceTypeWiFi

رابط WiFi.

PlatformActionExecution 

 PlatformActionExecution
خواص
kPlatformActionExecutionContinue

ادامه اجرای اکشن

kPlatformActionExecutionSuspendForAsynchOpCompletion

تعلیق اجرای عملیات برای تکمیل عملیات ناهمزمان.

نتیجه پلتفرم

 PlatformResult

تعدادی از مقادیر بازگشتی API پلتفرم ممکن.

خواص
kPlatformResultFailure

اجرای API ناموفق بود.

kPlatformResultInProgress

عملیات در حال انجام است و به صورت ناهمزمان کامل می شود.

kPlatformResultSuccess

API با موفقیت تکمیل شد.

اولویت مسیر

 RoutePriority

تعدادی از اولویت های مسیر ممکن به طوری که بتوان یک مسیر را نسبت به مسیر دیگر اولویت داد.

SystemFeatureType 

 SystemFeatureType
خواص
kSystemFeatureTypeBorderRoutingEnabled

ویژگی مسیریابی مرزی سیستم IS | فعال نیست.

kSystemFeatureTypeCellularConnected

رابط سلولی سیستم IS | متصل نیست.

kSystemFeatureTypeIsFabricMember

ماژول بافت سیستم IS | عضوی از پارچه نیست.

kSystemFeatureTypeMax

تجاوز نکنید؛ برای علامت گذاری حداکثر بیت های موجود رزرو شده است.

kSystemFeatureTypeThreadConnected

رابط موضوعی سیستم IS | متصل نیست.

kSystemFeatureTypeThreadRoutingEnabled

ویژگی مسیریابی نخ سیستم IS | فعال نیست.

kSystemFeatureTypeTunnelInterfaceEnabled

رابط تونل سیستم IS | فعال نیست.

kSystemFeatureTypeTunnelState

سرویس تونل سیستم IS | تاسیس نشده است.

kSystemFeatureTypeWiFiConnected

رابط WiFi سیستم IS | متصل نیست.

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

طول آدرس kLegacy6LoWPANULAPrefixLength 

const uint8_t kLegacy6LoWPANULAAddressPrefixLength = 64

kThreadULAaddressPrefixLength 

const uint8_t kThreadULAAddressPrefixLength = 64

kTunnelAddressPrefixLength 

const uint8_t kTunnelAddressPrefixLength = 128

طول آدرس kWiFiULAPrefix 

const uint8_t kWiFiULAAddressPrefixLength = 64

sFabricStateDelegate 

WarmFabricStateDelegate sFabricStateDelegate

s State 

ModuleState sState

توابع

BorderRouterStateChange

void BorderRouterStateChange(
  InterfaceState inState
)

یک API گرم برای اعلام تغییر وضعیت برای ویژگی روتر Border فراخوانی شده است.

جزئیات
پارامترها
[in] inState
kInterfaceStateUp اگر ویژگی مسیریاب Border بالا است، در غیر این صورت kInterfaceStateDown.

CellularInterfaceStateChange

void CellularInterfaceStateChange(
  InterfaceState inState
)

یک API گرم برای اعلام تغییر وضعیت برای رابط سلولی فراخوانی شده است.

جزئیات
پارامترها
[in] inState
kInterfaceStateUp اگر رابط Cellular بالا است، kInterfaceStateDown در غیر این صورت.

FabricStateChange

void FabricStateChange(
  InterfaceState inState
)

تابعی فراخوانی شده تا تغییر حالت را برای ویژگی Weave Fabric اعلام کند.

جزئیات
پارامترها
[in] inState
kInterfaceStateUp اگر سیستم عضوی از پارچه Weave است، در غیر این صورت kInterfaceStateDown.

GetCurrentActionState

bool GetCurrentActionState(
  ActionType inAction
)

یک تابع استاتیک که وضعیت فعلی یک عمل مشخص را برمی گرداند.

جزئیات
پارامترها
[in] inAction
نوع اقدام برای پرس و جو.
برمی گرداند
درست است اگر عمل تنظیم شود، در غیر این صورت نادرست است.

GetFabricState

WEAVE_ERROR GetFabricState(
  const WeaveFabricState *& outFabricState
)

یک API WARM برای بدست آوردن شی FabricState که در طول Init در اختیار Warm قرار گرفت.

جزئیات
پارامترها
[out] outFabricState
یک اشاره گر به یک شی پارچه State.
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
WEAVE_ERROR_INCORRECT_STATE
اگر این API قبل از راه اندازی WARM فراخوانی شود.

GetSystemFeatureState

bool GetSystemFeatureState(
  SystemFeatureType inSystemFeature
)

یک تابع استاتیک که وضعیت فعلی یک ویژگی سیستم را دریافت می کند.

جزئیات
پارامترها
[in] inSystemFeature
ویژگی سیستم برای پرس و جو.
برمی گرداند
درست است اگر ویژگی سیستم فعال باشد، در غیر این صورت نادرست است.

GetULA

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

یک 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 گرم برای انجام یک بار مقدار دهی اولیه ماژول.

جزئیات
پارامترها
[in] inFabricState
ارجاع به WeaveFabricState معتبر.
ارزش های بازگشتی
WEAVE_NO_ERROR
در مقداردهی اولیه موفقیت آمیز
WEAVE_ERROR_INCORRECT_STATE
هنگامی که Init بیش از یک بار فراخوانی شود.
other
کد خطا در غیر این صورت.
برمی گرداند
WEAVE_NO_ERROR در مورد موفقیت، کد خطا در غیر این صورت.

InvokeActions

void InvokeActions(
  void
)

یک API گرم که توسط یک وظیفه اختصاصی برای انجام اقدامات API پلتفرم مختلف فراخوانی می شود.

این نشان دهنده نقطه ورود برای انجام اقدامات لازم است که وضعیت فعلی سیستم را برآورده می کند. اگر برای مثال پشته Thread از غیرفعال به فعال تبدیل شود، این تابع فراخوانی های پلتفرم لازم را برای اختصاص آدرس میزبان رشته و غیره انجام می دهد. این تابع باید با کد پلت فرم فقط در پاسخ به تماس گرم به 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
)

یکی از روش های اقدام

آدرس میزبان را برای رابط قدیمی تنظیم می کند.

جزئیات
پارامترها
[in] inAction
نوع عمل
[in] inActivate
حالت مورد نظر درست == فعال کردن، نادرست == غیرفعال کردن.
[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
حالت مورد نظر درست == فعال کردن، نادرست == غیرفعال کردن.
[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
حالت در دسترس بودن تونل بافت.
برمی گرداند
ارزش نگاشت اولویت.

RecordPlatformResult

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

یک تابع ثابت که نتیجه تماس API Action پلت فرم را ثبت می کند.

این ماژول درخواست هایی را برای انجام اقدامات از طریق API های خاص پلت فرم ارائه می کند. APIها باید kPlatformResultSuccess|kPlatformResultFailure|kPlatformResultInProgress نتیجه آن درخواست اقدام را گزارش کنند. این تابع نتیجه را ثبت می کند و اگر نتیجه در حال انجام باشد و اقدامات بعدی باید به تعویق بیفتد، مقدار true را برمی گرداند.

جزئیات
پارامترها
[in] inResult
نتیجه API پلتفرم.
[in] inAction
اقدامی که API پلتفرم انجام داد.
[in] inActionState
وضعیت جدید عمل اگر نتیجه موفقیت آمیز بود.
برمی گرداند
true API پلتفرم به صورت ناهمزمان درخواست را پردازش می کند، در غیر این صورت نادرست است.

ReportActionComplete

void ReportActionComplete(
  PlatformResult inResult
)

یک API گرم برای اعلام تکمیل تماس API پلت فرم ناهمزمان قبلی فراخوانی شده است.

فرض بر این است که API های اکشن پلتفرم ممکن است نیاز به انجام عملیات ناهمزمان داشته باشند. اگر این درست باشد، 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
ویژگی System برای تنظیم.
[in] inValue
ارزش دولت جدید برای اتخاذ.
برمی گرداند
درست است اگر ویژگی سیستم تغییر کرده باشد، در غیر این صورت نادرست است.

ShouldPerformAction

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

یک تابع استاتیک که تعیین می کند آیا عمل مشخص شده باید انجام شود یا خیر.

این تابع وضعیت پرچم‌های وضعیت ویژگی سیستم را بررسی می‌کند و تعیین می‌کند که آیا عملکرد مشخص‌شده باید فعال یا غیرفعال شود. سپس تابع وضعیت فعلی عمل را بررسی می‌کند و اگر عمل روی مقدار مورد نیاز حالت ویژگی سیستم تنظیم نشده باشد، تابع true به همراه حالت عمل مورد نظر در outActivate برمی‌گرداند.

جزئیات
پارامترها
[in] inAction
اقدامی که باید پرس و جو شود.
[in] inNecessarySystemFeatureState
پرچم های ایالتی برای فعال بودن اقدام ضروری است.
[out] outActivate
حالت مطلوب عمل.
برمی گرداند
درست است اگر عمل در حال حاضر در وضعیت مطلوب نیست، در غیر این صورت نادرست است.

SystemFeatureStateChangeHandler

void SystemFeatureStateChangeHandler(
  SystemFeatureType inSystemFeatureType,
  bool inState
)

یک تابع ثابت که وضعیت ویژگی سیستم را تنظیم می کند و به پلت فرم اطلاع می دهد که وضعیت رویداد تغییر کرده است.

توسط API های EventStateChange برای انجام عملیات واکنش لازم فراخوانی می شود.

جزئیات
پارامترها
[in] inSystemFeatureType
وضعیتی که مطابق با API تغییر کرد، تماس گرفت.
[in] inState
ارزش جدید برای دولت

TakeActions

void TakeActions(
  void
)

یک تابع ثابت که وضعیت هر عمل را آزمایش می کند و یک API پلتفرم را فراخوانی می کند تا در صورت لزوم وضعیت عملکرد را تغییر دهد.

این تابع از ShouldPerformAction() برای تعیین اینکه آیا یک حالت عمل نیاز به تغییر/گرفتن دارد یا خیر استفاده می کند. اگر ShouldPerformAction() true را برگرداند، تابع API مربوط به عمل را برای انجام عمل به منظور قرار دادن آن در حالت مورد نظر فراخوانی می کند. نتیجه فراخوانی API API به RecordPlatformResult() ارسال می شود و اگر آن تابع true را برگرداند، اجرای این تابع خاتمه می یابد.

Thread AdvertisementAction

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

یکی از روش های اقدام

وضعیت تبلیغ موضوع را تنظیم می کند

جزئیات
پارامترها
[in] inAction
نوع عمل
[in] inActivate
حالت مورد نظر درست == فعال کردن، نادرست == غیرفعال کردن.
[in] inGlobalId
در صورت نیاز برای محاسبه آدرس، یک ارجاع به شناسه جهانی Weave.
[in] inInterfaceId
ارجاع به شناسه رابط دستگاه در صورت نیاز برای محاسبه آدرس.
برمی گرداند
نتیجه را از Platform::ThreadAdvertisement().

ThreadHostAddressAction

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

یکی از روش های اقدام

آدرس میزبان را برای رابط موضوع تنظیم می کند.

جزئیات
پارامترها
[in] inAction
نوع عمل
[in] inActivate
حالت مورد نظر درست == فعال کردن، نادرست == غیرفعال کردن.
[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
حالت مورد نظر درست == فعال کردن، نادرست == غیرفعال کردن.
[in] inGlobalId
در صورت نیاز برای محاسبه آدرس، یک ارجاع به شناسه جهانی Weave.
[in] inInterfaceId
ارجاع به شناسه رابط دستگاه در صورت نیاز برای محاسبه آدرس.
برمی گرداند
نتیجه را از Platform::HostRoute().

ThreadInterfaceStateChange

void ThreadInterfaceStateChange(
  InterfaceState inState
)

یک 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
حالت مورد نظر درست == فعال کردن، نادرست == غیرفعال کردن.
[in] inGlobalId
در صورت نیاز برای محاسبه آدرس، یک ارجاع به شناسه جهانی Weave.
[in] inInterfaceId
ارجاع به شناسه رابط دستگاه در صورت نیاز برای محاسبه آدرس.
برمی گرداند
نتیجه را از Platform::ThreadRoutePriority().

ThreadRoutingStateChange

void ThreadRoutingStateChange(
  InterfaceState inState
)

یک API گرم برای اعلام تغییر وضعیت برای ویژگی Thread Routing فراخوانی شده است.

جزئیات
پارامترها
[in] inState
kInterfaceStateUp اگر ویژگی مسیریابی Thread بالا باشد، در غیر این صورت kInterfaceStateDown.

ThreadThreadAddressAction

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

یکی از روش های اقدام

آدرس رشته را برای رابط موضوع تنظیم می کند.

جزئیات
پارامترها
[in] inAction
نوع عمل
[in] inActivate
حالت مورد نظر درست == فعال کردن، نادرست == غیرفعال کردن.
[in] inGlobalId
در صورت نیاز برای محاسبه آدرس، یک ارجاع به شناسه جهانی Weave.
[in] inInterfaceId
ارجاع به شناسه رابط دستگاه در صورت نیاز برای محاسبه آدرس.
برمی گرداند
نتیجه را از Platform::ThreadAddress().

ThreadThreadRouteAction

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

یکی از روش های اقدام

مسیر Thread را برای پشته Thread تنظیم می کند.

جزئیات
پارامترها
[in] inAction
نوع عمل
[in] inActivate
حالت مورد نظر درست == فعال کردن، نادرست == غیرفعال کردن.
[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
حالت مورد نظر درست == فعال کردن، نادرست == غیرفعال کردن.
[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
حالت مورد نظر درست == فعال کردن، نادرست == غیرفعال کردن.
[in] inGlobalId
در صورت نیاز برای محاسبه آدرس، یک ارجاع به شناسه جهانی Weave.
[in] inInterfaceId
ارجاع به شناسه رابط دستگاه در صورت نیاز برای محاسبه آدرس.
برمی گرداند
نتیجه را از Platform::HostRoute().

TunnelInterfaceStateChange

void TunnelInterfaceStateChange(
  InterfaceState inState
)

یک API گرم برای اعلام تغییر وضعیت برای رابط Weave Tunnel فراخوانی شده است.

جزئیات
پارامترها
[in] inState
kInterfaceStateUp اگر رابط Weave Tunnel بالا باشد، kInterfaceStateDown در غیر این صورت.

TunnelPriorityStateChange

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

یک API گرم برای به روز رسانی اولویت سرویس تونل فراخوانی شده است.

جزئیات
پارامترها
[in] inAvailability
مقدار جدید برای وضعیت در دسترس بودن تونل.

TunnelServiceStateChange

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

یک 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
)

یکی از روش های اقدام

آدرس میزبان را برای رابط WiFi تنظیم می کند.

جزئیات
پارامترها
[in] inAction
نوع عمل
[in] inActivate
حالت مورد نظر درست == فعال کردن، نادرست == غیرفعال کردن.
[in] inGlobalId
در صورت نیاز برای محاسبه آدرس، یک ارجاع به شناسه جهانی Weave.
[in] inInterfaceId
ارجاع به شناسه رابط دستگاه در صورت نیاز برای محاسبه آدرس.
برمی گرداند
نتیجه را از Platform::HostAddress().

WiFiInterfaceStateChange

void WiFiInterfaceStateChange(
  InterfaceState inState
)

یک API گرم برای اعلام تغییر وضعیت برای رابط WiFi فراخوانی شده است.

جزئیات
پارامترها
[in] inState
kInterfaceStateUp اگر رابط WiFi بالا است، kInterfaceStateDown در غیر این صورت.