nl::Weave::Warm

Không gian tên này bao gồm các giao diện dành cho Mô-đun định tuyến và địa chỉ Weave, một Mô-đun di động để định cấu hình địa chỉ IP và tuyến đường của Weave.

Tóm tắt

Liệt kê

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
Một enum các giá trị Trạng thái giao diện có thể có.
InterfaceType{
  kInterfaceTypeLegacy6LoWPAN = 0,
  kInterfaceTypeThread,
  kInterfaceTypeWiFi,
  kInterfaceTypeTunnel,
  kInterfaceTypeCellular
}
enum
Một Enum các loại giao diện có thể có.
PlatformActionExecution{
  kPlatformActionExecutionContinue = false,
  kPlatformActionExecutionSuspendForAsynchOpCompletion = true
}
enum
PlatformResult{
  kPlatformResultSuccess = 0,
  kPlatformResultFailure,
  kPlatformResultInProgress
}
enum
Một Enum các giá trị trả về của API nền tảng có thể có.
RoutePriority enum
Một bảng liệt kê các mức độ ưu tiên tuyến đường có thể có để một tuyến có thể được ưu tiên hơn các tuyến khác.
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

Typedef

ActionFunction)(ActionType inAction, bool inActivate, const uint64_t &inGlobalId, const uint64_t &inInterfaceId) typedef
FlagsType typedef
uint16_t

Biến

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

Hàm

BorderRouterStateChange(InterfaceState inState)
void
API WARM được gọi để thông báo về việc thay đổi trạng thái cho tính năng bộ định tuyến Border.
CellularInterfaceStateChange(InterfaceState inState)
void
API WARM được gọi để thông báo về thay đổi Trạng thái của giao diện Di động.
FabricStateChange(InterfaceState inState)
void
Một hàm được gọi để thông báo về sự thay đổi Trạng thái cho tính năng Vải dệt.
GetCurrentActionState(ActionType inAction)
bool
Một hàm tĩnh trả về Trạng thái hiện tại của một hành động đã chỉ định.
GetFabricState(const WeaveFabricState *& outFabricState)
WARM API để thu thập đối tượng FabricState đã được cung cấp cho Warm trong quá trình Init.
GetSystemFeatureState(SystemFeatureType inSystemFeature)
bool
Một hàm tĩnh nhận trạng thái hiện tại của một tính năng Hệ thống.
GetULA(InterfaceType inInterfaceType, Inet::IPAddress & outAddress)
WARM API để thu thập ULA cho một loại giao diện đã chỉ định.
Init(WeaveFabricState & inFabricState)
API WARM để khởi chạy mô-đun một lần.
InvokeActions(void)
void
WARM API được gọi qua một nhiệm vụ chuyên biệt để thực hiện nhiều thao tác trên API của nền tảng.
LegacyHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
Một trong các phương thức Hành động.
LegacyThreadAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
Một trong các phương thức Hành động.
MakePrefix(const uint64_t & inGlobalID, const uint16_t subnetId, const uint8_t inPrefixLen, Inet::IPPrefix & outPrefix)
void
Một tiện ích để tạo tiền tố 48 bit từ globalID.
MapAvailabilityToPriority(Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability)
Một hàm tĩnh trả về tệp ánh xạ từ TunnelAvailability đến RoutePriority.
RecordPlatformResult(PlatformResult inResult, ActionType inAction, bool inActionState)
Một hàm tĩnh ghi lại kết quả của một lệnh gọi Hành động API trên nền tảng.
ReportActionComplete(PlatformResult inResult)
void
API WARM được gọi để thông báo về việc hoàn tất lệnh gọi API nền tảng không đồng bộ trước đó.
SetCurrentActionState(ActionType inAction, bool inValue)
void
Một hàm tĩnh đặt Trạng thái hiện tại của một hành động được chỉ định.
SetSystemFeatureState(SystemFeatureType inSystemFeature, bool inValue)
bool
Một hàm tĩnh đặt trạng thái hiện tại của Tính năng hệ thống.
ShouldPerformAction(ActionType inAction, FlagsType inNecessarySystemFeatureState, bool & outActivate)
bool
Một hàm tĩnh xác định liệu có nên thực hiện hành động đã chỉ định hay không.
SystemFeatureStateChangeHandler(SystemFeatureType inSystemFeatureType, bool inState)
void
Một hàm tĩnh Thiết lập trạng thái của Tính năng hệ thống và thông báo cho nền tảng rằng trạng thái sự kiện đã thay đổi.
TakeActions(void)
void
Một hàm tĩnh kiểm thử Trạng thái của từng thao tác và thực hiện lệnh gọi API của nền tảng để thay đổi Trạng thái của thao tác nếu cần.
ThreadAdvertisementAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
Một trong các phương thức Hành động.
ThreadHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
Một trong các phương thức Hành động.
ThreadHostRouteAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
Một trong các phương thức Hành động.
ThreadInterfaceStateChange(InterfaceState inState)
void
API WARM được gọi để thông báo về thay đổi Trạng thái cho giao diện Thread.
ThreadRoutePriorityAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
Một trong các phương thức Hành động.
ThreadRoutingStateChange(InterfaceState inState)
void
API WARM được gọi để thông báo về việc thay đổi Trạng thái cho tính năng Định tuyến luồng.
ThreadThreadAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
Một trong các phương thức Hành động.
ThreadThreadRouteAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
Một trong các phương thức Hành động.
TunnelHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
Một trong các phương thức Hành động.
TunnelHostRouteAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
Một trong các phương thức Hành động.
TunnelInterfaceStateChange(InterfaceState inState)
void
API WARM được gọi để thông báo về thay đổi Trạng thái cho giao diện Weave Tunnel.
TunnelPriorityStateChange(nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability)
void
API WARM được gọi để cập nhật mức độ ưu tiên của Dịch vụ đường hầm.
TunnelServiceStateChange(InterfaceState inState, nl::Weave::Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability)
void
API WARM được gọi để thông báo về thay đổi Trạng thái cho giao diện Weave Tunnel.
WiFiHostAddressAction(ActionType inAction, bool inActivate, const uint64_t & inGlobalId, const uint64_t & inInterfaceId)
Một trong các phương thức Hành động.
WiFiInterfaceStateChange(InterfaceState inState)
void
API WARM được gọi để thông báo về sự thay đổi Trạng thái của giao diện Wi-Fi.

Lớp

nl::Weave::Warm::WarmFabricStateDelegate

Đây là một lớp nội bộ cho WarmCore.

Cấu trúc

nl::Weave::Warm::ActionEntry
nl::Weave::Warm::ModuleState

Không gian tên

nl::Weave::Warm::Platform

Liệt kê

ActionType

 ActionType
Thuộc tính
kActionTypeHostRouteThread

Thêm | Xoá tuyến IP cho Giao diện Thread trên ngăn xếp IP của máy chủ.

kActionTypeLegacy6LoWPANHostAddress

Thêm | Xoá địa chỉ IP của Giao diện 6LowPAN cũ trên ngăn xếp IP của máy chủ lưu trữ.

kActionTypeLegacy6LoWPANThreadAddress

Thêm | Xoá địa chỉ IP của Giao diện 6LowPAN cũ trên ngăn xếp IP của Mô-đun luồng.

kActionTypeMax

KHÔNG VƯỢT QUÁ; dành riêng để đánh dấu số bit tối đa hiện có.

kActionTypeThreadAdvertisement

Bắt đầu | Dừng quảng cáo định tuyến bằng Mô-đun luồng.

kActionTypeThreadHostAddress

Thêm | Xoá địa chỉ IP cho Giao diện Thread trên ngăn xếp IP của máy chủ lưu trữ.

kActionTypeThreadRoute

Thêm | Xoá tuyến IP trên Mô-đun Thread để hỗ trợ Tuyến đường biên.

kActionTypeThreadRoutePriority

Thay đổi mức độ ưu tiên định tuyến của tuyến đường Thread trên mô-đun Thread.

kActionTypeThreadThreadAddress

Thêm | Xoá địa chỉ IP của Giao diện Thread trên ngăn xếp IP của Mô-đun Thread.

kActionTypeTunnelHostAddress

Thêm | Xoá địa chỉ IP cho Giao diện đường hầm trên ngăn xếp IP của máy chủ lưu trữ.

kActionTypeTunnelHostRoute

Thêm | Xoá tuyến IP cho Giao diện đường hầm trên ngăn xếp IP của máy chủ.

kActionTypeTunnelServiceRoute

Thêm | Xoá tuyến IP 64 bit cho mạng con Dịch vụ trên ngăn xếp IP của máy chủ.

kActionTypeWiFiHostAddress

Thêm | Xoá địa chỉ IP cho Giao diện Wi-Fi trên ngăn xếp IP của máy chủ lưu trữ.

InitState

 InitState
Thuộc tính
kInitStateNotInitialized

Giá trị này phải là 0 để giá trị ban đầu của mInitState là kInitStateNotInitialized.

InterfaceState

 InterfaceState

Một enum các giá trị Trạng thái giao diện có thể có.

InterfaceType

 InterfaceType

Một Enum các loại giao diện có thể có.

Thuộc tính
kInterfaceTypeCellular

Giao diện Mạng di động.

kInterfaceTypeLegacy6LoWPAN

Giao diện báo thức luồng.

kInterfaceTypeThread

Giao diện luồng.

kInterfaceTypeTunnel

Giao diện Tunnel.

kInterfaceTypeWiFi

Giao diện Wi-Fi.

PlatformActionExecution

 PlatformActionExecution
Thuộc tính
kPlatformActionExecutionContinue

tiếp tục thực thi hành động.

kPlatformActionExecutionSuspendForAsynchOpCompletion

tạm ngưng thực thi hành động để hoàn tất hoạt động không đồng bộ.

PlatformResult

 PlatformResult

Một Enum các giá trị trả về của API nền tảng có thể có.

Thuộc tính
kPlatformResultFailure

Không thực thi được API.

kPlatformResultInProgress

Thao tác này đang được thực hiện và sẽ hoàn tất không đồng bộ.

kPlatformResultSuccess

Đã hoàn tất thành công API.

RoutePriority

 RoutePriority

Một bảng liệt kê các mức độ ưu tiên tuyến đường có thể có để một tuyến có thể được ưu tiên hơn các tuyến khác.

SystemFeatureType

 SystemFeatureType
Thuộc tính
kSystemFeatureTypeBorderRoutingEnabled

Tính năng định tuyến biên giới của hệ thống IS | CHƯA ĐƯỢC bật.

kSystemFeatureTypeCellularConnected

Giao diện di động của hệ thống IS | CHƯA ĐƯỢC kết nối.

kSystemFeatureTypeIsFabricMember

Mô-đun Weave của hệ thống IS | KHÔNG PHẢI là một thành phần của vải.

kSystemFeatureTypeMax

KHÔNG VƯỢT QUÁ; dành riêng để đánh dấu số bit tối đa hiện có.

kSystemFeatureTypeThreadConnected

Giao diện luồng của hệ thống IS | CHƯA ĐƯỢC kết nối.

kSystemFeatureTypeThreadRoutingEnabled

Tính năng định tuyến luồng của hệ thống IS | CHƯA ĐƯỢC bật.

kSystemFeatureTypeTunnelInterfaceEnabled

Giao diện đường hầm của hệ thống IS | CHƯA ĐƯỢC bật.

kSystemFeatureTypeTunnelState

Dịch vụ đường hầm của hệ thống IS | CHƯA được thiết lập.

kSystemFeatureTypeWiFiConnected

Giao diện Wi-Fi của Hệ thống IS | CHƯA ĐƯỢC kết nối.

Typedef

ActionFunction

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

FlagsType

uint16_t FlagsType

Biến

kGlobalULAPrefixLength

const uint8_t kGlobalULAPrefixLength = 48

kCũ6LoWPANULAAddressPrefixLength

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

Hàm

BorderRouterStateChange

void BorderRouterStateChange(
  InterfaceState inState
)

API WARM được gọi để thông báo về việc thay đổi trạng thái cho tính năng bộ định tuyến Border.

Chi tiết
Tham số
[in] inState
kInterfaceStateUp nếu tính năng bộ định tuyến Biên giới đang hoạt động, nếu không thì kInterfaceStateDown.

CellularInterfaceStateChange

void CellularInterfaceStateChange(
  InterfaceState inState
)

API WARM được gọi để thông báo về thay đổi Trạng thái của giao diện Di động.

Chi tiết
Tham số
[in] inState
kInterfaceStateUp nếu giao diện Di động ở trên, nếu không thì kInterfaceStateDown.

FabricStateChange

void FabricStateChange(
  InterfaceState inState
)

Một hàm được gọi để thông báo về sự thay đổi Trạng thái cho tính năng Vải dệt.

Chi tiết
Tham số
[in] inState
kInterfaceStateUp nếu hệ thống là thành phần của một lớp Weave, nếu không thì là kInterfaceStateDown.

GetCurrentActionState

bool GetCurrentActionState(
  ActionType inAction
)

Một hàm tĩnh trả về Trạng thái hiện tại của một hành động đã chỉ định.

Chi tiết
Tham số
[in] inAction
Loại hành động cần truy vấn.
Trả về
true nếu hành động là Set, nếu không thì false.

GetFabricState

WEAVE_ERROR GetFabricState(
  const WeaveFabricState *& outFabricState
)

WARM API để thu thập đối tượng FabricState đã được cung cấp cho Warm trong quá trình Init.

Chi tiết
Tham số
[out] outFabricState
Tham chiếu con trỏ đến đối tượng FabricState.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
WEAVE_ERROR_INCORRECT_STATE
Nếu API này được gọi trước khi khởi động WARM.

GetSystemFeatureState

bool GetSystemFeatureState(
  SystemFeatureType inSystemFeature
)

Một hàm tĩnh nhận trạng thái hiện tại của một tính năng Hệ thống.

Chi tiết
Tham số
[in] inSystemFeature
Tính năng hệ thống để truy vấn.
Trả về
true nếu Tính năng hệ thống được bật, nếu không thì false.

GetULA

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

WARM API để thu thập ULA cho một loại giao diện đã chỉ định.

Chi tiết
Tham số
[in] inInterfaceType
Loại giao diện cần có ULA.
[out] outAddress
Một đối tượng địa chỉ dùng để lưu giữ ULA kết quả.
Giá trị trả về
WEAVE_NO_ERROR
Khi thành công.
WEAVE_ERROR_INCORRECT_STATE
Nếu API này được gọi khi WARM không phải là thành phần của Vải.
WEAVE_ERROR_INVALID_ARGUMENT
Nếu API này được gọi bằng Loại giao diện không hợp lệ.

Init

WEAVE_ERROR Init(
  WeaveFabricState & inFabricState
)

API WARM để khởi chạy mô-đun một lần.

Chi tiết
Tham số
[in] inFabricState
Tham chiếu đến WeaveFabricState hợp lệ.
Giá trị trả về
WEAVE_NO_ERROR
Khi khởi chạy thành công.
WEAVE_ERROR_INCORRECT_STATE
Khi Init được gọi nhiều lần.
other
Nếu không có mã lỗi.
Trả về
WEAVE_NO_ERROR khi thành công, nếu không thì sẽ xảy ra mã lỗi.

InvokeActions

void InvokeActions(
  void
)

WARM API được gọi theo một nhiệm vụ chuyên biệt để thực hiện nhiều thao tác trên API của nền tảng.

Đây là điểm truy cập để thực hiện những thao tác cần thiết nhằm đáp ứng Trạng thái hệ thống hiện tại. Ví dụ: nếu ngăn xếp Thread chuyển từ trạng thái tắt sang bật, thì hàm này sẽ thực hiện các lệnh gọi cần thiết trên nền tảng để chỉ định địa chỉ máy chủ lưu trữ luồng, v.v. Hàm này chỉ nên được gọi bằng mã nền tảng để phản hồi lệnh gọi Warm đến RequestInvokeActions. Việc gọi InvokeAction sẽ dẫn đến một hoặc nhiều lệnh gọi đến API nl::Warm::Platform. Do đó, nhà phát triển nên triển khai RequestInvokeActions và phương thức gọi của InvokeActions() một cách phù hợp. Có thể thích hợp để RequestInvokeActions đăng một sự kiện lên tác vụ mà sẽ gọi InvokeActions() chẳng hạn. Ngược lại, nếu hệ thống có một luồng đơn, thì bạn có thể triển khai RequestInvokeActions để gọi trực tiếp InvokeActions().

LegacyHostAddressAction

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

Một trong các phương thức Hành động.

Đặt địa chỉ máy chủ lưu trữ cho giao diện cũ.

Chi tiết
Tham số
[in] inAction
Loại hành động.
[in] inActivate
Trạng thái mong muốn == kích hoạt, false == huỷ kích hoạt.
[in] inGlobalId
Tham chiếu đến mã nhận dạng chung của Weave nếu cần phải tính toán một địa chỉ.
[in] inInterfaceId
Mã tham chiếu đến mã giao diện của thiết bị nếu cần phải tính toán địa chỉ.
Trả về
Chuyển tiếp kết quả từ Platform::HostAddress().

LegacyThreadAddressAction

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

Một trong các phương thức Hành động.

Đặt địa chỉ luồng cho giao diện 6LoWPAN cũ.

Chi tiết
Tham số
[in] inAction
Loại hành động.
[in] inActivate
Trạng thái mong muốn == kích hoạt, false == huỷ kích hoạt.
[in] inGlobalId
Tham chiếu đến mã nhận dạng chung của Weave nếu cần phải tính toán một địa chỉ.
[in] inInterfaceId
Mã tham chiếu đến mã giao diện của thiết bị nếu cần phải tính toán địa chỉ.
Trả về
Chuyển tiếp kết quả từ Platform::ThreadAddress().

MakePrefix

void MakePrefix(
  const uint64_t & inGlobalID,
  const uint16_t subnetId,
  const uint8_t inPrefixLen,
  Inet::IPPrefix & outPrefix
)

Một tiện ích để tạo tiền tố 48 bit từ globalID.

Chi tiết
Tham số
[in] inGlobalID
Tham chiếu đến mã nhận dạng chung của Weave.
[out] outPrefix
Tiền tố để khởi tạo.

MapAvailabilityToPriority

RoutePriority MapAvailabilityToPriority(
  Profiles::WeaveTunnel::Platform::TunnelAvailabilityMode inAvailability
)

Một hàm tĩnh trả về tệp ánh xạ từ TunnelAvailability đến RoutePriority.

Chi tiết
Tham số
[in] inAvailability
Chế độ khả dụng của đường hầm Weave.
Trả về
Giá trị được liên kết theo mức độ ưu tiên.

RecordPlatformResult

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

Một hàm tĩnh ghi lại kết quả của một lệnh gọi Hành động API trên nền tảng.

Mô-đun này đưa ra các yêu cầu thực hiện thao tác qua API dành riêng cho nền tảng. API phải báo cáo kết quả kPlatformResultSuccess|kPlatformResultFailure|kPlatformResultInProgress của yêu cầu hành động đó. Hàm này ghi lại kết quả đó và trả về giá trị true nếu kết quả đó đang diễn ra và các thao tác khác bị trì hoãn.

Chi tiết
Tham số
[in] inResult
Kết quả API nền tảng.
[in] inAction
Hành động mà API nền tảng đã thực hiện.
[in] inActionState
Trạng thái mới của thao tác nếu kết quả là thành công.
Trả về
true (đúng) thì API nền tảng xử lý không đồng bộ yêu cầu, nếu không thì "false" (sai).

ReportActionComplete

void ReportActionComplete(
  PlatformResult inResult
)

API WARM được gọi để thông báo về việc hoàn tất lệnh gọi API nền tảng không đồng bộ trước đó.

Giả định rằng API thao tác trên nền tảng có thể cần thực hiện các hoạt động không đồng bộ. Nếu điều này đúng thì API nền tảng sẽ trả về kPlatformResultInProgress. Khi điều này xảy ra, các Hành động định tuyến và Địa chỉ mới sẽ bị tạm ngưng cho đến khi hệ thống gọi ReportActionComplete để thông báo hoàn tất thao tác.

Chi tiết
Tham số
[in] inResult
Kết quả của hành động đang chờ xử lý. phải là một trong các lựa chọn sau: {kPlatformResultSuccess | kPlatformResultFailure}

SetCurrentActionState

void SetCurrentActionState(
  ActionType inAction,
  bool inValue
)

Một hàm tĩnh đặt Trạng thái hiện tại của một hành động được chỉ định.

Chi tiết
Tham số
[in] inAction
Loại hành động cần thay đổi.
[in] inValue
Giá trị Trạng thái mới cần áp dụng.

SetSystemFeatureState

bool SetSystemFeatureState(
  SystemFeatureType inSystemFeature,
  bool inValue
)

Một hàm tĩnh đặt trạng thái hiện tại của Tính năng hệ thống.

Chi tiết
Tham số
[in] inSystemFeature
SystemFeature cần đặt.
[in] inValue
Giá trị Trạng thái mới cần áp dụng.
Trả về
true nếu Tính năng hệ thống đã được thay đổi, nếu không thì false.

ShouldPerformAction

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

Một hàm tĩnh xác định liệu có nên thực hiện hành động đã chỉ định hay không.

Hàm này kiểm tra điều kiện của cờ Trạng thái tính năng hệ thống và xác định xem nên bật hay tắt hành động được chỉ định. Sau đó, hàm này sẽ kiểm tra trạng thái hiện tại của hành động và nếu hành động không được đặt thành giá trị theo yêu cầu của Trạng thái tính năng hệ thống thì hàm sẽ trả về true cùng với trạng thái hành động mong muốn trong outKích hoạt

Chi tiết
Tham số
[in] inAction
Hành động cần truy vấn.
[in] inNecessarySystemFeatureState
Cờ Trạng thái cần thiết để thao tác hoạt động.
[out] outActivate
Trạng thái mong muốn của hành động.
Trả về
true nếu hành động hiện không ở trạng thái mong muốn, nếu không trạng thái sẽ là false.

SystemFeatureStateChangeHandler

void SystemFeatureStateChangeHandler(
  SystemFeatureType inSystemFeatureType,
  bool inState
)

Một hàm tĩnh Thiết lập trạng thái của Tính năng hệ thống và thông báo cho nền tảng rằng trạng thái sự kiện đã thay đổi.

Được các API EventStateChange gọi để thực hiện các thao tác phản ứng cần thiết.

Chi tiết
Tham số
[in] inSystemFeatureType
Trạng thái thay đổi tương ứng với API được gọi.
[in] inState
Giá trị mới cho trạng thái.

TakeActions

void TakeActions(
  void
)

Một hàm tĩnh kiểm thử Trạng thái của từng thao tác và thực hiện lệnh gọi API của nền tảng để thay đổi Trạng thái của thao tác nếu cần.

Hàm này sử dụng shouldPerformAction() để xác định xem có cần thay đổi/thực hiện một trạng thái hành động hay không. Nếu IfPerformAction() trả về true, hàm sẽ gọi API hành động thích hợp để thực hiện hành động nhằm đặt hành động đó vào Trạng thái mong muốn. Kết quả của lệnh gọi API hành động được chuyển vào RecordPlatformResult() và nếu hàm đó trả về giá trị true, thì việc thực thi hàm này sẽ bị chấm dứt.

ThreadAdvertisementAction

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

Một trong các phương thức Hành động.

Đặt trạng thái quảng cáo luồng

Chi tiết
Tham số
[in] inAction
Loại hành động.
[in] inActivate
Trạng thái mong muốn == kích hoạt, false == huỷ kích hoạt.
[in] inGlobalId
Tham chiếu đến mã nhận dạng chung của Weave nếu cần phải tính toán một địa chỉ.
[in] inInterfaceId
Mã tham chiếu đến mã giao diện của thiết bị nếu cần phải tính toán địa chỉ.
Trả về
Chuyển tiếp kết quả từ Platform::ThreadQuảng cáo().

ThreadHostAddressAction

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

Một trong các phương thức Hành động.

Đặt Địa chỉ máy chủ lưu trữ cho giao diện Thread.

Chi tiết
Tham số
[in] inAction
Loại hành động.
[in] inActivate
Trạng thái mong muốn == kích hoạt, false == huỷ kích hoạt.
[in] inGlobalId
Tham chiếu đến mã nhận dạng chung của Weave nếu cần phải tính toán một địa chỉ.
[in] inInterfaceId
Mã tham chiếu đến mã giao diện của thiết bị nếu cần phải tính toán địa chỉ.
Trả về
Chuyển tiếp kết quả từ Platform::HostAddress().

ThreadHostRouteAction

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

Một trong các phương thức Hành động.

Thiết lập Tuyến máy chủ lưu trữ cho giao diện Thread.

Chi tiết
Tham số
[in] inAction
Loại hành động.
[in] inActivate
Trạng thái mong muốn == kích hoạt, false == huỷ kích hoạt.
[in] inGlobalId
Tham chiếu đến mã nhận dạng chung của Weave nếu cần phải tính toán một địa chỉ.
[in] inInterfaceId
Mã tham chiếu đến mã giao diện của thiết bị nếu cần phải tính toán địa chỉ.
Trả về
Chuyển tiếp kết quả từ Platform::HostRoute().

ThreadInterfaceStateChange

void ThreadInterfaceStateChange(
  InterfaceState inState
)

API WARM được gọi để thông báo về thay đổi Trạng thái cho giao diện Thread.

Chi tiết
Tham số
[in] inState
kInterfaceStateUp nếu giao diện Thread đang hoạt động, nếu không thì kInterfaceStateDown.

ThreadRoutePriorityAction

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

Một trong các phương thức Hành động.

Đặt mức độ ưu tiên của định tuyến luồng dựa trên khả năng hoạt động của đường hầm.

Chi tiết
Tham số
[in] inAction
Loại hành động.
[in] inActivate
Trạng thái mong muốn == kích hoạt, false == huỷ kích hoạt.
[in] inGlobalId
Tham chiếu đến mã nhận dạng chung của Weave nếu cần phải tính toán một địa chỉ.
[in] inInterfaceId
Mã tham chiếu đến mã giao diện của thiết bị nếu cần phải tính toán địa chỉ.
Trả về
Chuyển tiếp kết quả từ Platform::ThreadRoutePriority().

ThreadRoutingStateChange

void ThreadRoutingStateChange(
  InterfaceState inState
)

API WARM được gọi để thông báo về việc thay đổi Trạng thái cho tính năng Định tuyến luồng.

Chi tiết
Tham số
[in] inState
kInterfaceStateUp nếu tính năng Định tuyến luồng hoạt động, nếu không thì kInterfaceStateDown.

ThreadThreadAddressAction

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

Một trong các phương thức Hành động.

Thiết lập Địa chỉ Thread cho Giao diện Thread.

Chi tiết
Tham số
[in] inAction
Loại hành động.
[in] inActivate
Trạng thái mong muốn == kích hoạt, false == huỷ kích hoạt.
[in] inGlobalId
Tham chiếu đến mã nhận dạng chung của Weave nếu cần phải tính toán một địa chỉ.
[in] inInterfaceId
Mã tham chiếu đến mã giao diện của thiết bị nếu cần phải tính toán địa chỉ.
Trả về
Chuyển tiếp kết quả từ Platform::ThreadAddress().

ThreadThreadRouteAction

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

Một trong các phương thức Hành động.

Thiết lập tuyến đường Thread cho Ngăn xếp Thread.

Chi tiết
Tham số
[in] inAction
Loại hành động.
[in] inActivate
Trạng thái mong muốn == kích hoạt, false == huỷ kích hoạt.
[in] inGlobalId
Tham chiếu đến mã nhận dạng chung của Weave nếu cần phải tính toán một địa chỉ.
[in] inInterfaceId
Mã tham chiếu đến mã giao diện của thiết bị nếu cần phải tính toán địa chỉ.
Trả về
Chuyển tiếp kết quả từ Platform::ThreadRoute().

TunnelHostAddressAction

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

Một trong các phương thức Hành động.

Đặt HostAddress cho Giao diện đường hầm.

Chi tiết
Tham số
[in] inAction
Loại hành động.
[in] inActivate
Trạng thái mong muốn == kích hoạt, false == huỷ kích hoạt.
[in] inGlobalId
Tham chiếu đến mã nhận dạng chung của Weave nếu cần phải tính toán một địa chỉ.
[in] inInterfaceId
Mã tham chiếu đến mã giao diện của thiết bị nếu cần phải tính toán địa chỉ.
Trả về
Chuyển tiếp kết quả từ Platform::HostAddress().

TunnelHostRouteAction

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

Một trong các phương thức Hành động.

Đặt HostRoute cho giao diện Tunnel.

Chi tiết
Tham số
[in] inAction
Loại hành động.
[in] inActivate
Trạng thái mong muốn == kích hoạt, false == huỷ kích hoạt.
[in] inGlobalId
Tham chiếu đến mã nhận dạng chung của Weave nếu cần phải tính toán một địa chỉ.
[in] inInterfaceId
Mã tham chiếu đến mã giao diện của thiết bị nếu cần phải tính toán địa chỉ.
Trả về
Chuyển tiếp kết quả từ Platform::HostRoute().

TunnelInterfaceStateChange

void TunnelInterfaceStateChange(
  InterfaceState inState
)

API WARM được gọi để thông báo về thay đổi Trạng thái cho giao diện Weave Tunnel.

Chi tiết
Tham số
[in] inState
kInterfaceStateUp nếu giao diện Weave Tunnel đang hoạt động, nếu không thì kInterfaceStateDown.

TunnelPriorityStateChange

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

API WARM được gọi để cập nhật mức độ ưu tiên của Dịch vụ đường hầm.

Chi tiết
Tham số
[in] inAvailability
Giá trị mới cho trạng thái hoạt động của đường hầm.

TunnelServiceStateChange

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

API WARM được gọi để thông báo về thay đổi Trạng thái cho giao diện Weave Tunnel.

Chi tiết
Tham số
[in] inState
kInterfaceStateUp nếu Dịch vụ đường hầm Weave được thiết lập, nếu không thì kInterfaceStateDown.
[in] inAvailability
Trạng thái sẵn có sẽ được dùng sau này khi định cấu hình đường hầm.

WiFiHostAddressAction

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

Một trong các phương thức Hành động.

Đặt địa chỉ máy chủ lưu trữ cho giao diện Wi-Fi.

Chi tiết
Tham số
[in] inAction
Loại hành động.
[in] inActivate
Trạng thái mong muốn == kích hoạt, false == huỷ kích hoạt.
[in] inGlobalId
Tham chiếu đến mã nhận dạng chung của Weave nếu cần phải tính toán một địa chỉ.
[in] inInterfaceId
Mã tham chiếu đến mã giao diện của thiết bị nếu cần phải tính toán địa chỉ.
Trả về
Chuyển tiếp kết quả từ Platform::HostAddress().

WiFiInterfaceStateChange

void WiFiInterfaceStateChange(
  InterfaceState inState
)

API WARM được gọi để thông báo về sự thay đổi Trạng thái của giao diện Wi-Fi.

Chi tiết
Tham số
[in] inState
kInterfaceStateUp nếu giao diện Wi-Fi hoạt động, nếu không thì kInterfaceStateDown.