nl::Weave::Warm::Platform

สรุป

ฟังก์ชัน
AddRemoveHostAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, uint8_t inPrefixLength, bool inAdd)
API ของแพลตฟอร์มที่ Warm จะเรียกให้เพิ่ม / นำที่อยู่ IP ของโฮสต์ออกจากอินเทอร์เฟซที่ระบุในสแต็ก TCP/IP ของโฮสต์
AddRemoveHostRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
API ของแพลตฟอร์มที่ Warm จะเรียกให้เพิ่ม / นำเส้นทาง IP ออกสำหรับอินเทอร์เฟซที่ระบุในสแต็ก TCP/IP ของโฮสต์
AddRemoveThreadAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, bool inAdd)
API ของแพลตฟอร์มที่ Warm จะเรียกให้เพิ่ม / นำที่อยู่ IP ออกจากอินเทอร์เฟซที่ระบุในสแต็ก TCP/IP ของเทรด
AddRemoveThreadRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
API ของแพลตฟอร์มที่ Warm จะเรียกให้เพิ่ม / นำเส้นทาง IP ออกสำหรับอินเทอร์เฟซที่ระบุในสแต็ก TCP/IP ของเทรด
CriticalSectionEnter(void)
void
API ของแพลตฟอร์มที่ Warm จะเรียกใช้เพื่อป้องกันการเข้าถึงสถานะภายใน
CriticalSectionExit(void)
void
API ของแพลตฟอร์มที่ Warm จะเรียกใช้เพื่อปล่อยสิทธิ์เข้าถึงที่มีการป้องกันไปยังสถานะภายใน
Init(WarmFabricStateDelegate *inFabricStateDelegate)
แพลตฟอร์ม API ที่ Warm จะเรียกเป็นส่วนหนึ่งของ nl::Warm::Init actions
RequestInvokeActions(void)
void
API ของแพลตฟอร์มที่ Warm จะเรียกใช้เพื่อประกาศว่าแพลตฟอร์มควรเรียกใช้ InvokeActions
SetThreadRoutePriority(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority)
API ของแพลตฟอร์มที่ Warm จะเรียกใช้เพื่อเปลี่ยนลำดับความสำคัญของเส้นทาง IP ที่มีอยู่สำหรับอินเทอร์เฟซที่ระบุในสแต็ก TCP/IP เทรด
StartStopThreadAdvertisement(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, bool inStart)
API ของแพลตฟอร์มที่ Warm จะเรียกเพื่อเริ่ม / หยุดโฆษณาของคำนำหน้า IP ในอินเทอร์เฟซเทรด

ฟังก์ชัน

AddRemoveHostAddress

PlatformResult AddRemoveHostAddress(
  InterfaceType inInterfaceType,
  const Inet::IPAddress & inAddress,
  uint8_t inPrefixLength,
  bool inAdd
)

API ของแพลตฟอร์มที่ Warm จะเรียกให้เพิ่ม / นำที่อยู่ IP ของโฮสต์ออกจากอินเทอร์เฟซที่ระบุในสแต็ก TCP/IP ของโฮสต์

หลังจากดำเนินการเสร็จสิ้น แพลตฟอร์มต้องเรียกใช้ ReportActionComplete ด้วยผลลัพธ์สุดท้าย

รายละเอียด
พารามิเตอร์
[in] inInterfaceType
อินเทอร์เฟซที่จะแก้ไข
[in] inAddress
ที่อยู่ IP ที่จะเพิ่ม/นำออก
[in] inPrefixLength
ความยาวของคำนำหน้าของ inAddress
[in] inAdd
"true" เพื่อเพิ่มที่อยู่ "false" เพื่อนำที่อยู่ออก
แสดงผลค่า
kPlatformResultSuccess
การดำเนินการเสร็จเรียบร้อยแล้ว
kPlatformResultFailure
ดำเนินการไม่สำเร็จ
kPlatformResultInProgress
การดำเนินการนี้จะเสร็จสมบูรณ์แบบไม่พร้อมกัน

AddRemoveHostRoute

PlatformResult AddRemoveHostRoute(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  RoutePriority inPriority,
  bool inAdd
)

API ของแพลตฟอร์มที่ Warm จะเรียกให้เพิ่ม / นำเส้นทาง IP ออกสำหรับอินเทอร์เฟซที่ระบุในสแต็ก TCP/IP ของโฮสต์

หลังจากดำเนินการเสร็จสิ้น แพลตฟอร์มต้องเรียกใช้ ReportActionComplete ด้วยผลลัพธ์สุดท้าย

รายละเอียด
พารามิเตอร์
[in] inInterfaceType
อินเทอร์เฟซที่จะแก้ไข
[in] inPrefix
คำนำหน้า IP ที่จะเพิ่ม / นำออก
[in] inPriority
ลำดับความสำคัญที่จะใช้เมื่อกำหนดเส้นทาง
[in] inAdd
true เพื่อเพิ่มคำนำหน้าเป็นเส้นทาง false เพื่อนำคำนำหน้าที่เป็นเส้นทางออก
แสดงผลค่า
kPlatformResultSuccess
การดำเนินการเสร็จเรียบร้อยแล้ว
kPlatformResultFailure
ดำเนินการไม่สำเร็จ
kPlatformResultInProgress
การดำเนินการนี้จะเสร็จสมบูรณ์แบบไม่พร้อมกัน

AddRemoveThreadAddress

PlatformResult AddRemoveThreadAddress(
  InterfaceType inInterfaceType,
  const Inet::IPAddress & inAddress,
  bool inAdd
)

API ของแพลตฟอร์มที่ Warm จะเรียกให้เพิ่ม / นำที่อยู่ IP ออกจากอินเทอร์เฟซที่ระบุในสแต็ก TCP/IP ของเทรด

หลังจากดำเนินการเสร็จสิ้น แพลตฟอร์มต้องเรียกใช้ ReportActionComplete ด้วยผลลัพธ์สุดท้าย

รายละเอียด
พารามิเตอร์
[in] inInterfaceType
อินเทอร์เฟซที่จะแก้ไข
[in] inAddress
ที่อยู่ IP ที่จะเพิ่ม/นำออก
[in] inAdd
"true" เพื่อเพิ่มที่อยู่ "false" เพื่อนำที่อยู่ออก
แสดงผลค่า
kPlatformResultSuccess
การดำเนินการเสร็จเรียบร้อยแล้ว
kPlatformResultFailure
ดำเนินการไม่สำเร็จ
kPlatformResultInProgress
การดำเนินการนี้จะเสร็จสมบูรณ์แบบไม่พร้อมกัน

AddRemoveThreadRoute

PlatformResult AddRemoveThreadRoute(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  RoutePriority inPriority,
  bool inAdd
)

API ของแพลตฟอร์มที่ Warm จะเรียกให้เพิ่ม / นำเส้นทาง IP ออกสำหรับอินเทอร์เฟซที่ระบุในสแต็ก TCP/IP ของเทรด

หลังจากดำเนินการเสร็จสิ้น แพลตฟอร์มต้องเรียกใช้ ReportActionComplete ด้วยผลลัพธ์สุดท้าย

รายละเอียด
พารามิเตอร์
[in] inInterfaceType
อินเทอร์เฟซที่จะแก้ไข
[in] inPrefix
คำนำหน้า IP ที่จะกำหนด / นำออก
[in] inPriority
ลำดับความสำคัญที่จะใช้เมื่อกำหนดเส้นทาง
[in] inAdd
true เพื่อเพิ่มคำนำหน้าเป็นเส้นทาง false เพื่อนำคำนำหน้าที่เป็นเส้นทางออก
แสดงผลค่า
kPlatformResultSuccess
การดำเนินการเสร็จเรียบร้อยแล้ว
kPlatformResultFailure
ดำเนินการไม่สำเร็จ
kPlatformResultInProgress
การดำเนินการนี้จะเสร็จสมบูรณ์แบบไม่พร้อมกัน

CriticalSectionEnter

void CriticalSectionEnter(
  void
)

API ของแพลตฟอร์มที่ Warm จะเรียกใช้เพื่อป้องกันการเข้าถึงสถานะภายใน

CriticalSectionExit

void CriticalSectionExit(
  void
)

API ของแพลตฟอร์มที่ Warm จะเรียกใช้เพื่อปล่อยสิทธิ์เข้าถึงที่มีการป้องกันไปยังสถานะภายใน

เริ่มต้น

WEAVE_ERROR Init(
  WarmFabricStateDelegate *inFabricStateDelegate
)

แพลตฟอร์ม API ที่ Warm จะเรียกเป็นส่วนหนึ่งของ nl::Warm::Init actions

รายละเอียด
พารามิเตอร์
[in] inFabricStateDelegate
ตัวชี้ไปยังออบเจ็กต์ FabricStateDelegate ที่ใช้โดย Warm ไปใช้เพื่อรับการอัปเดตสถานะของ Fabric
การส่งคืน
WEAVE_NO_ERROR สำเร็จแล้ว หรืออาจเป็นรหัสข้อผิดพลาด

RequestInvokeActions

void RequestInvokeActions(
  void
)

API ของแพลตฟอร์มที่ Warm จะเรียกใช้เพื่อประกาศว่าแพลตฟอร์มควรเรียกใช้ InvokeActions

SetThreadRoutePriority

PlatformResult SetThreadRoutePriority(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  RoutePriority inPriority
)

API ของแพลตฟอร์มที่ Warm จะเรียกใช้เพื่อเปลี่ยนลำดับความสำคัญของเส้นทาง IP ที่มีอยู่สำหรับอินเทอร์เฟซที่ระบุในสแต็ก TCP/IP เทรด

หลังจากดำเนินการเสร็จสิ้น แพลตฟอร์มต้องเรียกใช้ ReportActionComplete ด้วยผลลัพธ์สุดท้าย

รายละเอียด
พารามิเตอร์
[in] inInterfaceType
อินเทอร์เฟซที่จะแก้ไข
[in] inPrefix
คำนำหน้า IP ที่จะแก้ไข
[in] inPriority
ลำดับความสำคัญใหม่ที่จะใช้กับเส้นทาง
แสดงผลค่า
kPlatformResultSuccess
การดำเนินการเสร็จเรียบร้อยแล้ว
kPlatformResultFailure
ดำเนินการไม่สำเร็จ
kPlatformResultInProgress
การดำเนินการนี้จะเสร็จสมบูรณ์แบบไม่พร้อมกัน

StartStopThreadAdvertisement

PlatformResult StartStopThreadAdvertisement(
  InterfaceType inInterfaceType,
  const Inet::IPPrefix & inPrefix,
  bool inStart
)

API ของแพลตฟอร์มที่ Warm จะเรียกเพื่อเริ่ม / หยุดโฆษณาของคำนำหน้า IP ในอินเทอร์เฟซเทรด

หลังจากดำเนินการเสร็จสิ้น แพลตฟอร์มต้องเรียกใช้ ReportActionComplete ด้วยผลลัพธ์สุดท้าย

รายละเอียด
พารามิเตอร์
[in] inInterfaceType
อินเทอร์เฟซที่จะแก้ไข
[in] inPrefix
คำนำหน้า IP ที่ควรเริ่มต้น / หยุดโฆษณา
[in] inStart
"true" เพื่อเริ่มโฆษณา, "false" เพื่อหยุดการโฆษณา
แสดงผลค่า
kPlatformResultSuccess
การดำเนินการเสร็จเรียบร้อยแล้ว
kPlatformResultFailure
ดำเนินการไม่สำเร็จ
kPlatformResultInProgress
การดำเนินการนี้จะเสร็จสมบูรณ์แบบไม่พร้อมกัน