Google 致力于为黑人社区推动种族平等。查看具体举措。

此页面由 Cloud Translation API 翻译。

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`	`WeaveConnection *` 在等待完成时将其隐藏在此处的连接。
`mConnectionCompleteHandler`	`WeaveConnection::ConnectionCompleteFunct` 指向完成与目标服务端点的连接时调用的函数的指针。
`mServiceEp`	`uint64_t`
`mStatusHandler`	`StatusHandler` 指向在收到状态报告时调用的函数的指针。

公共函数
`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)`	`WEAVE_ERROR` 此方法使用传入的参数初始化 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() 中分配的连接完成处理程序。