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

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

Weave Service Directory のマネージャー オブジェクト。

概要

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

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

公開タイプ
@303{
  kWeave_DefaultSendTimeout = 15000
} 		enum
OnConnectBegin)(struct ServiceConnectBeginArgs &args) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnConnectBegin
void(*
接続を確立する直前に実行されるアプリケーション コールバック。
OnServiceEndpointQueryBegin)(void) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnServiceEndpointQueryBegin
void(*
送信されるサービス ディレクトリ クエリの時刻をマークするアプリケーション コールバック。
OnServiceEndpointQueryEndWithTimeInfo)(uint64_t timeQueryReceiptMsec, uint32_t timeProcessMsec) nl::Weave::Profiles::ServiceDirectory::WeaveServiceManager::OnServiceEndpointQueryEndWithTimeInfo
void(*
サービス ディレクトリ レスポンスから時間値を提供するアプリ コールバック。
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 交換コンテキストから報告された接続終了イベントを処理します。
onConnectionComplete(WEAVE_ERROR aError)
void
このメソッドは、サービス エンドポイント クエリ トランザクションの接続完了イベントを処理します。
onResponseReceived(uint32_t aProfileId, uint8_t aMsgType, PacketBuffer *aMsg)
void
このメソッドは、ディレクトリ サービスとの会話内のレスポンス メッセージを処理します。
onResponseTimeout(void)
void
このメソッドは、ディレクトリ サービスから応答が受信されなかったタイムアウト イベントを処理します。
relocate(WEAVE_ERROR aError)
void
この方法では、Service Directory キャッシュを再配置します。
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
プロパティ
kWeave_DefaultSendTimeout

交換コンテキストがタイムアウトする前に、ディレクトリ クエリのレスポンスを受信する必要があるミリ秒数。

OnConnectBegin

void(* OnConnectBegin)(struct ServiceConnectBeginArgs &args)

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

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

OnServiceEndpointQueryBegin

void(* OnServiceEndpointQueryBegin)(void)

送信されるサービス ディレクトリ クエリの時刻をマークするアプリケーション コールバック。

これは、サービス エンドポイントのクエリ リクエストを送信しようとしたときに呼び出されます。これは、OnServiceEndpointQueryEnd と照合して、メッセージのフライト時間を補正するために使用されます。

OnServiceEndpointQueryEndWithTimeInfo

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

サービス ディレクトリ レスポンスから時間値を提供するアプリ コールバック。

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

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

RootDirectoryAccessor

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

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

どこかから始める必要があります。Service Directory では、他のすべてのサービスにアクセスできるサーバーのアドレスを含むスタブ ディレクトリから始める必要があります。この情報の処理と来歴はデバイスによって異なる可能性があるため、ここではアクセサラ コールバックを提供します。

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

StatusHandler

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() を呼び出す必要があります。

キャンセル

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 で定義されている、対象のサービスのサービス エンドポイント ID。
[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
成功した場合は 0、それ以外の場合は対応するエラーコード。
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 を指定してディレクトリ エントリを返します。

このメソッドは、Service Directory の内部実装の詳細を公開します。実装では、HostPortList を生成するこのメソッドのバリエーションを使用することを強くおすすめします。

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

onConnectionClosed

void onConnectionClosed(
  WEAVE_ERROR aError
)

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

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

onConnectionComplete

void onConnectionComplete(
  WEAVE_ERROR aError
)

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

その方法はいくつかあります。まず、接続に失敗している可能性があります。その場合は、この手順は終了です。それ以外の場合は、接続は実際に完了しており、交換コンテキストを開いてディレクトリ クエリを送信する必要があります。

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

onResponseReceived

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
)

この方法では、Service Directory キャッシュを再配置します。

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

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

詳細
パラメータ
[in] aError
ログに記録されます。
関連情報:
relocate(void)

移転

void relocate(
  void
)

この方法では、Service Directory キャッシュを再配置します。

サービス エンドポイントがステータス コード 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
)

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

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

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

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

未解決

void unresolve(
  void
)

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

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

関連情報:
unresolve(WEAVE_ERROR)

~WeaveServiceManager

 ~WeaveServiceManager(
  void
)

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