otDnsTxtEntry

#include <dns.h>

Key-Value ペア(RFC 6763 - セクション 6.3)を表す TXT レコード エントリを表します。

概要

mKeymValue によってポイントされる文字列バッファは、そのような構造体のインスタンスが(otSrpClientService インスタンスの一部として)OpenThread に渡された後も保持され、変更されないままでなければなりません。

otSrpClientService では、otDnsTxtEntry エントリの配列を使用して、完全な TXT レコード(エントリのリスト)を指定します。

パブリック属性

mKey
const char *
TXT レコードキーの文字列。
mValue
const uint8_t *
TXT レコードの値またはエンコード済みの TXT-DATA(mKey によって異なる)。
mValueLength
uint16_t
mValue バッファのバイト数。

パブリック属性

mKey

const char * otDnsTxtEntry::mKey

TXT レコードキーの文字列。

mKey が NULL でない場合は、null で終わる C 文字列でなければなりません。エントリは Key-Value ペアとして扱われ、mValue バッファで値が提供されます。

  • エントリは次のようにエンコードされます。
    • 「key=value」形式が続く単一文字列長のバイト(引用符は付けません)。
    • この場合、エンコード全体の長さは 255 バイト以下にする必要があります。
  • mValue が NULL の場合、キーはブール値属性として扱われ、「key」としてエンコードされます(= はありません)。
  • mValue が NULL でなく、mValueLength がゼロの場合、空の値として扱われ、「key=」としてエンコードされます。

mKey が NULL の場合、mValue バッファはすでにエンコードされた TXT-DATA として扱われ、そのまま DNS メッセージに追加されます。

mValue

const uint8_t * otDnsTxtEntry::mValue

TXT レコードの値またはエンコード済みの TXT-DATA(mKey によって異なる)。

mValueLength

uint16_t otDnsTxtEntry::mValueLength

mValue バッファのバイト数。

関連情報

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