バックボーンルーター
このモジュールには、OpenThread Backbone Router サービスの関数が含まれています。
概要
列挙型 |
|
---|---|
otBackboneRouterDomainPrefixEvent{
|
列挙型 ドメイン プレフィックス イベントを表します。 |
otBackboneRouterMulticastListenerEvent{
|
列挙型 マルチキャスト リスナー イベントを表します。 |
otBackboneRouterNdProxyEvent{
|
列挙型 ND プロキシ イベントを表します。 |
otBackboneRouterState{
|
列挙型 バックボーン ルーターのステータスを表します。 |
Typedef |
|
---|---|
otBackboneRouterConfig
|
typedefstruct otBackboneRouterConfig
この構造は、バックボーン ルーター構成を表します。 |
otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)
|
typedefvoid(*
この関数ポインタは、ドメイン プレフィックスが変更されるたびに呼び出されます。 |
otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)
|
typedefvoid(*
この関数ポインタは、マルチキャスト リスナーが変更されるたびに呼び出されます。 |
otBackboneRouterMulticastListenerInfo
|
typedef この構造は、バックボーン ルーターのマルチキャスト リスナー情報を表します。 |
otBackboneRouterMulticastListenerIterator
|
typedefuint16_t
マルチキャスト リスナーを反復処理するために使用します。 |
otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)
|
typedefvoid(*
この関数ポインタは、Nd Proxy が変更されるたびに呼び出されます。 |
otBackboneRouterNdProxyInfo
|
typedefstruct otBackboneRouterNdProxyInfo
バックボーン ルーターの 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)
|
このメソッドは、ローカル ドメイン プレフィックス設定を取得します。
|
otBackboneRouterGetNdProxyInfo(otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo)
|
このメソッドは、バックボーン ルーターの ND プロキシ情報を取得します。
|
otBackboneRouterGetPrimary(otInstance *aInstance, otBackboneRouterConfig *aConfig)
|
この関数は、スレッド ネットワーク内のプライマリ バックボーン ルーター情報を取得します。
|
otBackboneRouterGetRegistrationJitter(otInstance *aInstance)
|
uint8_t
このメソッドは、バックボーン ルーターの登録ジッター値を返します。
|
otBackboneRouterGetState(otInstance *aInstance)
|
この関数は、バックボーン ルーターの状態を取得します。
|
otBackboneRouterMulticastListenerAdd(otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
|
このメソッドは、マルチキャスト リスナーを追加します。
|
otBackboneRouterMulticastListenerClear(otInstance *aInstance)
|
void
このメソッドは、マルチキャスト リスナーをクリアします。
|
otBackboneRouterMulticastListenerGetNext(otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
|
この関数は、次のマルチキャスト リスナー情報を(イテレータを使用して)取得します。
|
otBackboneRouterRegister(otInstance *aInstance)
|
この関数は、ローカル バックボーン ルーター構成を明示的に登録します。
|
otBackboneRouterSetConfig(otInstance *aInstance, const otBackboneRouterConfig *aConfig)
|
この関数は、ローカル バックボーン ルーター構成を設定します。
|
otBackboneRouterSetDomainPrefixCallback(otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext)
|
void
このメソッドは、Backbone Router のドメイン プレフィックス コールバックを設定します。
|
otBackboneRouterSetEnabled(otInstance *aInstance, bool aEnable)
|
void
この関数は、バックボーン機能を有効または無効にします。
|
otBackboneRouterSetMulticastListenerCallback(otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
|
void
このメソッドは、Backbone Router のマルチキャスト リスナー コールバックを設定します。
|
otBackboneRouterSetNdProxyCallback(otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
|
void
このメソッドは、Backbone Router ND Proxy コールバックを設定します。
|
otBackboneRouterSetRegistrationJitter(otInstance *aInstance, uint8_t aJitter)
|
void
このメソッドは、Backbone Router の登録ジッターの値を設定します。
|
構造体 |
|
---|---|
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)
この関数ポインタは、ドメイン プレフィックスが変更されるたびに呼び出されます。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
otBackboneRouterMulticastListenerCallback
void(* otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)
この関数ポインタは、マルチキャスト リスナーが変更されるたびに呼び出されます。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
otBackboneRouterMulticastListenerInfo
struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo
この構造は、バックボーン ルーターのマルチキャスト リスナー情報を表します。
otBackboneRouterMulticastListenerIterator
uint16_t otBackboneRouterMulticastListenerIterator
マルチキャスト リスナーを反復処理するために使用します。
otBackboneRouterNdProxyCallback
void(* otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)
この関数ポインタは、Nd Proxy が変更されるたびに呼び出されます。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
otBackboneRouterNdProxyInfo
struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo
バックボーン ルーターの ND プロキシ情報を表します。
関数
otBackboneRouterConfigNextDuaRegistrationResponse
void otBackboneRouterConfigNextDuaRegistrationResponse( otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus )
このメソッドは、次の DUA 登録の応答ステータスを設定します。
注: OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
が有効な場合にのみ使用できます。テストと認証にのみ使用されます。
TODO: DUA は coap エラーコードと、それに対応する認定プロセスをサポートします。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
otBackboneRouterConfigNextMulticastListenerRegistrationResponse
void otBackboneRouterConfigNextMulticastListenerRegistrationResponse( otInstance *aInstance, uint8_t aStatus )
このメソッドは、次のマルチキャスト リスナー登録のレスポンス ステータスを設定します。
注: OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
が有効な場合にのみ使用できます。テストと認証にのみ使用されます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otBackboneRouterGetConfig
void otBackboneRouterGetConfig( otInstance *aInstance, otBackboneRouterConfig *aConfig )
この関数は、ローカル バックボーン ルーター構成を取得します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterSetConfig
otBackboneRouterRegister
otBackboneRouterGetDomainPrefix
otError otBackboneRouterGetDomainPrefix( otInstance *aInstance, otBorderRouterConfig *aConfig )
このメソッドは、ローカル ドメイン プレフィックス設定を取得します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otBackboneRouterGetNdProxyInfo
otError otBackboneRouterGetNdProxyInfo( otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo )
このメソッドは、バックボーン ルーターの ND プロキシ情報を取得します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otBackboneRouterGetPrimary
otError otBackboneRouterGetPrimary( otInstance *aInstance, otBackboneRouterConfig *aConfig )
この関数は、スレッド ネットワーク内のプライマリ バックボーン ルーター情報を取得します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otBackboneRouterGetRegistrationJitter
uint8_t otBackboneRouterGetRegistrationJitter( otInstance *aInstance )
このメソッドは、バックボーン ルーターの登録ジッター値を返します。
詳細 | |
---|---|
戻り値 |
Backbone Router の登録ジッター値。
|
otBackboneRouterSetRegistrationJitter
otBackboneRouterGetState
otBackboneRouterState otBackboneRouterGetState( otInstance *aInstance )
この関数は、バックボーン ルーターの状態を取得します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister
otBackboneRouterMulticastListenerAdd
otError otBackboneRouterMulticastListenerAdd( otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout )
このメソッドは、マルチキャスト リスナーを追加します。
注: OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
が有効な場合にのみ使用できます。テストと認証にのみ使用されます。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext
otBackboneRouterMulticastListenerClear
void otBackboneRouterMulticastListenerClear( otInstance *aInstance )
このメソッドは、マルチキャスト リスナーをクリアします。
注: OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE
が有効な場合にのみ使用できます。テストと認証にのみ使用されます。
詳細 | |||
---|---|---|---|
パラメータ |
|
otBackboneRouterMulticastListenerAdd
otBackboneRouterMulticastListenerGetNext
otBackboneRouterMulticastListenerGetNext
otError otBackboneRouterMulticastListenerGetNext( otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo )
この関数は、次のマルチキャスト リスナー情報を(イテレータを使用して)取得します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
||||||
戻り値 |
|
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd
otBackboneRouterRegister
otError otBackboneRouterRegister( otInstance *aInstance )
この関数は、ローカル バックボーン ルーター構成を明示的に登録します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterSetConfig
otError otBackboneRouterSetConfig( otInstance *aInstance, const otBackboneRouterConfig *aConfig )
この関数は、ローカル バックボーン ルーター構成を設定します。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterRegister
otBackboneRouterSetDomainPrefixCallback
void otBackboneRouterSetDomainPrefixCallback( otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext )
このメソッドは、Backbone Router のドメイン プレフィックス コールバックを設定します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
otBackboneRouterSetEnabled
void otBackboneRouterSetEnabled( otInstance *aInstance, bool aEnable )
この関数は、バックボーン機能を有効または無効にします。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister
otBackboneRouterSetMulticastListenerCallback
void otBackboneRouterSetMulticastListenerCallback( otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext )
このメソッドは、Backbone Router のマルチキャスト リスナー コールバックを設定します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
otBackboneRouterSetNdProxyCallback
void otBackboneRouterSetNdProxyCallback( otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext )
このメソッドは、Backbone Router ND Proxy コールバックを設定します。
詳細 | |||||||
---|---|---|---|---|---|---|---|
パラメータ |
|
otBackboneRouterSetRegistrationJitter
void otBackboneRouterSetRegistrationJitter( otInstance *aInstance, uint8_t aJitter )
このメソッドは、Backbone Router の登録ジッターの値を設定します。
詳細 | |||
---|---|---|---|
パラメータ |
|
otBackboneRouterGetRegistrationJitter
マクロ
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT(OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT)
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0
otBackboneRouterMulticastListenerIterator の初期化子。
リソース
OpenThread API リファレンスのトピックは、GitHub で入手可能なソースコードに基づいています。 詳細またはドキュメントへの投稿については、リソースをご覧ください。