nl::Weave::Warm::Platform

概要

関数
AddRemoveHostAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, uint8_t inPrefixLength, bool inAdd)
ホスト TCP/IP スタック上の指定されたインターフェースに対して、ホスト IP アドレスを追加または削除するために Warm が呼び出すプラットフォーム API。
AddRemoveHostRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
Warm が呼び出すプラットフォーム API。ホスト TCP / IP スタック上の指定インターフェースの IP ルートを追加/削除します。
AddRemoveThreadAddress(InterfaceType inInterfaceType, const Inet::IPAddress & inAddress, bool inAdd)
Thread TCP/IP スタックの指定されたインターフェースに対して IP アドレスを追加または削除するために Warm が呼び出すプラットフォーム API。
AddRemoveThreadRoute(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority, bool inAdd)
Thread TCP / IP スタック上の指定されたインターフェースの IP ルートを追加/削除するために Warm が呼び出すプラットフォーム API。
CriticalSectionEnter(void)
void
内部状態へのアクセスを保護するために Warm が呼び出すプラットフォーム API。
CriticalSectionExit(void)
void
Warm が内部状態に対する保護されたアクセスをリリースするために呼び出すプラットフォーム API。
Init(WarmFabricStateDelegate *inFabricStateDelegate)
Warm が nl::Warm::Init 実行の一環として呼び出すプラットフォーム API。
RequestInvokeActions(void)
void
プラットフォームが InvokeActions を呼び出す必要があることを通知するために Warm が呼び出すプラットフォーム API。
SetThreadRoutePriority(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, RoutePriority inPriority)
Thread TCP/IP スタック上の指定されたインターフェースの既存の IP ルートの優先度を変更するために Warm が呼び出すプラットフォーム API。
StartStopThreadAdvertisement(InterfaceType inInterfaceType, const Inet::IPPrefix & inPrefix, bool inStart)
Thread インターフェースで IP プレフィックスのアドバタイズを開始 / 停止するために Warm が呼び出すプラットフォーム API。

関数

AddRemoveHostAddress

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

ホスト TCP/IP スタック上の指定されたインターフェースに対して、ホスト IP アドレスを追加または削除するために Warm が呼び出すプラットフォーム API。

完了後、プラットフォームは最終結果で 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
)

Warm が呼び出すプラットフォーム API。ホスト TCP / IP スタック上の指定インターフェースの 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
)

Thread TCP/IP スタックの指定されたインターフェースに対して IP アドレスを追加または削除するために Warm が呼び出すプラットフォーム API。

完了後、プラットフォームは最終結果で 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
)

Thread TCP / IP スタック上の指定されたインターフェースの IP ルートを追加/削除するために Warm が呼び出すプラットフォーム API。

完了後、プラットフォームは最終結果で ReportActionComplete を呼び出す必要があります。

詳細
パラメータ
[in] inInterfaceType
変更するインターフェース。
[in] inPrefix
割り当てまたは削除する IP プレフィックス。
[in] inPriority
ルートの割り当て時に使用する優先度。
[in] inAdd
プレフィックスをルートとして追加する場合は true を、ルートとしてプレフィックスを削除する場合は false を指定します。
戻り値
kPlatformResultSuccess
オペレーションは正常に完了しました。
kPlatformResultFailure
操作に失敗しました。
kPlatformResultInProgress
オペレーションは非同期で完了します。

CriticalSectionEnter

void CriticalSectionEnter(
  void
)

内部状態へのアクセスを保護するために Warm が呼び出すプラットフォーム API。

CriticalSectionExit

void CriticalSectionExit(
  void
)

Warm が内部状態に対する保護されたアクセスをリリースするために呼び出すプラットフォーム API。

init

WEAVE_ERROR Init(
  WarmFabricStateDelegate *inFabricStateDelegate
)

Warm が nl::Warm::Init 実行の一環として呼び出すプラットフォーム API。

詳細
パラメータ
[in] inFabricStateDelegate
ファブリック状態の更新を受信するために Warm によって使用される fabricStateDelegate オブジェクトへのポインタ。
戻り値
成功した場合は WEAVE_NO_ERROR、それ以外の場合はエラーコード。

RequestInvokeActions

void RequestInvokeActions(
  void
)

プラットフォームが InvokeActions を呼び出す必要があることを通知するために Warm が呼び出すプラットフォーム API。

SetThreadRoutePriority

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

Thread TCP/IP スタック上の指定されたインターフェースの既存の IP ルートの優先度を変更するために Warm が呼び出すプラットフォーム API。

完了後、プラットフォームは最終結果で ReportActionComplete を呼び出す必要があります。

詳細
パラメータ
[in] inInterfaceType
変更するインターフェース。
[in] inPrefix
変更する IP 接頭辞。
[in] inPriority
ルートに適用する新しい優先度。
戻り値
kPlatformResultSuccess
オペレーションは正常に完了しました。
kPlatformResultFailure
操作に失敗しました。
kPlatformResultInProgress
オペレーションは非同期で完了します。

StartStopThreadAdvertisement

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

Thread インターフェースで IP プレフィックスのアドバタイズを開始 / 停止するために Warm が呼び出すプラットフォーム API。

完了後、プラットフォームは最終結果で ReportActionComplete を呼び出す必要があります。

詳細
パラメータ
[in] inInterfaceType
変更するインターフェース。
[in] inPrefix
アドバタイジングを開始または停止する IP プレフィックス。
[in] inStart
広告を開始する場合は true、広告を停止する場合は false を指定します。
戻り値
kPlatformResultSuccess
オペレーションは正常に完了しました。
kPlatformResultFailure
操作に失敗しました。
kPlatformResultInProgress
オペレーションは非同期で完了します。