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

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

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

概要

パブリック属性

mAppState
void *
mAuthMode
WeaveAuthMode
mConnIntf
InterfaceId
接続がセットアップされるインターフェースです。
mConnectTimeoutMsecs
uint32_t
Connect 呼び出しが成功またはエラーを返すまでのタイムアウト。
mConnection
完了を待機している間、ここに stash への接続。
mConnectionCompleteHandler
宛先のサービス エンドポイントへの接続が完了したときに呼び出される関数へのポインタ。
mServiceEp
uint64_t
mStatusHandler
ステータス レポートの受信時に呼び出される関数へのポインタ。

パブリック関数

finalize(void)
void
このメソッドは、接続のクローズを含む内部状態をクリーンアップします。
free(void)
void
このメソッドは、接続リクエスト オブジェクトを解放し、プールに戻します。
init(WeaveServiceManager *aManager, const uint64_t & aServiceEp, WeaveAuthMode aAuthMode, void *aAppState, StatusHandler aStatusHandler, WeaveConnection::ConnectionCompleteFunct aCompleteHandler, const uint32_t aConnectTimeoutMsecs, const InterfaceId aConnIntf)
このメソッドは、渡された引数で ConnectRequest インスタンスを初期化します。
isAllocatedTo(const uint64_t & aServiceEp, void *aAppState)
bool
この関数は、特定のアプリケーション エンティティの特定のサービス エンドポイントに接続するために、この接続リクエストが現在使用中かどうかをテストします。
isFree(void)
bool
この関数は、接続リクエストが現在割り当てられていないかどうかをテストします。
onConnectionComplete(WEAVE_ERROR aError)
void
このメソッドは、接続完了イベントにおけるアプリケーション レイヤへのトランポリンです。

パブリック属性

mAppState

void * mAppState

mAuthMode

WeaveAuthMode mAuthMode

mConnIntf

InterfaceId mConnIntf

接続がセットアップされるインターフェースです。

mConnectTimeoutMsecs

uint32_t mConnectTimeoutMsecs

Connect 呼び出しが成功またはエラーを返すまでのタイムアウト。

mConnection

WeaveConnection * mConnection

完了を待機している間、ここに stash への接続。

mConnectionCompleteHandler

WeaveConnection::ConnectionCompleteFunct mConnectionCompleteHandler

宛先のサービス エンドポイントへの接続が完了したときに呼び出される関数へのポインタ。

mServiceEp

uint64_t mServiceEp

mStatusHandler

StatusHandler mStatusHandler

ステータス レポートの受信時に呼び出される関数へのポインタ。

パブリック関数

finalize

void finalize(
  void
)

このメソッドは、接続のクローズを含む内部状態をクリーンアップします。

無料

void free(
  void
)

このメソッドは、接続リクエスト オブジェクトを解放し、プールに戻します。

init

WEAVE_ERROR init(
  WeaveServiceManager *aManager,
  const uint64_t & aServiceEp,
  WeaveAuthMode aAuthMode,
  void *aAppState,
  StatusHandler aStatusHandler,
  WeaveConnection::ConnectionCompleteFunct aCompleteHandler,
  const uint32_t aConnectTimeoutMsecs,
  const InterfaceId aConnIntf
)

このメソッドは、渡された引数で ConnectRequest インスタンスを初期化します。

詳細
パラメータ
[in] aManager
含まれているサービス マネージャーへのポインタ。
[in] aServiceEp
この接続リクエストの目的のサービス エンドポイントへの ID。
[in] aAuthMode
この接続に使用する認証方法の記述子。
[in] aAppState
コールバックで返される任意のポインタ。
[in] aStatusHandler
サービス エンドポイント クエリに応じてステータス レポートを処理するコールバック関数へのポインタ。
[in] aCompleteHandler
接続完了イベントを処理するコールバック関数へのポインタ。
[in] aConnectTimeoutMsecs
Connect 呼び出しが成功するかエラーを返すまでのタイムアウト。
[in] aConnectIntf
接続が確立されるインターフェース。
戻り値
成功した場合は WEAVE_NO_ERROR、それ以外の場合は対応するエラーコード。

isAllocatedTo

bool isAllocatedTo(
  const uint64_t & aServiceEp,
  void *aAppState
)

この関数は、特定のアプリケーション エンティティの特定のサービス エンドポイントに接続するために、この接続リクエストが現在使用中かどうかをテストします。

詳細
パラメータ
[in] aServiceEp
この接続リクエストが保持するものと比較するサービス エンドポイント ID。
[in] aAppState
アプリケーションの状態へのポインタ。この接続リクエストが保持するものと比較するために使用されます。
戻り値
テストに合格した場合は true、そうでない場合は false です。

isFree

bool isFree(
  void
)

この関数は、接続リクエストが現在割り当てられていないかどうかをテストします。

詳細
戻り値
テストに合格した場合は true、そうでない場合は false です。

onConnectionComplete

void onConnectionComplete(
  WEAVE_ERROR aError
)

このメソッドは、接続完了イベントにおけるアプリケーション レイヤへのトランポリンです。

lookupAndConnect() で割り当てられた接続完了ハンドラを呼び出します。