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

バックボーンルーター

このモジュールには、OpenThreadバックボーンルーターサービスの機能が含まれています。

概要

列挙
`otBackboneRouterDomainPrefixEvent { OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED = 0, OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED = 1, OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED = 2 }`	列挙型ドメインプレフィックスイベントを表します。
`otBackboneRouterMulticastListenerEvent { OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED = 0, OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED = 1 }`	列挙型マルチキャストリスナイベントを表します。
`otBackboneRouterNdProxyEvent { OT_BACKBONE_ROUTER_NDPROXY_ADDED = 0, OT_BACKBONE_ROUTER_NDPROXY_REMOVED = 1, OT_BACKBONE_ROUTER_NDPROXY_RENEWED = 2, OT_BACKBONE_ROUTER_NDPROXY_CLEARED = 3 }`	列挙型 NDプロキシイベントを表します。
`otBackboneRouterState { OT_BACKBONE_ROUTER_STATE_DISABLED = 0, OT_BACKBONE_ROUTER_STATE_SECONDARY = 1, OT_BACKBONE_ROUTER_STATE_PRIMARY = 2 }`	列挙型バックボーンルーターのステータスを表します。

Typedef
`otBackboneRouterConfig`	typedef `struct otBackboneRouterConfig` この構造は、バックボーンルーターの構成を表します。
`otBackboneRouterDomainPrefixCallback )(void aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix aDomainPrefix)`	typedef `void(*` この関数ポインタは、ドメインプレフィックスが変更されるたびに呼び出されます。
`otBackboneRouterMulticastListenerCallback )(void aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address aAddress)`	typedef `void(*` この関数ポインタは、マルチキャストリスナが変更されるたびに呼び出されます。
`otBackboneRouterMulticastListenerInfo`	typedef `struct otBackboneRouterMulticastListenerInfo` この構造は、バックボーンルーターマルチキャストリスナー情報を表します。
`otBackboneRouterMulticastListenerIterator`	typedef `uint16_t` マルチキャストリスナを反復処理するために使用されます。
`otBackboneRouterNdProxyCallback )(void aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address aDua)`	typedef `void(*` この関数ポインタは、Ndプロキシが変更されるたびに呼び出されます。

関数
`otBackboneRouterConfigNextDuaRegistrationResponse ( otInstance aInstance, const otIp6InterfaceIdentifier aMlIid, uint8_t aStatus)`	`void` このメソッドは、次のDUA登録の応答ステータスを構成します。
`otBackboneRouterConfigNextMulticastListenerRegistrationResponse ( otInstance *aInstance, uint8_t aStatus)`	`void` このメソッドは、次のマルチキャストリスナ登録の応答ステータスを設定します。
`otBackboneRouterGetConfig ( otInstance aInstance, otBackboneRouterConfig aConfig)`	`void` この関数は、ローカルのバックボーンルーター構成を取得します。
`otBackboneRouterGetDomainPrefix ( otInstance aInstance, otBorderRouterConfig aConfig)`	`otError` このメソッドは、ローカルドメインプレフィックス構成を取得します。
`otBackboneRouterGetNdProxyInfo ( otInstance aInstance, const otIp6Address aDua,otBackboneRouterNdProxyInfo *aNdProxyInfo)`	`otError` このメソッドは、バックボーンルーターのNDプロキシ情報を取得します。
`otBackboneRouterGetPrimary ( otInstance aInstance, otBackboneRouterConfig aConfig)`	`otError` この関数は、スレッドネットワーク内のプライマリバックボーンルーター情報を取得します。
`otBackboneRouterGetRegistrationJitter ( otInstance *aInstance)`	`uint8_t` このメソッドは、バックボーンルーターの登録ジッター値を返します。
`otBackboneRouterGetState ( otInstance *aInstance)`	`otBackboneRouterState` この関数は、バックボーンルーターの状態を取得します。
`otBackboneRouterMulticastListenerAdd ( otInstance aInstance, const otIp6Address aAddress, uint32_t aTimeout)`	`otError` このメソッドは、マルチキャストリスナーを追加します。
`otBackboneRouterMulticastListenerClear ( otInstance *aInstance)`	`void` このメソッドは、マルチキャストリスナをクリアします。
`otBackboneRouterMulticastListenerGetNext ( otInstance aInstance, otBackboneRouterMulticastListenerIterator aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)`	`otError` この関数は、次のマルチキャストリスナ情報を取得します（イテレータを使用）。
`otBackboneRouterRegister ( otInstance *aInstance)`	`otError` この関数は、ローカルバックボーンルーター構成を明示的に登録します。
`otBackboneRouterSetConfig ( otInstance aInstance, const otBackboneRouterConfig aConfig)`	`otError` この関数は、ローカルバックボーンルーター構成を設定します。
`otBackboneRouterSetDomainPrefixCallback ( otInstance aInstance, otBackboneRouterDomainPrefixCallback aCallback, void aContext)`	`void` このメソッドは、バックボーンルータードメインプレフィックスコールバックを設定します。
`otBackboneRouterSetEnabled ( otInstance *aInstance, bool aEnable)`	`void` この関数は、バックボーン機能を有効または無効にします。
`otBackboneRouterSetMulticastListenerCallback ( otInstance aInstance, otBackboneRouterMulticastListenerCallback aCallback, void aContext)`	`void` このメソッドは、バックボーンルーターマルチキャストリスナーコールバックを設定します。
`otBackboneRouterSetNdProxyCallback ( otInstance aInstance, otBackboneRouterNdProxyCallback aCallback, void aContext)`	`void` このメソッドは、バックボーンルーターのNDプロキシコールバックを設定します。
`otBackboneRouterSetRegistrationJitter ( otInstance *aInstance, uint8_t aJitter)`	`void` このメソッドは、バックボーンルーターの登録ジッター値を設定します。

構造体
otBackboneRouterConfig	この構造は、バックボーンルーターの構成を表します。
otBackboneRouterMulticastListenerInfo	この構造は、バックボーンルーターマルチキャストリスナー情報を表します。
otBackboneRouterNdProxyInfo	バックボーンルーターのNDプロキシ情報を表します。

列挙

otBackboneRouterDomainPrefixEvent

 otBackboneRouterDomainPrefixEvent

ドメインプレフィックスイベントを表します。

プロパティ
`OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED`	ドメインプレフィックスが追加されました。
`OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED`	ドメインプレフィックスが変更されました。
`OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED`	ドメインプレフィックスが削除されました。

otBackboneRouterMulticastListenerEvent

 otBackboneRouterMulticastListenerEvent

マルチキャストリスナイベントを表します。

プロパティ
`OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED`	マルチキャストリスナが追加されました。
`OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED`	マルチキャストリスナが削除されたか、期限切れになりました。

otBackboneRouterNdProxyEvent

 otBackboneRouterNdProxyEvent

NDプロキシイベントを表します。

プロパティ
`OT_BACKBONE_ROUTER_NDPROXY_ADDED`	NDプロキシが追加されました。
`OT_BACKBONE_ROUTER_NDPROXY_CLEARED`	すべてのNDプロキシがクリアされました。
`OT_BACKBONE_ROUTER_NDPROXY_REMOVED`	NDプロキシが削除されました。
`OT_BACKBONE_ROUTER_NDPROXY_RENEWED`	NDプロキシが更新されました。

otBackboneRouterState

 otBackboneRouterState

バックボーンルーターのステータスを表します。

プロパティ
`OT_BACKBONE_ROUTER_STATE_DISABLED`	バックボーン機能が無効になっています。
`OT_BACKBONE_ROUTER_STATE_PRIMARY`	プライマリバックボーンルーター。
`OT_BACKBONE_ROUTER_STATE_SECONDARY`	セカンダリバックボーンルーター。

Typedef

otBackboneRouterConfig

struct otBackboneRouterConfig otBackboneRouterConfig

この構造は、バックボーンルーターの構成を表します。

otBackboneRouterDomainPrefixCallback

void(* otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)

この関数ポインタは、ドメインプレフィックスが変更されるたびに呼び出されます。

詳細

パラメーター

`[in] aContext`	ユーザーコンテキストポインタ。
`[in] aEvent`	ドメインプレフィックスイベント。
`[in] aDomainPrefix`	追加または変更された場合は新しいドメインプレフィックス、それ以外の場合はnullptr。

otBackboneRouterMulticastListenerCallback

void(* otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)

この関数ポインタは、マルチキャストリスナが変更されるたびに呼び出されます。

詳細

パラメーター

`[in] aContext`	ユーザーコンテキストポインタ。
`[in] aEvent`	マルチキャストリスナイベント。
`[in] aAddress`	マルチキャストリスナのIPv6マルチキャストアドレス。

otBackboneRouterMulticastListenerInfo

struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

この構造は、バックボーンルーターマルチキャストリスナー情報を表します。

otBackboneRouterMulticastListenerIterator

uint16_t otBackboneRouterMulticastListenerIterator

マルチキャストリスナを反復処理するために使用されます。

otBackboneRouterNdProxyCallback

void(* otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)

この関数ポインタは、Ndプロキシが変更されるたびに呼び出されます。

詳細

パラメーター

`[in] aContext`	ユーザーコンテキストポインタ。
`[in] aEvent`	NDプロキシイベント。
`[in] aDua`	NDプロキシのドメインユニキャストアドレス、または`aEvent`が`OT_BACKBONE_ROUTER_NDPROXY_CLEARED`場合は`nullptr` 。

関数

otBackboneRouterConfigNextDuaRegistrationResponse

void otBackboneRouterConfigNextDuaRegistrationResponse(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aMlIid,
  uint8_t aStatus
)

このメソッドは、次のDUA登録の応答ステータスを構成します。

注： OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLEが有効になっている場合にのみ使用できます。テストと認証にのみ使用されます。

TODO：（DUA）認証目的でcoapエラーコードと対応するプロセスをサポートします。

詳細

パラメーター

`[in] aInstance`	OpenThreadインスタンスへのポインタ。
`[in] aMlIid`	メッシュローカルIIDへのポインタ。 NULLの場合は、今後の`aStatus`に対して`aStatus`で応答します。それ以外の場合は、一致する`aMlIid`のみ応答します。
`[in] aStatus`	応答するステータス。

otBackboneRouterConfigNextMulticastListenerRegistrationResponse

void otBackboneRouterConfigNextMulticastListenerRegistrationResponse(
  otInstance *aInstance,
  uint8_t aStatus
)

このメソッドは、次のマルチキャストリスナ登録の応答ステータスを設定します。

注： OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLEが有効になっている場合にのみ使用できます。テストと認証にのみ使用されます。

詳細

パラメーター

`[in] aInstance`	OpenThreadインスタンスへのポインタ。
`[in] aStatus`	応答するステータス。

otBackboneRouterGetConfig

void otBackboneRouterGetConfig(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

この関数は、ローカルのバックボーンルーター構成を取得します。

詳細

パラメーター

`[in] aInstance`	OpenThreadインスタンスへのポインタ。
`[out] aConfig`	ローカルバックボーンルーター構成を配置するポインター。

参照：
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterSetConfig
otBackboneRouterRegister

otBackboneRouterGetDomainPrefix

otError otBackboneRouterGetDomainPrefix(
  otInstance *aInstance,
  otBorderRouterConfig *aConfig
)

このメソッドは、ローカルドメインプレフィックス構成を取得します。

詳細

パラメーター

`[in] aInstance`	OpenThreadインスタンスへのポインタ。
`[out] aConfig`	ドメインプレフィックス構成へのポインター。

戻り値

`OT_ERROR_NONE`	ドメインプレフィックス構成を正常に取得しました。
`OT_ERROR_NOT_FOUND`	ドメインプレフィックスが設定されていません。

otBackboneRouterGetNdProxyInfo

otError otBackboneRouterGetNdProxyInfo(
  otInstance *aInstance,
  const otIp6Address *aDua,
  otBackboneRouterNdProxyInfo *aNdProxyInfo
)

このメソッドは、バックボーンルーターのNDプロキシ情報を取得します。

詳細

パラメーター

`[in] aInstance`	OpenThreadインスタンスへのポインタ。
`[in] aDua`	ドメインユニキャストアドレス。
`[out] aNdProxyInfo`	NDプロキシ情報へのポインタ。

戻り値

`OT_ERROR_NONE`	NDプロキシ情報を正常に取得しました。
`OT_ERROR_NOT_FOUND`	NDプロキシテーブルでドメインユニキャストアドレスが見つかりませんでした。

otBackboneRouterGetPrimary

otError otBackboneRouterGetPrimary(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

この関数は、スレッドネットワーク内のプライマリバックボーンルーター情報を取得します。

詳細

パラメーター

`[in] aInstance`	OpenThreadインスタンスへのポインタ。
`[out] aConfig`	プライマリバックボーンルーター情報を配置する場所へのポインター。

戻り値

`OT_ERROR_NONE`	プライマリバックボーンルーター情報を正常に取得しました。
`OT_ERROR_NOT_FOUND`	プライマリバックボーンルーターは存在しません。

otBackboneRouterGetRegistrationJitter

uint8_t otBackboneRouterGetRegistrationJitter(
  otInstance *aInstance
)

このメソッドは、バックボーンルーターの登録ジッター値を返します。

詳細
戻り値	バックボーンルーターの登録ジッター値。

参照：
otBackboneRouterSetRegistrationJitter

otBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

この関数は、バックボーンルーターの状態を取得します。

詳細

パラメーター

[in] aInstance

OpenThreadインスタンスへのポインタ。

戻り値

`OT_BACKBONE_ROUTER_STATE_DISABLED`	バックボーン機能が無効になっています。
`OT_BACKBONE_ROUTER_STATE_SECONDARY`	セカンダリバックボーンルーター。
`OT_BACKBONE_ROUTER_STATE_PRIMARY`	プライマリバックボーンルーター。

参照：
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

otBackboneRouterMulticastListenerAdd

otError otBackboneRouterMulticastListenerAdd(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint32_t aTimeout
)

このメソッドは、マルチキャストリスナーを追加します。

注： OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLEが有効になっている場合にのみ使用できます。テストと認証にのみ使用されます。

詳細

パラメーター

`[in] aInstance`	OpenThreadインスタンスへのポインタ。
`[in] aAddress`	マルチキャストリスナアドレス。
`[in] aTimeout`	マルチキャストリスナのタイムアウト（秒単位）、またはデフォルトのMLRタイムアウトを使用する場合は0。

戻り値

`OT_ERROR_NONE`	マルチキャストリスナが正常に追加された場合。
`OT_ERROR_INVALID_ARGS`	マルチキャストリスナアドレスが無効だった場合。
`OT_ERROR_NO_BUFS`	マルチキャストリスナを保存するために使用できるスペースがありません。

参照：
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerClear

void otBackboneRouterMulticastListenerClear(
  otInstance *aInstance
)

このメソッドは、マルチキャストリスナをクリアします。

注： OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLEが有効になっている場合にのみ使用できます。テストと認証にのみ使用されます。

詳細

パラメーター

[in] aInstance

OpenThreadインスタンスへのポインタ。

参照：
otBackboneRouterMulticastListenerAdd
otBackboneRouterMulticastListenerGetNext

otBackboneRouterMulticastListenerGetNext

otError otBackboneRouterMulticastListenerGetNext(
  otInstance *aInstance,
  otBackboneRouterMulticastListenerIterator *aIterator,
  otBackboneRouterMulticastListenerInfo *aListenerInfo
)

この関数は、次のマルチキャストリスナ情報を取得します（イテレータを使用）。

詳細

パラメーター

`[in] aInstance`	OpenThreadインスタンスへのポインタ。
`[in,out] aIterator`	イテレータへのポインタ。成功すると、イテレータは次のマルチキャストリスナを指すように更新されます。最初のエントリを取得するには、イテレータをOT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INITに設定する必要があります。
`[out] aListenerInfo`	次のマルチキャストリスナの情報が配置される（成功した場合） `otBackboneRouterMulticastListenerInfo`へのポインタ。

戻り値

`OT_ERROR_NONE`	次のマルチキャストリスナ情報が正常に見つかりました（ `aListenerInfo`は正常に更新されました）。
`OT_ERROR_NOT_FOUND`	後続のマルチキャストリスナ情報が見つかりませんでした。

参照：
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd

otBackboneRouterRegister

otError otBackboneRouterRegister(
  otInstance *aInstance
)

この関数は、ローカルバックボーンルーター構成を明示的に登録します。

詳細

パラメーター

[in] aInstance

OpenThreadインスタンスへのポインタ。

戻り値

`OT_ERROR_NO_BUFS`	バックボーンルーターサービスを追加するためのスペースが不足しています。
`OT_ERROR_NONE`	配信のためにサーバーデータ要求メッセージを正常にキューに入れました。

参照：
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig

otBackboneRouterSetConfig

otError otBackboneRouterSetConfig(
  otInstance *aInstance,
  const otBackboneRouterConfig *aConfig
)

この関数は、ローカルバックボーンルーター構成を設定します。

詳細

パラメーター

`[in] aInstance`	OpenThreadインスタンスへのポインタ。
`[in] aConfig`	有効にするバックボーンルーター構成へのポインター。

戻り値

`OT_ERROR_NONE`	構成が正常に更新されました。
`OT_ERROR_INVALID_ARGS`	`aConfig`の構成が無効です。

参照：
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterRegister

otBackboneRouterSetDomainPrefixCallback

void otBackboneRouterSetDomainPrefixCallback(
  otInstance *aInstance,
  otBackboneRouterDomainPrefixCallback aCallback,
  void *aContext
)

このメソッドは、バックボーンルータードメインプレフィックスコールバックを設定します。

詳細

パラメーター

`[in] aInstance`	OpenThreadインスタンスへのポインタ。
`[in] aCallback`	ドメインプレフィックスコールバックへのポインタ。
`[in] aContext`	ユーザーコンテキストポインタ。

otBackboneRouterSetEnabled

void otBackboneRouterSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

この関数は、バックボーン機能を有効または無効にします。

詳細

パラメーター

`[in] aInstance`	OpenThreadインスタンスへのポインタ。
`[in] aEnable`	バックボーン機能を有効にする場合はTRUE、それ以外の場合はFALSE。

参照：
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

otBackboneRouterSetMulticastListenerCallback

void otBackboneRouterSetMulticastListenerCallback(
  otInstance *aInstance,
  otBackboneRouterMulticastListenerCallback aCallback,
  void *aContext
)

このメソッドは、バックボーンルーターマルチキャストリスナーコールバックを設定します。

詳細

パラメーター

`[in] aInstance`	OpenThreadインスタンスへのポインタ。
`[in] aCallback`	マルチキャストリスナコールバックへのポインタ。
`[in] aContext`	ユーザーコンテキストポインタ。

otBackboneRouterSetNdProxyCallback

void otBackboneRouterSetNdProxyCallback(
  otInstance *aInstance,
  otBackboneRouterNdProxyCallback aCallback,
  void *aContext
)

このメソッドは、バックボーンルーターのNDプロキシコールバックを設定します。

詳細

パラメーター

`[in] aInstance`	OpenThreadインスタンスへのポインタ。
`[in] aCallback`	NDプロキシコールバックへのポインタ。
`[in] aContext`	ユーザーコンテキストポインタ。

otBackboneRouterSetRegistrationJitter

void otBackboneRouterSetRegistrationJitter(
  otInstance *aInstance,
  uint8_t aJitter
)

このメソッドは、バックボーンルーターの登録ジッター値を設定します。

詳細

パラメーター

[in] aJitter

設定するバックボーンルーターの登録ジッター値。

参照：
otBackboneRouterGetRegistrationJitter

マクロ

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT

 OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0

otBackboneRouterMulticastListenerIteratorのイニシャライザー。

バックボーンルーター

概要

列挙

Typedef

関数

構造体

列挙

otBackboneRouterDomainPrefixEvent

otBackboneRouterMulticastListenerEvent

otBackboneRouterNdProxyEvent

otBackboneRouterState

Typedef

otBackboneRouterConfig

otBackboneRouterDomainPrefixCallback

otBackboneRouterMulticastListenerCallback

otBackboneRouterMulticastListenerInfo

otBackboneRouterMulticastListenerIterator

otBackboneRouterNdProxyCallback

関数

otBackboneRouterConfigNextDuaRegistrationResponse

otBackboneRouterConfigNextMulticastListenerRegistrationResponse

otBackboneRouterGetConfig

otBackboneRouterGetDomainPrefix

otBackboneRouterGetNdProxyInfo

otBackboneRouterGetPrimary

otBackboneRouterGetRegistrationJitter

otBackboneRouterGetState

otBackboneRouterMulticastListenerAdd

otBackboneRouterMulticastListenerClear

otBackboneRouterMulticastListenerGetNext

otBackboneRouterRegister

otBackboneRouterSetConfig

otBackboneRouterSetDomainPrefixCallback

otBackboneRouterSetEnabled

otBackboneRouterSetMulticastListenerCallback

otBackboneRouterSetNdProxyCallback

otBackboneRouterSetRegistrationJitter

マクロ

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT