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
仍在等待作業完成時,請在這裡收納。
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
這個方法適用於連線完成事件的 Trampoline,到應用程式層。

公開屬性

mAppState

void * mAppState

mAuthMode

WeaveAuthMode mAuthMode

mConnIntf

InterfaceId mConnIntf

要在這個介面上設定連線。

mConnectTimeoutMsecs

uint32_t mConnectTimeoutMsecs

Connect 呼叫成功的逾時時間或傳回錯誤。

mConnection

WeaveConnection * mConnection

仍在等待作業完成時,請在這裡收納。

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
)

這個方法適用於連線完成事件的 Trampoline,到應用程式層。

它會呼叫在 lookupAndConnect() 中指定的連線完成處理常式。