サーバー

このモジュールには、OpenThread Server でローカル ネットワーク データを管理する関数が含まれています。

概要

関数

otServerAddService(otInstance *aInstance, const otServiceConfig *aConfig)
ローカル ネットワーク データにサービス構成を追加します。
otServerGetNetDataLocal(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
ローカル スレッド ネットワーク データの完全または安定したコピーを提供します。
otServerGetNextService(otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
ローカル ネットワーク データ内の次のサービスを取得します。
otServerRegister(otInstance *aInstance)
ローカル ネットワーク データを直ちにリーダーに登録します。
otServerRemoveService(otInstance *aInstance, uint32_t aEnterpriseNumber, const uint8_t *aServiceData, uint8_t aServiceDataLength)
ローカル ネットワーク データからサービス設定を削除します。

関数

otServerAddService

otError otServerAddService(
  otInstance *aInstance,
  const otServiceConfig *aConfig
)

ローカル ネットワーク データにサービス構成を追加します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aConfig
サービス構成へのポインタ。
戻り値
OT_ERROR_NONE
ローカル ネットワーク データに構成を追加しました。
OT_ERROR_INVALID_ARGS
無効な設定パラメータがあります。
OT_ERROR_NO_BUFS
ローカル ネットワーク データに設定を追加するための十分な空き容量がありません。
関連情報:
otServerRemoveService
otServerRegister

otServerGetNetDataLocal

otError otServerGetNetDataLocal(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

ローカル スレッド ネットワーク データの完全または安定したコピーを提供します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aStable
安定版をコピーする場合は TRUE、完全版をコピーする場合は FALSE です。
[out] aData
データバッファへのポインタ。
[in,out] aDataLength
エントリ時、aData が指すデータバッファのサイズ。終了時にコピーされたバイト数。

otServerGetNextService

otError otServerGetNextService(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otServiceConfig *aConfig
)

ローカル ネットワーク データ内の次のサービスを取得します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in,out] aIterator
ネットワーク データ イテレータ コンテキストへのポインタ。最初のサービス エントリを取得するには、OT_NETWORK_DATA_ITERATOR_INIT に設定する必要があります。
[out] aConfig
サービス情報が配置される場所へのポインタ。
戻り値
OT_ERROR_NONE
次のサービスが見つかりました。
OT_ERROR_NOT_FOUND
Thread ネットワーク データに後続のサービスが存在しません。

otServerRegister

otError otServerRegister(
  otInstance *aInstance
)

ローカル ネットワーク データを直ちにリーダーに登録します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
OT_ERROR_NONE
サーバーデータ リクエスト メッセージを配信対象のキューに格納しました。
関連情報:
otServerAddService
otServerRemoveService

otServerRemoveService

otError otServerRemoveService(
  otInstance *aInstance,
  uint32_t aEnterpriseNumber,
  const uint8_t *aServiceData,
  uint8_t aServiceDataLength
)

ローカル ネットワーク データからサービス設定を削除します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aEnterpriseNumber
削除するサービス エントリの企業番号。
[in] aServiceData
削除中に検索するサービスデータへのポインタ。
[in] aServiceDataLength
aServiceData の長さ(バイト単位)。
戻り値
OT_ERROR_NONE
ローカル ネットワーク データから設定を削除しました。
OT_ERROR_NOT_FOUND
ボーダー ルーターのエントリが見つかりませんでした。
関連項目:
otServerAddService
otServerRegister

関連情報

OpenThread API リファレンスのトピックは、GitHub で入手できるソースコードに由来しています。 詳細について、またはドキュメントへの投稿については、リソースをご覧ください。