Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

このページは Cloud Translation API によって翻訳されました。

nl::Weave::Profiles::WeaveTunnel::WeaveTunnelAgent

概要

コンストラクタとデストラクタ
`WeaveTunnelAgent(void)`

パブリックタイプ
`AgentState{ kState_NotInitialized = 0, kState_Initialized_NoTunnel = 1, kState_PrimaryTunModeEstablished = 2, kState_BkupOnlyTunModeEstablished = 3, kState_PrimaryAndBkupTunModeEstablished = 4 }`	enum サービスへの接続に関連するトンネルエージェントの状態。
`AgentState`	typedef `enum nl::Weave::Profiles::WeaveTunnel::WeaveTunnelAgent::AgentState` サービスへの接続に関連するトンネルエージェントの状態。
`OnServiceTunnelReconnectNotifyFunct)(TunnelType tunType, const char reconnectHost, const uint16_t reconnectPort, void appCtxt)`	typedef `void(*` サービスからトンネル再接続を受信したときに上位レイヤによって設定されたハンドラへの関数ポインタ。
`OnServiceTunnelStatusNotifyFunct)(WeaveTunnelConnectionMgr::TunnelConnNotifyReasons reason, WEAVE_ERROR err, void *appCtxt)`	typedef `void(*` Service へのトンネルに関連するさまざまな通知を処理するために上位レイヤによって設定されたハンドラへの関数ポインタ。
`PlatformNetworkOnlineCheck)(TunnelType tunType, void *appCtxt)`	typedef `void(*` ネットワークレベルのオンラインチェックを実行するためにアプリケーションが提供するハンドラへの関数ポインタ。
`WeaveTunnelFlags{ kTunnelFlag_PrimaryEnabled = 0x01, kTunnelFlag_BackupEnabled = 0x02, kTunnelFlag_PrimaryRestricted = 0x04, kTunnelFlag_BackupRestricted = 0x08 }`	enum 織りトンネルのフラグビット。
`WeaveTunnelFlags`	typedef `enum nl::Weave::Profiles::WeaveTunnel::WeaveTunnelAgent::WeaveTunnelFlags` 織りトンネルのフラグビット。

パブリック属性
`NetworkOnlineCheck`	`PlatformNetworkOnlineCheck`
`OnServiceTunReconnectNotify`	`OnServiceTunnelReconnectNotifyFunct`
`OnServiceTunStatusNotify`	`OnServiceTunnelStatusNotifyFunct` Service へのトンネルに関連するさまざまな通知を処理するために上位レイヤによって設定されたハンドラへの関数ポインタ。
`mServiceMgr`	`WeaveServiceManager *` Service の検索と接続に使用する Service Manager のポインタ。

パブリック関数
`DisablePrimaryTunnel(void)`	`void` プライマリトンネルを無効にします。
`EnablePrimaryTunnel(void)`	`void` プライマリトンネルを有効にします。
`GetAgentStateName(const AgentState state)`	`const char *` WeaveTunnelAgentState 名を取得します。
`GetTimeMsec(void)`	`uint64_t` システム時刻をミリ秒単位で取得します。
`GetWeaveTunnelAgentState(void)`	`AgentState` TunnelAgent の状態を取得します。
`Init(InetLayer inet, WeaveExchangeManager exchMgr, uint64_t dstNodeId, WeaveAuthMode authMode, WeaveServiceManager svcMgr, const char intfName, uint8_t role, void *appContext)`	`WEAVE_ERROR` トンネルエージェントを初期化します。
`Init(InetLayer inet, WeaveExchangeManager exchMgr, uint64_t dstNodeId, IPAddress dstIPAddr, WeaveAuthMode authMode, const char intfName, uint8_t role, void appContext)`	`WEAVE_ERROR` トンネルエージェントを初期化します。
`IsPrimaryTunnelEnabled(void) const`	`bool` プライマリトンネルが有効になっているかどうかを確認します。
`IsPrimaryTunnelRoutingRestricted(void)`	`bool` プライマリトンネルがサービスによるルーティング制限の対象かどうかを確認します。
`IsTunnelRoutingRestricted(void)`	`bool` トンネルがサービスによるルーティング制限の対象かどうかを確認します。
`NetworkOnlineCheckResult(TunnelType tunType, bool isOnline)`	`void` ネットワークのオンラインチェッカーの結果が利用可能なときにプラットフォームによって呼び出されるコールバック。
`ResetPrimaryReconnectBackoff(bool reconnectImmediately)`	`WEAVE_ERROR` プライマリトンネルの再接続時間をリセットします。
`SetAuthMode(const WeaveAuthMode authMode)`	`void` トンネルに WeaveAuthMode を設定します。
`SetDestination(const uint64_t nodeId, const IPAddress ipAddr, const uint16_t servicePort)`	`void` トンネルの宛先 nodeId、IPAddress、ポートを設定します。
`SetTunnelingDeviceRole(const Role role)`	`void` Tunnel の Tunneling デバイスのロール（BorderGateway、StandaloneDevice、MobileDevice）を設定します。
`Shutdown(void)`	`WEAVE_ERROR` トンネルエージェントをシャットダウンします。
`StartServiceTunnel(void)`	`WEAVE_ERROR` サービストンネルを起動します。
`StartServiceTunnel(uint64_t dstNodeId, IPAddress dstIPAddr, WeaveAuthMode authMode)`	`WEAVE_ERROR` サービストンネルを起動します。
`StopServiceTunnel(void)`	`void` Service へのトンネル接続を閉じます。
`StopServiceTunnel(WEAVE_ERROR err)`	`void` Service へのトンネル接続を閉じます。

静的パブリック関数
`RecvdFromShortcutUDPTunnel(WeaveMessageLayer msgLayer, PacketBuffer message)`	`void` ボーダーゲートウェイとモバイルデバイスの間のショートカット UDP トンネルを介してトンネリングされた IPv6 パケットを受信し、トンネルヘッダー内から未加工の IPv6 パケットのカプセル化を解除した後にトンネルエンドポイントインターフェースに転送するハンドラ。
`RecvdFromTunnelEndPoint(TunEndPoint tunEP, PacketBuffer message)`	`void` トンネルエンドポイントインターフェースから IPv6 パケットを受信し、トンネルヘッダー内で IPv6 パケットをカプセル化した後にサービス TCP 接続経由でサービスに転送するハンドラ、またはショートカットトンネルを介してモバイルクライアントに転送するハンドラ。

パブリックタイプ

AgentState

 AgentState

サービスへの接続に関連するトンネルエージェントの状態。

プロパティ
`kState_BkupOnlyTunModeEstablished`	サービスへのバックアップトンネルが確立されたことを示すために使用されます。
`kState_Initialized_NoTunnel`	トンネルエージェントが初期化されているが、トンネルが確立されていないことを示すために使用されます。
`kState_NotInitialized`	トンネルエージェントが初期化されていないことを示すために使用されます。
`kState_PrimaryAndBkupTunModeEstablished`	プライマリトンネルとバックアップトンネルの両方が確立されたことを示すために使用されます。
`kState_PrimaryTunModeEstablished`	Service へのプライマリトンネルが確立されたことを示すために使用されます。

AgentState

enum nl::Weave::Profiles::WeaveTunnel::WeaveTunnelAgent::AgentState AgentState

サービスへの接続に関連するトンネルエージェントの状態。

OnServiceTunnelReconnectNotifyFunct

void(* OnServiceTunnelReconnectNotifyFunct)(TunnelType tunType, const char *reconnectHost, const uint16_t reconnectPort, void *appCtxt)

サービスからトンネル再接続を受信したときに上位レイヤによって設定されたハンドラへの関数ポインタ。

詳細

パラメータ

`[in] tunType`	トンネルタイプ（プライマリまたはバックアップ）。
`[in] reconnectHost`	再接続する Service から提供されたホスト名。
`[in] reconnectPort`	Service から提供され、再接続する宛先ポート。
`[in] appCtxt`	アプリコンテキストオブジェクトへのポインタ

OnServiceTunnelStatusNotifyFunct

void(* OnServiceTunnelStatusNotifyFunct)(WeaveTunnelConnectionMgr::TunnelConnNotifyReasons reason, WEAVE_ERROR err, void *appCtxt)

Service へのトンネルに関連するさまざまな通知を処理するために上位レイヤによって設定されたハンドラへの関数ポインタ。

詳細

パラメータ

`[in] reason`	アプリケーションにステータスを通知する理由。
`[in] err`	Weave エラーが発生しました（ある場合）
`[in] appCtxt`	アプリコンテキストオブジェクトへのポインタ

PlatformNetworkOnlineCheck

void(* PlatformNetworkOnlineCheck)(TunnelType tunType, void *appCtxt)

ネットワークレベルのオンラインチェックを実行するためにアプリケーションが提供するハンドラへの関数ポインタ。

詳細

パラメータ

`[in] tunType`	トンネルタイプ（プライマリまたはバックアップ）。
`[in] appCtxt`	アプリコンテキストオブジェクトへのポインタ

WeaveTunnelFlags

 WeaveTunnelFlags

織りトンネルのフラグビット。

プロパティ
`kTunnelFlag_BackupEnabled`	バックアップトンネルが有効な場合に設定されます。
`kTunnelFlag_BackupRestricted`	バックアップトンネルのルーティングが制限される場合に設定されます。
`kTunnelFlag_PrimaryEnabled`	プライマリトンネルが有効な場合に設定されます。
`kTunnelFlag_PrimaryRestricted`	プライマリトンネルにルーティングが制限される場合に設定されます。

WeaveTunnelFlags

enum nl::Weave::Profiles::WeaveTunnel::WeaveTunnelAgent::WeaveTunnelFlags WeaveTunnelFlags

織りトンネルのフラグビット。

パブリック属性

NetworkOnlineCheck

PlatformNetworkOnlineCheck NetworkOnlineCheck

OnServiceTunReconnectNotify

OnServiceTunnelReconnectNotifyFunct OnServiceTunReconnectNotify

OnServiceTunStatusNotify

OnServiceTunnelStatusNotifyFunct OnServiceTunStatusNotify

Service へのトンネルに関連するさまざまな通知を処理するために上位レイヤによって設定されたハンドラへの関数ポインタ。

mServiceMgr

WeaveServiceManager * mServiceMgr

Service の検索と接続に使用する Service Manager のポインタ。

パブリック関数

DisablePrimaryTunnel

void DisablePrimaryTunnel(
  void
)

プライマリトンネルを無効にします。

EnablePrimaryTunnel

void EnablePrimaryTunnel(
  void
)

プライマリトンネルを有効にします。

GetAgentStateName

const char * GetAgentStateName(
  const AgentState state
)

WeaveTunnelAgentState 名を取得します。

GetTimeMsec

uint64_t GetTimeMsec(
  void
)

システム時刻をミリ秒単位で取得します。

システム時刻が利用できない場合は、システム時刻または単調時刻（ミリ秒単位）を取得します。

GetWeaveTunnelAgentState

AgentState GetWeaveTunnelAgentState(
  void
)

TunnelAgent の状態を取得します。

詳細
戻り値	AgentState: WeaveTunnelAgent の現在の状態。

init

WEAVE_ERROR Init(
  InetLayer *inet,
  WeaveExchangeManager *exchMgr,
  uint64_t dstNodeId,
  WeaveAuthMode authMode,
  WeaveServiceManager *svcMgr,
  const char *intfName,
  uint8_t role,
  void *appContext
)

トンネルエージェントを初期化します。

これにより、トンネルエンドポイントオブジェクトが作成され、トンネルインターフェースが設定され、メンバー変数、コールバック、WeaveTunnelControl が初期化されます。

init

WEAVE_ERROR Init(
  InetLayer *inet,
  WeaveExchangeManager *exchMgr,
  uint64_t dstNodeId,
  IPAddress dstIPAddr,
  WeaveAuthMode authMode,
  const char *intfName,
  uint8_t role,
  void *appContext
)

トンネルエージェントを初期化します。

IsPrimaryTunnelEnabled

bool IsPrimaryTunnelEnabled(
  void
) const

プライマリトンネルが有効になっているかどうかを確認します。

詳細
戻り値	有効になっている場合は true、それ以外の場合は false です。

IsPrimaryTunnelRoutingRestricted

bool IsPrimaryTunnelRoutingRestricted(
  void
)

プライマリトンネルがサービスによるルーティング制限の対象かどうかを確認します。

プライマリトンネルがルーティング制限の対象かどうかを確認します。

詳細
戻り値	プライマリトンネルが確立されているものの、サービスによるルーティング制限の対象となる場合は true。

IsTunnelRoutingRestricted

bool IsTunnelRoutingRestricted(
  void
)

トンネルがサービスによるルーティング制限の対象かどうかを確認します。

トンネルがルーティング制限の対象かどうかを確認します。

詳細
戻り値	プライマリトンネルまたはバックアップトンネルのいずれかが確立されていて、いずれかのトンネルがサービスによるルーティング制限の対象である場合は、true。

NetworkOnlineCheckResult

void NetworkOnlineCheckResult(
  TunnelType tunType,
  bool isOnline
)

ネットワークのオンラインチェッカーの結果が利用可能なときにプラットフォームによって呼び出されるコールバック。

詳細

パラメータ

`[in] tunType`	ネットワーク接続チェックが実行されるインターフェースに対応するトンネルタイプ。
`[in] isOnline`	ネットワークがオンラインの場合は true、それ以外の場合は false です。

ResetPrimaryReconnectBackoff

WEAVE_ERROR ResetPrimaryReconnectBackoff(
  bool reconnectImmediately
)

プライマリトンネルの再接続時間をリセットします。

詳細

パラメータ

[in] reconnectImmediately

すぐに再接続する必要がある場合は true、それ以外の場合は構成された再接続タイムアウトを使用する。

SetAuthMode

void SetAuthMode(
  const WeaveAuthMode authMode
)

トンネルに WeaveAuthMode を設定します。

詳細

パラメータ

[in] authMode

ピアで使用される Weave 認証モード。

SetDestination

void SetDestination(
  const uint64_t nodeId,
  const IPAddress ipAddr,
  const uint16_t servicePort
)

トンネルの宛先 nodeId、IPAddress、ポートを設定します。

トンネルの宛先 nodeId と IPAddress を設定します。

詳細

パラメータ

`[in] nodeId`	宛先ノードのノード ID。
`[in] ipAddr`	宛先ノードの IP アドレス。
`[in] servicePort`	宛先ノードのポート。

SetTunnelingDeviceRole

void SetTunnelingDeviceRole(
  const Role role
)

Tunnel の Tunneling デバイスのロール（BorderGateway、StandaloneDevice、MobileDevice）を設定します。

トンネルのトンネリングデバイスロール（BorderGateway またはスタンドアロン）を設定します。

詳細

パラメータ

[in] role

トンネルエージェントが想定するロール（ボーダーゲートウェイ、スタンドアロン、モバイルデバイス）。

シャットダウン

WEAVE_ERROR Shutdown(
  void
)

トンネルエージェントをシャットダウンします。

これにより、サービスへの接続が破棄され、トンネルインターフェースに関連付けられたアドレスとルートを削除した後に TunEndPoint インターフェースが閉じます。

詳細
戻り値	成功した場合は WEAVE_NO_ERROR、それ以外の場合は対応する WEAVE_ERROR 型。

StartServiceTunnel

WEAVE_ERROR StartServiceTunnel(
  void
)

サービストンネルを起動します。

これにより、トンネルが有効になり、Service への接続を確立しようとします。

これにより、Service との接続を確立し、トンネルインターフェースにファブリックルートが設定されます。

詳細
戻り値	成功した場合は WEAVE_NO_ERROR、それ以外の場合は対応する WEAVE_ERROR 型。

StartServiceTunnel

WEAVE_ERROR StartServiceTunnel(
  uint64_t dstNodeId,
  IPAddress dstIPAddr,
  WeaveAuthMode authMode
)

サービストンネルを起動します。

これにより、トンネルが有効になり、Service への接続を確立しようとします。

StopServiceTunnel

void StopServiceTunnel(
  void
)

Service へのトンネル接続を閉じます。

StopServiceTunnel

void StopServiceTunnel(
  WEAVE_ERROR err
)

Service へのトンネル接続を閉じます。

詳細

パラメータ

[in] err

WEAVE_NO_ERROR は、この StopServiceTunnel リクエストの具体的な理由がない場合は、エラーの原因が渡されます。

WeaveTunnelAgent

 WeaveTunnelAgent(
  void
)

静的パブリック関数

RecvdFromShortcutUDPTunnel

void RecvdFromShortcutUDPTunnel(
  WeaveMessageLayer *msgLayer,
  PacketBuffer *message
)

ボーダーゲートウェイとモバイルデバイスの間のショートカット UDP トンネルを介してトンネリングされた IPv6 パケットを受信し、トンネルヘッダー内から未加工の IPv6 パケットのカプセル化を解除した後にトンネルエンドポイントインターフェースに転送するハンドラ。

Service TCP 接続からトンネリングされた IPv6 パケットを受信し、トンネルヘッダー内から未加工の IPv6 パケットのカプセル化を解除した後にトンネルエンドポイントインターフェースに転送するハンドラ。

詳細

パラメータ

`[in] con`	WeaveConnection オブジェクトへのポインタ。
`[in] msgInfo`	WeaveMessageInfo オブジェクトへのポインタ。
`[in] message`	トンネリング IPv6 パケットを保持する PacketBuffer オブジェクトへのポインタ。

RecvdFromTunnelEndPoint

void RecvdFromTunnelEndPoint(
  TunEndPoint *tunEP,
  PacketBuffer *message
)

トンネルエンドポイントインターフェースから IPv6 パケットを受信し、トンネルヘッダー内で IPv6 パケットをカプセル化した後にサービス TCP 接続経由でサービスに転送するハンドラ、またはショートカットトンネルを介してモバイルクライアントに転送するハンドラ。

IPv6 パケットをトンネルエンドポイントインターフェースから受信し、トンネルヘッダー内で IPv6 パケットをカプセル化した後に Service TCP 接続経由でサービスに転送するハンドラ、またはローカルトンネル経由でモバイルクライアントに転送するハンドラ。

Service 接続がまだ確立されていない場合、接続が確立されるまでメッセージはキューに格納されます。モバイルクライアントデバイスへのトンネリングでは、ネクストホップのネイバーテーブルが参照されます。

詳細

パラメータ

`[in] tunEP`	TunEndPoint オブジェクトへのポインタ。
`[in] message`	未加工の IPv6 パケットを保持する PacketBuffer オブジェクトへのポインタ。

nl::Weave::Profiles::WeaveTunnel::WeaveTunnelAgent

概要

コンストラクタとデストラクタ

パブリック タイプ

パブリック属性

パブリック関数

静的パブリック関数

パブリック タイプ

AgentState

AgentState

OnServiceTunnelReconnectNotifyFunct

OnServiceTunnelStatusNotifyFunct

PlatformNetworkOnlineCheck

WeaveTunnelFlags

WeaveTunnelFlags

パブリック属性

NetworkOnlineCheck

OnServiceTunReconnectNotify

OnServiceTunStatusNotify

mServiceMgr

パブリック関数

DisablePrimaryTunnel

EnablePrimaryTunnel

GetAgentStateName

GetTimeMsec

GetWeaveTunnelAgentState

init

init

IsPrimaryTunnelEnabled

IsPrimaryTunnelRoutingRestricted

IsTunnelRoutingRestricted

NetworkOnlineCheckResult

ResetPrimaryReconnectBackoff

SetAuthMode

SetDestination

SetTunnelingDeviceRole

シャットダウン

StartServiceTunnel

StartServiceTunnel

StopServiceTunnel

StopServiceTunnel

WeaveTunnelAgent

静的パブリック関数

RecvdFromShortcutUDPTunnel

RecvdFromTunnelEndPoint

パブリックタイプ

パブリックタイプ