otSrpClientService

#include <srp_client.h>

SRP クライアント サービスを表します。

概要

この構造体の値は、名前の文字列バッファと TXT レコード エントリを含め、この構造体のインスタンスが otSrpClientAddService() または otSrpClientRemoveService() から OpenThread に渡された後に保持され、一定でなければなりません。

mStatemDatamNext フィールドは、OT コアのみが使用、管理します。otSrpClientService のインスタンスが otSrpClientAddService()otSrpClientRemoveService() などの関数に渡される場合、それらの値は無視されます。呼び出し元は、これらのフィールドを設定する必要はありません。

mLease フィールドと mKeyLease フィールドには、このサービスに必要なリースとキーのリース間隔を指定します。値がゼロの場合、間隔が指定されておらず、otSrpClientGetLeaseInterval()otSrpClientGetKeyLeaseInterval() のデフォルトのリース間隔またはキーリース間隔がこのサービスに使用されます。キーリース間隔(明示的に設定されているかデフォルトから決定されているか)がサービスのリース間隔よりも短い場合、SRP クライアントはキーリース間隔にもリース間隔の値を再利用します。たとえば、サービス mLease では明示的に 2 日間に設定され、mKeyLease がゼロに設定され、デフォルトの鍵リースが 1 日に設定されている場合、このサービスを登録する際に、このサービスでリクエストされた鍵リースも 2 日間に設定されます。

パブリック属性

mData
uint32_t
内部データ(OT コアが使用)。
mInstanceName
const char *
サービス インスタンス名のラベル(完全な名前ではありません)。
mKeyLease
uint32_t
望ましい鍵リース間隔(秒)。デフォルトを使用する場合はゼロ。
mLease
uint32_t
望ましいリース間隔(秒)。デフォルトを使用する場合はゼロ。
mName
const char *
サービスラベル(「_mt._udp」を使用します。完全なドメイン名ではありません)。
mNext
リンクリスト(OT コアによって管理)内の次のエントリへのポインタ。
mNumTxtEntries
uint8_t
mTxtEntries 配列内のエントリ数。
mPort
uint16_t
サービスのポート番号。
mPriority
uint16_t
サービスの優先度。
mState
サービスの状態(OT コアによって管理)。
mSubTypeLabels
const char *const *
サブタイプのラベルの配列(末尾が NULL か、NULL の場合もあります)。
mTxtEntries
const otDnsTxtEntry *
TXT エントリの配列(mNumTxtEntries はエントリ数を示します)。
mWeight
uint16_t
サービスの重み。

パブリック属性

mData

uint32_t otSrpClientService::mData

内部データ(OT コアが使用)。

mInstanceName

const char * otSrpClientService::mInstanceName

サービス インスタンス名のラベル(完全な名前ではありません)。

mKeyLease

uint32_t otSrpClientService::mKeyLease

望ましい鍵リース間隔(秒)。デフォルトを使用する場合はゼロ。

mLease

uint32_t otSrpClientService::mLease

望ましいリース間隔(秒)。デフォルトを使用する場合はゼロ。

mName

const char * otSrpClientService::mName

サービスラベル(「_mt._udp」を使用します。完全なドメイン名ではありません)。

mNext

struct otSrpClientService * otSrpClientService::mNext

リンクリスト(OT コアによって管理)内の次のエントリへのポインタ。

mNumTxtEntries

uint8_t otSrpClientService::mNumTxtEntries

mTxtEntries 配列内のエントリ数。

mPort

uint16_t otSrpClientService::mPort

サービスのポート番号。

mPriority

uint16_t otSrpClientService::mPriority

サービスの優先度。

mState

otSrpClientItemState otSrpClientService::mState

サービスの状態(OT コアによって管理)。

mSubTypeLabels

const char *const * otSrpClientService::mSubTypeLabels

サブタイプのラベルの配列(末尾が NULL か、NULL の場合もあります)。

mTxtEntries

const otDnsTxtEntry * otSrpClientService::mTxtEntries

TXT エントリの配列(mNumTxtEntries はエントリ数を示します)。

mWeight

uint16_t otSrpClientService::mWeight

サービスの重み。

関連情報

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