nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager

#include <src/lib/profiles/service-directory/ServiceDirectory.h>

Weave サービス ディレクトリのマネージャー オブジェクト。

まとめ

Weave サービス マネージャーは、アプリケーションがディレクトリ サービスへのメイン インターフェースです。そのため、サービス エンドポイントに関連付けられたディレクトリ エントリの検索、そこで見つかった 1 つ以上のホスト名の DNS ルックアップ、接続の試行、接続の保護などにより複雑になります。また、サービス ディレクトリ情報のキャッシュを管理する場合もあります。

コンストラクタとデストラクタ
WeaveServiceManager(void)
このメソッドは、WeaveServiceManager インスタンスを初期化します。
~WeaveServiceManager(void)
このメソッドは、WeaveServiceManager インスタンスを破棄します。

パブリック タイプ
@303{
  kWeave_DefaultSendTimeout = 15000
} 		列挙型
OnConnectBegin)(struct ServiceConnectBeginArgs &args) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnConnectBegin
void(*
接続が確立される直前に行われたアプリケーション コールバック。
OnServiceEndpointQueryBegin)(void) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnServiceEndpointQueryBegin
void(*
送信 Service Directory クエリの時刻をマークするアプリケーション コールバック。
OnServiceEndpointQueryEndWithTimeInfo)(uint64_t timeQueryReceiptMsec, uint32_t timeProcessMsec) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnServiceEndpointQueryEndWithTimeInfo
void(*
Service Directory のレスポンスから時間値を提供するアプリケーション コールバック。
RootDirectoryAccessor)(uint8_t *aDirectory, uint16_t aLength) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::RootDirectoryAccessor
ルート ディレクトリ情報のアクセサ関数。
StatusHandler)(void *anAppState, WEAVE_ERROR anError, StatusReport *aStatusReport) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::StatusHandler
void(*
エラー条件とステータス状態のハンドラ。

パブリック関数
SetConnectBeginCallback(OnConnectBegin aConnectBegin)
void
接続が確立される直前に呼び出されるコールバック関数を設定します。
cancel(uint64_t aServiceEp, void *aAppState)
void
このメソッドは接続リクエストをキャンセルします。
clearCache(void)
void
このメソッドは、状態が kServiceMgrState_Resolved 状態（Service Directory エンドポイントからのレスポンスを受信した）の場合、マネージャーの状態とキャッシュをクリアします。
connect(uint64_t aServiceEp, WeaveAuthMode aAuthMode, void *aAppState, StatusHandler aStatusHandler, WeaveConnection::ConnectionCompleteFunct aConnectionCompleteHandler, const uint32_t aConnectTimeoutMsecs, const InterfaceId aConnectIntf)
このメソッドは、Weave サービスへの接続をリクエストします。
init(WeaveExchangeManager *aExchangeMgr, uint8_t *aCache, uint16_t aCacheLen, RootDirectoryAccessor aAccessor, WeaveAuthMode aDirAuthMode, OnServiceEndpointQueryBegin aServiceEndpointQueryBegin, OnServiceEndpointQueryEndWithTimeInfo aServiceEndpointQueryEndWithTimeInfo, OnConnectBegin aConnectBegin)
このメソッドは、サービス マネージャー オブジェクトを初期化します。
lookup(uint64_t aServiceEp, HostPortList *outHostPortList)
このメソッドは、サービス エンドポイントのディレクトリ情報を検索します。
lookup(uint64_t aServiceEp, uint8_t *aControlByte, uint8_t **aDirectoryEntry)
このメソッドは、サービス エンドポイントのディレクトリ情報を検索します。
onConnectionClosed(WEAVE_ERROR aError)
void
このメソッドは、関連する Weave Exchange コンテキストから報告された接続クローズ イベントを処理します。
onConnectionComplete(WEAVE_ERROR aError)
void
このメソッドは、サービス エンドポイントのクエリ トランザクションの接続完了イベントを処理します。
onResponseReceived(uint32_t aProfileId, uint8_t aMsgType, PacketBuffer *aMsg)
void
このメソッドは、ディレクトリ サービスとの会話内のすべてのレスポンス メッセージを処理します。
onResponseTimeout(void)
void
このメソッドは、ディレクトリ サービスからレスポンスが受信されなかったタイムアウト イベントを処理します。
relocate(WEAVE_ERROR aError)
void
このメソッドは、サービス ディレクトリのキャッシュを再配置します。
relocate(void)
void
このメソッドは、サービス ディレクトリのキャッシュを再配置します。
replaceOrAddCacheEntry(uint16_t port, const char *hostName, uint8_t hostLen, uint64_t serviceEndpointId)
ディレクトリ リストの先頭に、ホスト名とポート ID のオーバーライド ディレクトリ エントリを追加します。
reset(WEAVE_ERROR aError)
void
このメソッドは、サービス マネージャーを初期状態にリセットします。
reset(void)
void
このメソッドは、サービス マネージャーを初期状態にリセットします。
unresolve(WEAVE_ERROR aError)
void
このメソッドは、サービス ディレクトリのキャッシュを無効にします。
unresolve(void)
void
このメソッドは、サービス ディレクトリのキャッシュを無効にします。

クラス
nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::ConnectRequest

このクラスは、サービス マネージャーによって管理される単一のトランザクションを表します。

パブリック タイプ

303

 @303
Properties
kWeave_DefaultSendTimeout

Exchange コンテキストがタイムアウトするまでにディレクトリ クエリのレスポンスを受信する必要のある時間（ミリ秒）。

OnConnectBegin

void(* OnConnectBegin)(struct ServiceConnectBeginArgs &args)

接続が確立される直前に行われたアプリケーション コールバック。

このコールバックは、アプリケーションがサービス接続を確立する過程で #WeaveConnection::Connect() に渡される引数を監視し、必要に応じて変更できます。このコールバックは、ターゲット サービス エンドポイントへの接続と、ディレクトリ検索を実行する必要がある場合の Service Directory エンドポイントへの接続のために呼び出されます。

OnServiceEndpointQuery の開始

void(* OnServiceEndpointQueryBegin)(void)

送信 Service Directory クエリの時刻をマークするアプリケーション コールバック。

このメソッドは、サービス エンドポイントのクエリ リクエストを送信しようとしているときに呼び出されます。この値は、メッセージの飛行時間を補うために OnServiceEndpointQueryEnd と一致させるために使用されます。

OnServiceEndpointQueryEndWithTimeInfo

void(* OnServiceEndpointQueryEndWithTimeInfo)(uint64_t timeQueryReceiptMsec, uint32_t timeProcessMsec)

Service Directory のレスポンスから時間値を提供するアプリケーション コールバック。

サービス ディレクトリのクエリ レスポンスから時間情報を取得したときに呼び出されます。このコールバックは、レスポンスが正常に解析され、時間情報が含まれている場合にのみ行われます。

詳細
パラメータ
[in] timeQueryReceiptMsec
サーバー側でクエリを受け取った POSIX エポックからのミリ秒数
[in] timeProcessMsec
このクエリの処理に費やされたミリ秒数。

RootDirectoryAccessor

WEAVE_ERROR(* RootDirectoryAccessor)(uint8_t *aDirectory, uint16_t aLength)

ルート ディレクトリ情報のアクセサ関数。

まずどこから開始すべきか、そしてサービス ディレクトリから、他のすべてを取得するためヒットできるサーバーのアドレスを含むスタブ ディレクトリから始めます。こうした情報の表示方法や来歴はデバイスによって異なる可能性が高いため、ここではアクセサ コールバックについて説明します。

詳細
パラメータ
[out] aDirectory
ディレクトリ情報を書き込むバッファへのポインタ。
[in] aLength
指定されたバッファの長さ（バイト単位）。
戻り値
WEAVE_NO_ERROR: 失敗した場合、読み込みプロセスは中止されます。

ステータス ハンドラ

void(* StatusHandler)(void *anAppState, WEAVE_ERROR anError, StatusReport *aStatusReport)

エラー条件とステータス状態のハンドラ。

サービス マネージャーのユーザーには、次の 2 つのうちいずれかの方法で接続リクエストを実行する際に問題が発生する可能性があります。サービスからステータス レポートを受信したり、内部で生成された WEAVE_ERROR を受信したりできる。いずれの場合も、情報はこのコールバックを介して送信されます。

詳細
パラメータ
[in] anAppState
対応する conect() 呼び出しに渡されたアプリケーション オブジェクトへのポインタ。
[in] anError
接続リクエストの実行プロセス中にエラーが発生したことを示す Weave エラーコード。エラーが発生せず、ステータス レポートが使用できる場合、これは WEAVE_NO_ERROR になります。
[in] aStatusReport
リモート ディレクトリ サービスによって生成されたステータス レポートへのポインタ。ステータス レポートがなく、前の引数で内部エラーが渡された場合は、この引数を NULL にします。

パブリック関数

SetConnectBeginCallback

void SetConnectBeginCallback(
  OnConnectBegin aConnectBegin
)

接続が確立される直前に呼び出されるコールバック関数を設定します。

詳細
パラメータ
[in] aConnectBegin
コールバック関数へのポインタ。NULL を指定すると、コールバックが無効になります。

WeaveServiceManager

 WeaveServiceManager(
  void
)

このメソッドは、WeaveServiceManager インスタンスを初期化します。

このインスタンスをさらに初期化するには、init() を呼び出す必要があります。

cancel

void cancel(
  uint64_t aServiceEp,
  void *aAppState
)

このメソッドは接続リクエストをキャンセルします。

このメソッドは、リクエスト時にサービス エンドポイント ID とアプリケーション状態オブジェクトを識別子として渡して、接続リクエストをキャンセルします。最後の接続リクエストの場合、このメソッドは保留中のサービス ディレクトリの接続状態もクリアします。

詳細
パラメータ
[in] aServiceEp
キャンセルされたリクエストのサービス エンドポイント ID。
[in] anAppState
connect() 呼び出しで指定されたアプリの状態オブジェクトへのポインタ。

clearCache

void clearCache(
  void
)

このメソッドは、状態が kServiceMgrState_Resolved 状態（Service Directory エンドポイントからのレスポンスを受信した）の場合、マネージャーの状態とキャッシュをクリアします。

接続

WEAVE_ERROR connect(
  uint64_t aServiceEp,
  WeaveAuthMode aAuthMode,
  void *aAppState,
  StatusHandler aStatusHandler,
  WeaveConnection::ConnectionCompleteFunct aConnectionCompleteHandler,
  const uint32_t aConnectTimeoutMsecs,
  const InterfaceId aConnectIntf
)

このメソッドは、Weave サービスへの接続をリクエストします。

これは最上位の接続呼び出しです。基本的に、サービス エンドポイントと認証モードが指定された場合に、Weave サービスへの安全な接続が生成されます。

このメソッドは init() の呼び出しが成功した後にのみ呼び出すことができ、接続リクエストは cancel() によってキャンセルされる可能性があります。

このメソッドは、ローカル キャッシュにデフォルトのプロビジョニング データまたはディレクトリ サービスへの移動データが入力される前に呼び出すことができます。サービス マネージャーは、単にキャッシュ コンテンツを決定する前にリクエストをキューに入れます。

詳細
パラメータ
[in] aServiceEp
ServiceDirectory.h で定義された、関心のあるサービスのサービス エンドポイント識別子。
[in] aAuthMode
目的のサービスに接続するときに使用する認証モード。
[in] aAppState
アプリケーション状態オブジェクトへのポインタ。引数としてコールバックに渡されます。
[in] aStatusHandler
接続が完了する前にエラーが発生した場合に呼び出すコールバック。
[in] aConnectionCompleteHandler
リクエストされた接続が完了したときに呼び出すコールバック。接続が Weave エラーコードで失敗する可能性があることに注意してください。
[in] aConnectTimeoutMsecs
オプションの TCP 接続タイムアウト（ミリ秒単位）。
[in] aConnectIntf
接続を確立するインターフェース（省略可）。
戻り値
成功の場合は WEAVE_NO_ERROR、それ以外の場合はエラーコード。

init

WEAVE_ERROR init(
  WeaveExchangeManager *aExchangeMgr,
  uint8_t *aCache,
  uint16_t aCacheLen,
  RootDirectoryAccessor aAccessor,
  WeaveAuthMode aDirAuthMode,
  OnServiceEndpointQueryBegin aServiceEndpointQueryBegin,
  OnServiceEndpointQueryEndWithTimeInfo aServiceEndpointQueryEndWithTimeInfo,
  OnConnectBegin aConnectBegin
)

このメソッドは、サービス マネージャー オブジェクトを初期化します。

使用するには、サービス マネージャー オブジェクトを初期化する必要があります。この呼び出しが正常に終了すると、クライアントは connect() や lookup() などのメソッドを呼び出すことができるようになります。

詳細
パラメータ
[in] aExchangeMgr
すべてのサービス ディレクトリ プロファイル交換に使用する、エクスチェンジ マネージャーへのポインタ。
[in] aCache
ディレクトリ情報をキャッシュに保存するために使用できるバッファへのポインタ。
[in] aCacheLen
キャッシュの長さ（バイト単位）。
[in] aAccessor
ServiceDirectory.h で定義されているコールバック。ディレクトリの検索を開始点としてルート ディレクトリを読み込むために呼び出します。
[in] aDirAuthMode
ディレクトリ サービスとの通信時に使用する認証モード。
[in] aServiceEndpointQueryBegin
OnServiceEndpointQueryBegin の関数ポインタ。サービス ディレクトリ リクエストの開始時に呼び出され、サービス ディレクトリ プロトコルで提供される時刻同期を使用する場合はアプリケーション コードで時刻をマークできます。
[in] aServiceEndpointQueryEndWithTimeInfo
OnServiceEndpointQueryEndWithTimeInfo タイプの関数ポインタ。サービス ディレクトリの受信時に呼び出されます。応答で指定された時間フィールドを使用して、アプリが Weave サービスと同期できるようになります。このコールバックは、サービス マネージャーが時間情報を含むレスポンスを受信した後に行われます。コールバックが行われる前に、すでにキャッシュは正常に入力されています。
[in] aConnectBegin
接続が確立される直前に呼び出される OnConnectBegin タイプの関数ポインタです。これにより、アプリケーションは #WeaveConnection::Connect() に渡される引数を監視し、必要に応じて変更できます。値 NULL（デフォルト）により、コールバックが無効になります。
戻り値
WEAVE_ERROR_INVALID_ARGUMENT 関数の引数が無効な場合は WEAVE_NO_ERROR。

lookup

WEAVE_ERROR lookup(
  uint64_t aServiceEp,
  HostPortList *outHostPortList
)

このメソッドは、サービス エンドポイントのディレクトリ情報を検索します。

サービス ディレクトリが解決された場合（connect() オペレーションが成功した場合）、このメソッドは指定された HostPortList オブジェクトに入力します。

注: HostPortList は WeaveServiceManager オブジェクトにバインドされています。これは、サービス ディレクトリのキャッシュがクリアされるか、別のサービス ディレクトリのルックアップが行われるまで有効です。

詳細
パラメータ
[in] aServiceEp
検索するサービス エンドポイントの ID。
[out] outHostPortList
ディレクトリ エントリの正常な検索で入力される HostPortList へのポインタ。NULL は指定できません。
戻り値
WEAVE_NO_ERROR
それ以外の場合は、対応するエラーコード。
WEAVE_ERROR_INVALID_SERVICE_EP
指定されたサービス エンドポイントが見つからない場合。
WEAVE_ERROR_INVALID_DIRECTORY_ENTRY_TYPE
不明なエントリ タイプを含むディレクトリ。

lookup

WEAVE_ERROR lookup(
  uint64_t aServiceEp,
  uint8_t *aControlByte,
  uint8_t **aDirectoryEntry
)

このメソッドは、サービス エンドポイントのディレクトリ情報を検索します。

サービス ディレクトリが解決された場合、つまり connect() オペレーションが成功した場合、このメソッドはサービス エンドポイント ID に基づいてディレクトリ エントリを返します。

このメソッドは、サービス ディレクトリの内部実装の詳細を公開します。HostPortList を生成するこのメソッドのバリアントを使用して実装することをおすすめします。

詳細
パラメータ
[in] aServiceEp
検索するサービス エンドポイントの ID。
[out] aControlByte
ディレクトリ エントリの制御バイトを書き込む場所へのポインタ。
[out] aDirectoryEntry
ディレクトリ エントリに転送するポインタポインタ。
戻り値
WEAVE_NO_ERROR
それ以外の場合は、対応するエラーコード。
WEAVE_ERROR_INVALID_SERVICE_EP
指定されたサービス エンドポイントが見つからない場合。
WEAVE_ERROR_INVALID_DIRECTORY_ENTRY_TYPE
不明なエントリ タイプを含むディレクトリ。

onConnectionClosed

void onConnectionClosed(
  WEAVE_ERROR aError
)

このメソッドは、関連する Weave Exchange コンテキストから報告された接続クローズ イベントを処理します。

詳細
パラメータ
[in] aError
この接続が切断された理由を示す Weave エラー。

onConnectionComplete

void onConnectionComplete(
  WEAVE_ERROR aError
)

このメソッドは、サービス エンドポイントのクエリ トランザクションの接続完了イベントを処理します。

次のような方法が考えられます。まず、接続に失敗した可能性があり、完了しています。それ以外の場合、実際には接続は完了しています。そこで、Exchange コンテキストを開いてディレクトリ クエリを送信します。

詳細
パラメータ
[in] aError
接続の設定中にエラーが発生した場合は Weave エラーになります。

onResponseReceived（onResponse 受信）

void onResponseReceived(
  uint32_t aProfileId,
  uint8_t aMsgType,
  PacketBuffer *aMsg
)

このメソッドは、ディレクトリ サービスとの会話内のすべてのレスポンス メッセージを処理します。

詳細
パラメータ
[in] aProfileId
この受信メッセージのプロファイル ID。
[in] aMsgType
このメッセージのプロファイル固有のタイプ。
[in] aMsg
このメッセージの内容。

onResponseTimeout

void onResponseTimeout(
  void
)

このメソッドは、ディレクトリ サービスからレスポンスが受信されなかったタイムアウト イベントを処理します。

再配置

void relocate(
  WEAVE_ERROR aError
)

このメソッドは、サービス ディレクトリのキャッシュを再配置します。

サービス エンドポイントがステータス コード kStatus_Relocated を含むステータス レポートを返すと、アプリケーションが unresolve() を呼び出してキャッシュをクリアし、接続リクエストをキャンセルできます。このメソッドは、初回に unresolve() を呼び出してエラー処理を簡素化します。問題がまだ解決されていない場合は、reset() を行います。

下位互換性を確保するため、このバージョンのメソッドはエラーを受け取ってログを記録し、relocate(void) を呼び出します。

詳細
パラメータ
[in] aError
エラーを記録する
関連情報:
relocate(void)

再配置

void relocate(
  void
)

このメソッドは、サービス ディレクトリのキャッシュを再配置します。

サービス エンドポイントがステータス コード kStatus_Relocated を含むステータス レポートを返すと、アプリケーションが unresolve() を呼び出してキャッシュをクリアし、接続リクエストをキャンセルできます。このメソッドは、初回に unresolve() を呼び出してエラー処理を簡素化します。問題がまだ解決されていない場合は、reset() を行います。

関連情報:
relocate(WEAVE_ERROR)

replaceOrAddCacheEntry

WEAVE_ERROR replaceOrAddCacheEntry(
  uint16_t port,
  const char *hostName,
  uint8_t hostLen,
  uint64_t serviceEndpointId
)

ディレクトリ リストの先頭に、ホスト名とポート ID のオーバーライド ディレクトリ エントリを追加します。

リセット

void reset(
  WEAVE_ERROR aError
)

このメソッドは、サービス マネージャーを初期状態にリセットします。

このメソッドは、通信状態、キャッシュ状態、保留中の接続リクエストの状態など、すべてのサービス マネージャーの状態をリセットします。

このバージョンのメソッド（ここでは下位互換性のため）はエラーを受け取ってログに記録し、reset(void) を呼び出します。

詳細
パラメータ
[in] aError
このオペレーションをトリガーしたエラー。
関連情報:
reset(void)

リセット

void reset(
  void
)

このメソッドは、サービス マネージャーを初期状態にリセットします。

このメソッドは、通信状態、キャッシュ状態、保留中の接続リクエストの状態など、すべてのサービス マネージャーの状態をリセットします。

関連情報:
reset(WEAVE_ERROR)

未解決

void unresolve(
  WEAVE_ERROR aError
)

このメソッドは、サービス ディレクトリのキャッシュを無効にします。

このメソッドは、サービス ディレクトリのキャッシュの状態を設定して、次のリクエストでサービス マネージャーが Service Directory のクエリを発行できるようにします。

このバージョンのメソッド（下位互換性のため）は、エラーを受け取ってログに記録し、unresolve(void) を呼び出します。

詳細
パラメータ
[in] aError
このオペレーションをトリガーしたエラー。
関連情報:
unresolve(void)

未解決

void unresolve(
  void
)

このメソッドは、サービス ディレクトリのキャッシュを無効にします。

このメソッドは、サービス ディレクトリのキャッシュの状態を設定して、次のリクエストでサービス マネージャーが Service Directory のクエリを発行できるようにします。

関連情報:
unresolve(WEAVE_ERROR)

WeaveServiceManager

 ~WeaveServiceManager(
  void
)

このメソッドは、WeaveServiceManager インスタンスを破棄します。