nl::Weave::WeaveConnection

#include <src/lib/core/WeaveMessageLayer.h>

Weave Connection 类的定义。

总结

它表示与另一 Weave 节点的 TCP 或 BLE 连接。

公共类型

@58{
  kGetPeerDescription_MaxLength = nl::Weave::kWeavePeerDescription_MaxLength
}
枚举
ConnectionClosedFunct)(WeaveConnection *con, WEAVE_ERROR conErr) typedef
void(*
此函数是在连接关闭时调用的应用回调。
ConnectionCompleteFunct)(WeaveConnection *con, WEAVE_ERROR conErr) typedef
void(*
该函数是连接设置完成后调用的应用回调。
MessageReceiveFunct)(WeaveConnection *con, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf) typedef
void(*
此函数是通过 Weave 连接接收消息时调用的应用回调函数。
NetworkType{
  kNetworkType_Unassigned = 0,
  kNetworkType_IP = 1,
  kNetworkType_BLE = 2
}
枚举
Weave 连接对象的网络类型。
ReceiveErrorFunct)(WeaveConnection *con, WEAVE_ERROR err) typedef
void(*
此函数是在接收 Weave 消息时发生错误时调用的应用回调。
State{
  kState_ReadyToConnect = 0,
  kState_Resolving = 1,
  kState_Connecting = 2,
  kState_EstablishingSession = 3,
  kState_Connected = 4,
  kState_SendShutdown = 5,
  kState_Closed = 6
}
枚举
Weave 连接对象的状态。
TunneledMsgReceiveFunct)(WeaveConnection *con, const WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf) typedef
void(*
此函数是通过 Weave 连接收到 Tunneled 数据包后调用的应用回调函数。

公共属性

AppState
void *
指向应用特定状态对象的指针。
AuthMode
WeaveAuthMode
[只读] 用于为连接建立默认加密密钥的身份验证模式。
DefaultEncryptionType
uint8_t
邮件的默认加密类型。
DefaultKeyId
uint16_t
发送消息时使用的默认加密密钥。
MessageLayer
[只读] 关联的 WeaveMessageLayer 对象。
NetworkType
uint8_t
[只读] 相关端点的网络类型。
OnConnectionClosed
OnConnectionComplete
OnMessageReceived
OnReceiveError
OnTunneledMessageReceived
PeerAddr
IPAddress
[只读] 对等节点的 IP 地址。
PeerNodeId
uint64_t
[只读] 对等方的节点标识符。
PeerPort
uint16_t
[只读] 对等节点的端口号。
ReceiveEnabled
bool
[只读] 如果启用接收,则为 true,否则为 false。
SendDestNodeId
bool
如果通过此连接发送的所有消息都必须包含经过明确编码的目标节点标识符,则为 true,否则为 false。
SendSourceNodeId
bool
如果通过此连接发送的所有邮件都必须包含已明确编码的源节点标识符,则为 true;否则为 false。
State
uint8_t
[只读] WeaveConnection 对象的状态。

公共函数

Abort(void)
void
对基于 TCP 或 BLE 的 WeaveConnection 执行优雅关闭,从而舍弃可能传入或传出对等端的所有数据。
AddRef(void)
void
预留对 WeaveConnection 对象的引用。
Close(void)
对基于 TCP 或 BLE 的 WeaveConnection 执行非阻塞安全关闭,并在礼让地通知远程主机我们已重置连接之前提供所有剩余的传出数据。
Close(bool suppressCloseLog)
对基于 TCP 或 BLE 的 WeaveConnection 执行非阻塞安全关闭,并在礼让地通知远程主机我们已重置连接之前提供所有剩余的传出数据。
Connect(uint64_t peerNodeId)
使用从指定节点标识符派生的结构 IP 地址连接到 Weave 节点。
Connect(uint64_t peerNodeId, const IPAddress & peerAddr, uint16_t peerPort)
使用节点标识符和/或 IP 地址连接到 Weave 节点。
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, const IPAddress & peerAddr, uint16_t peerPort, InterfaceId intf)
在特定接口上使用节点标识符和/或 IP 地址连接到 Weave 节点。
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t defaultPort)
使用节点标识符和/或字符串主机名连接到 Weave 节点。
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t peerAddrLen, uint16_t defaultPort)
使用节点标识符和/或字符串对等地址连接到 Weave 节点。
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t peerAddrLen, uint8_t dnsOptions, uint16_t defaultPort)
使用节点标识符和/或字符串对等地址连接到 Weave 节点。
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, HostPortList hostPortList, InterfaceId intf)
使用节点标识符和/或主机名和端口列表连接到 Weave 节点。
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, HostPortList hostPortList, uint8_t dnsOptions, InterfaceId intf)
使用节点标识符和/或主机名和端口列表连接到 Weave 节点。
DisableKeepAlive(void)
DisableReceive(void)
void
禁止通过此 WeaveConnection 接收邮件。
EnableKeepAlive(uint16_t interval, uint16_t timeoutCount)
EnableReceive(void)
void
启用通过此 WeaveConnection 接收的功能。
GetPeerAddressInfo(IPPacketInfo & addrInfo)
获取对等端的 IP 地址信息。
GetPeerDescription(char *buf, size_t bufSize) const
void
构造一个字符串,描述与连接关联的对等节点。
GetTCPEndPoint(void) const
TCPEndPoint *
IsIncoming(void) const
bool
LogId(void) const
uint16_t
Release(void)
void
减少 WeaveConnection 对象的引用计数。
ResetUserTimeout(void)
SendMessage(WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
通过已建立的连接发送 Weave 消息。
SendTunneledMessage(WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
通过 Weave 连接发送隧道数据包的函数。
SetConnectTimeout(const uint32_t connTimeoutMsecs)
void
为连接设置超时,以便连接成功或返回错误。
SetIdleTimeout(uint32_t timeoutMS)
设置底层网络层连接的空闲超时。
SetIncoming(bool val)
void
SetUserTimeout(uint32_t userTimeoutMillis)
Shutdown(void)
执行正常的 TCP 关闭,确保所有传出数据均由对等的 TCP 堆栈发送和接收。

公共类型

@58

 @58
属性
kGetPeerDescription_MaxLength

GetPeerDescription() 返回的字符串的最大长度(包括 NUL 字符)。

连接关闭方式

void(* ConnectionClosedFunct)(WeaveConnection *con, WEAVE_ERROR conErr)

此函数是在连接关闭时调用的应用回调。

详情
参数
[in] con
指向 WeaveConnection 对象的指针。
[in] conErr
连接关闭时 WEAVE_ERROR。

ConnectionCompleteFunct

void(* ConnectionCompleteFunct)(WeaveConnection *con, WEAVE_ERROR conErr)

该函数是连接设置完成后调用的应用回调。

详情
参数
[in] con
指向 WeaveConnection 对象的指针。
[in] conErr
设置过程中遇到 WEAVE_ERROR。

消息接收功能

void(* MessageReceiveFunct)(WeaveConnection *con, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)

此函数是通过 Weave 连接接收消息时调用的应用回调函数。

详情
参数
[in] con
指向 WeaveConnection 对象的指针。
[in] msgInfo
指向 WeaveMessageInfo 结构的指针,其中包含消息的相关信息。
[in] msgBuf
指向包含消息的 PacketBuffer 对象的指针。

NetworkType

 NetworkType

Weave 连接对象的网络类型。

属性
kNetworkType_BLE

BLE 网络类型。

kNetworkType_IP

TCP/IP 网络类型。

kNetworkType_Unassigned

未分配的网络类型。

接收错误功能

void(* ReceiveErrorFunct)(WeaveConnection *con, WEAVE_ERROR err)

此函数是在接收 Weave 消息时发生错误时调用的应用回调。

详情
参数
[in] con
指向 WeaveConnection 对象的指针。
[in] err
通过连接接收数据时遇到 WEAVE_ERROR。

状态

 State

Weave 连接对象的状态。

属性
kState_Closed

连接关闭时的状态。

kState_Connected

建立连接时的状态。

kState_Connecting

尝试连接时的状态。

kState_EstablishingSession

建立安全会话时的状态。

kState_ReadyToConnect

Weave 连接初始化后的状态。

kState_Resolving

执行 DNS 名称解析时的状态。

kState_SendShutdown

连接关闭时的状态。

隧道接收消息

void(* TunneledMsgReceiveFunct)(WeaveConnection *con, const WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)

此函数是通过 Weave 连接收到 Tunneled 数据包后调用的应用回调函数。

详情
参数
[in] con
指向 WeaveConnection 对象的指针。
[in] msgInfo
指向 WeaveMessageInfo 对象的指针。
[in] msgBuf
指向包含已接收隧道包的 PacketBuffer 对象的指针。

公共属性

应用状态

void * AppState

指向应用特定状态对象的指针。

身份验证模式

WeaveAuthMode AuthMode

[只读] 用于为连接建立默认加密密钥的身份验证模式。

默认加密类型

uint8_t DefaultEncryptionType

邮件的默认加密类型。

DefaultKeyId

uint16_t DefaultKeyId

发送消息时使用的默认加密密钥。

消息层

WeaveMessageLayer * MessageLayer

[只读] 关联的 WeaveMessageLayer 对象。

NetworkType

uint8_t NetworkType

[只读] 相关端点的网络类型。

连接关闭

ConnectionClosedFunct OnConnectionClosed

OnConnectionComplete

ConnectionCompleteFunct OnConnectionComplete

OnMessageReceived

MessageReceiveFunct OnMessageReceived

OnReceiveError

ReceiveErrorFunct OnReceiveError

OnTunneledMessageReceived

TunneledMsgReceiveFunct OnTunneledMessageReceived

点对点

IPAddress PeerAddr

[只读] 对等节点的 IP 地址。

对等节点 ID

uint64_t PeerNodeId

[只读] 对等方的节点标识符。

对等端口

uint16_t PeerPort

[只读] 对等节点的端口号。

ReceiveEnabled(已启用)

bool ReceiveEnabled

[只读] 如果启用接收,则为 true,否则为 false。

SendDestNodeId

bool SendDestNodeId

如果通过此连接发送的所有消息都必须包含经过明确编码的目标节点标识符,则为 true,否则为 false。

SendSourceNodeId

bool SendSourceNodeId

如果通过此连接发送的所有邮件都必须包含已明确编码的源节点标识符,则为 true;否则为 false。

状态

uint8_t State

[只读] WeaveConnection 对象的状态。

公共函数

取消

void Abort(
  void
)

对基于 TCP 或 BLE 的 WeaveConnection 执行优雅关闭,从而舍弃可能传入或传出对等端的所有数据。

调用 Abort() 会立即终止底层连接。在此之后,WeaveConnection 对象无法再用于进一步通信。

调用 Abort() 会减少与 WeaveConnection 对象相关联的引用计数,无论在调用该方法时是否连接处于打开/有效状态。如果这导致引用计数为零,则与连接对象关联的资源将会被释放。出现这种情况时,应用不得再与该对象进行交互。

另请参阅
Shutdown()Abort()AddRef()Release()

添加引用

void AddRef(
  void
)

预留对 WeaveConnection 对象的引用。

AddRef() 方法递增与 WeaveConnection 对象相关联的引用计数。每次调用 AddRef() 时,应用均需对 Release()Close()Abort() 进行相应的调用。

关闭

WEAVE_ERROR Close(
  void
)

对基于 TCP 或 BLE 的 WeaveConnection 执行非阻塞安全关闭,并在礼让地通知远程主机我们已重置连接之前提供所有剩余的传出数据。

此方法不能保证远程对等端已收到所有未在应用协议级别确认的外发消息。对于 TCP 和 BLE,底层协议堆栈会尽最大努力,在重置连接之前传送任何待处理的传出数据。对于 TCP,如果在关闭连接之前需要传输层消息接收确认,则应在 Close() 之前使用 Shutdown()。BLE 连接不提供对应的 Shutdown()

对于基于 BLE 的连接,Close() 会关闭 WeaveConnection 并立即返回,但可能会导致底层 BLEEndPoint 对象停留,直至所有传出数据均已发送。这是 Weave BleLayer 中现有的 Weave over BLE 传输协议实现的副作用。

调用 Close() 后,WeaveConnection 对象将无法再用于进一步通信。

调用 Close() 可减少与 WeaveConnection 对象相关联的引用计数,无论在调用该方法时是否处于“有效”/“有效”状态。如果这导致引用计数为零,则与连接对象关联的资源将会被释放。出现这种情况时,应用不得再与该对象进行交互。

详情
返回值
另请参阅
Shutdown()Abort()AddRef()Release()

关闭

WEAVE_ERROR Close(
  bool suppressCloseLog
)

对基于 TCP 或 BLE 的 WeaveConnection 执行非阻塞安全关闭,并在礼让地通知远程主机我们已重置连接之前提供所有剩余的传出数据。

此方法不能保证远程对等端已收到所有未在应用协议级别确认的外发消息。对于 TCP 和 BLE,底层协议堆栈会尽最大努力,在重置连接之前传送任何待处理的传出数据。对于 TCP,如果在关闭连接之前需要传输层消息接收确认,则应在 Close() 之前使用 Shutdown()。BLE 连接不提供对应的 Shutdown()

对于基于 BLE 的连接,Close() 会关闭 WeaveConnection 并立即返回,但可能会导致底层 BLEEndPoint 对象停留,直至所有传出数据均已发送。这是 Weave BleLayer 中现有的 Weave over BLE 传输协议实现的副作用。

调用 Close() 后,WeaveConnection 对象将无法再用于进一步通信。

调用 Close() 可减少与 WeaveConnection 对象相关联的引用计数,无论在调用该方法时是否处于“有效”/“有效”状态。如果这导致引用计数为零,则与连接对象关联的资源将会被释放。出现这种情况时,应用不得再与该对象进行交互。

详情
参数
[in] suppressCloseLog
如果需要抑制日志,则为 true;否则为 false。
返回值
另请参阅
Shutdown()Abort()AddRef()Release()

交流

WEAVE_ERROR Connect(
  uint64_t peerNodeId
)

使用从指定节点标识符派生的结构 IP 地址连接到 Weave 节点。

详情
参数
[in] peerNodeId
对等体的节点标识符。
返回值
WEAVE_NO_ERROR
成功建立与对等方的连接。
WEAVE_ERROR_INCORRECT_STATE
如果 WeaveConnection 状态不正确,则会发生该错误。
WEAVE_ERROR_UNSUPPORTED_AUTH_MODE
如果请求的身份验证模式不受支持,则会发生该错误。
WEAVE_ERROR_INVALID_ADDRESS
如果无法根据节点 ID 推断出目标地址。
other
TCPEndPoint 连接操作生成的 Inet 层错误。

交流

WEAVE_ERROR Connect(
  uint64_t peerNodeId,
  const IPAddress & peerAddr,
  uint16_t peerPort
)

使用节点标识符和/或 IP 地址连接到 Weave 节点。

详情
参数
[in] peerNodeId
对等体的节点标识符,kNodeIdNotSpecified 或 0(如果未知)。
[in] peerAddr
对等体的 IP 地址,如果未知,则为 IPAddress::Any
[in] peerPort
对等体的可选端口,默认为 WEAVE_PORT
返回值
WEAVE_NO_ERROR
成功建立与对等方的连接。
WEAVE_ERROR_INCORRECT_STATE
如果 WeaveConnection 状态不正确,则会发生该错误。
WEAVE_ERROR_UNSUPPORTED_AUTH_MODE
如果请求的身份验证模式不受支持,则会发生该错误。
WEAVE_ERROR_INVALID_ADDRESS
如果无法根据节点 ID 推断出目标地址。
other
TCPEndPoint 连接操作生成的 Inet 层错误。

交流

WEAVE_ERROR Connect(
  uint64_t peerNodeId,
  WeaveAuthMode authMode,
  const IPAddress & peerAddr,
  uint16_t peerPort,
  InterfaceId intf
)

在特定接口上使用节点标识符和/或 IP 地址连接到 Weave 节点。

详情
参数
[in] peerNodeId
对等体的节点标识符,kNodeIdNotSpecified 或 0(如果未知)。
[in] authMode
对等端所需的身份验证模式。仅支持 CASE、PASE 和未经身份验证的模式。
[in] peerAddr
对等体的 IP 地址,如果未知,则为 IPAddress::Any
[in] peerPort
对等体的可选端口,默认为 WEAVE_PORT
[in] intf
用于连接到对等节点的可选接口,默认为 INET_NULL_INTERFACEID
返回值
WEAVE_NO_ERROR
成功建立与对等方的连接。
WEAVE_ERROR_INCORRECT_STATE
如果 WeaveConnection 状态不正确,则会发生该错误。
WEAVE_ERROR_UNSUPPORTED_AUTH_MODE
如果请求的身份验证模式不受支持,则会发生该错误。
WEAVE_ERROR_INVALID_ADDRESS
如果无法根据节点标识符推导出目的地地址。
other
TCPEndPoint 连接操作生成的 Inet 层错误。

交流

WEAVE_ERROR Connect(
  uint64_t peerNodeId,
  WeaveAuthMode authMode,
  const char *peerAddr,
  uint16_t defaultPort
)

使用节点标识符和/或字符串主机名连接到 Weave 节点。

如果提供,PeerAddr 可以是以下任何一项:


:

:

[]:

详情
参数
[in] peerNodeId
对等体的节点标识符,kNodeIdNotSpecified 或 0(如果未知)。
[in] authMode
对等端所需的身份验证模式。仅支持 CASE、PASE 和未经身份验证的模式。
[in] peerAddr
对等体的地址或主机名,以 NULL 结尾的 C 字符串表示。
[in] defaultPort
如果未用于类似 PeerAddr 字符串,则用于连接的可选默认端口。
返回值
WEAVE_NO_ERROR
成功建立与对等方的连接。
WEAVE_ERROR_INCORRECT_STATE
如果 WeaveConnection 状态不正确,则会发生该错误。
WEAVE_ERROR_UNSUPPORTED_AUTH_MODE
如果请求的身份验证模式不受支持,则会发生该错误。
WEAVE_ERROR_INVALID_ADDRESS
如果无法根据节点 ID 推断出目标地址。
other
TCPEndPoint 连接操作生成的 Inet 层错误。

交流

WEAVE_ERROR Connect(
  uint64_t peerNodeId,
  WeaveAuthMode authMode,
  const char *peerAddr,
  uint16_t peerAddrLen,
  uint16_t defaultPort
)

使用节点标识符和/或字符串对等地址连接到 Weave 节点。

如果提供,PeerAddr 可以是以下任何一项:


:

:

[]:

详情
参数
[in] peerNodeId
对等体的节点标识符,kNodeIdNotSpecified 或 0(如果未知)。
[in] authMode
对等端所需的身份验证模式。仅支持 CASE、PASE 和未经身份验证的模式。
[in] peerAddr
对等方的地址或主机名(以非 NULL 终止的 C 字符串表示)。
[in] peerAddrLen
PeerAddr 字符串的长度。
[in] defaultPort
如果未用于类似 PeerAddr 字符串,则用于连接的可选默认端口。
返回值
WEAVE_NO_ERROR
成功建立与对等方的连接。
WEAVE_ERROR_INCORRECT_STATE
如果 WeaveConnection 状态不正确,则会发生该错误。
WEAVE_ERROR_UNSUPPORTED_AUTH_MODE
如果请求的身份验证模式不受支持,则会发生该错误。
WEAVE_ERROR_INVALID_ADDRESS
如果无法根据节点 ID 推断出目标地址。
other
TCPEndPoint 连接操作生成的 Inet 层错误。

交流

WEAVE_ERROR Connect(
  uint64_t peerNodeId,
  WeaveAuthMode authMode,
  const char *peerAddr,
  uint16_t peerAddrLen,
  uint8_t dnsOptions,
  uint16_t defaultPort
)

使用节点标识符和/或字符串对等地址连接到 Weave 节点。

如果提供,PeerAddr 可以是以下任何一项:


:

:

[]:

详情
参数
[in] peerNodeId
对等体的节点标识符,kNodeIdNotSpecified 或 0(如果未知)。
[in] authMode
对等端所需的身份验证模式。仅支持 CASE、PASE 和未经身份验证的模式。
[in] peerAddr
对等方的地址或主机名(以非 NULL 终止的 C 字符串表示)。
[in] peerAddrLen
PeerAddr 字符串的长度。
[in] dnsOptions
一个整数值,用于控制主机名解析的执行方式。值应为 #::nl::Inet::DNSOptions 枚举中的一个或多个值的 OR。
[in] defaultPort
如果未用于类似 PeerAddr 字符串,则用于连接的可选默认端口。
返回值
WEAVE_NO_ERROR
成功建立与对等方的连接。
WEAVE_ERROR_INCORRECT_STATE
如果 WeaveConnection 状态不正确,则会发生该错误。
WEAVE_ERROR_UNSUPPORTED_AUTH_MODE
如果请求的身份验证模式不受支持,则会发生该错误。
WEAVE_ERROR_INVALID_ADDRESS
如果无法根据节点 ID 推断出目标地址。
other
TCPEndPoint 连接操作生成的 Inet 层错误。

交流

WEAVE_ERROR Connect(
  uint64_t peerNodeId,
  WeaveAuthMode authMode,
  HostPortList hostPortList,
  InterfaceId intf
)

使用节点标识符和/或主机名和端口列表连接到 Weave 节点。

详情
参数
[in] peerNodeId
对等体的节点标识符。
[in] authMode
用于连接的身份验证模式。
[in] hostPortList
主机名和端口列表。
[in] intf
用于连接到对等节点的可选接口,默认为 INET_NULL_INTERFACEID
返回值
WEAVE_NO_ERROR
成功建立与对等方的连接。
WEAVE_ERROR_INCORRECT_STATE
如果 WeaveConnection 状态不正确,则会发生该错误。
WEAVE_ERROR_UNSUPPORTED_AUTH_MODE
如果请求的身份验证模式不受支持,则会发生该错误。
WEAVE_ERROR_INVALID_ADDRESS
如果无法根据节点 ID 推断出目标地址。
other
TCPEndPoint 连接操作生成的 Inet 层错误。

交流

WEAVE_ERROR Connect(
  uint64_t peerNodeId,
  WeaveAuthMode authMode,
  HostPortList hostPortList,
  uint8_t dnsOptions,
  InterfaceId intf
)

使用节点标识符和/或主机名和端口列表连接到 Weave 节点。

详情
参数
[in] peerNodeId
对等体的节点标识符。
[in] authMode
用于连接的身份验证模式。
[in] hostPortList
主机名和端口列表。
[in] dnsOptions
一个整数值,用于控制主机名解析的执行方式。值应为 #::nl::Inet::DNSOptions 枚举中的一个或多个值的 OR。
[in] intf
用于连接到对等节点的可选接口,默认为 INET_NULL_INTERFACEID
返回值
WEAVE_NO_ERROR
成功建立与对等方的连接。
WEAVE_ERROR_INCORRECT_STATE
如果 WeaveConnection 状态不正确,则会发生该错误。
WEAVE_ERROR_UNSUPPORTED_AUTH_MODE
如果请求的身份验证模式不受支持,则会发生该错误。
WEAVE_ERROR_INVALID_ADDRESS
如果无法根据节点 ID 推断出目标地址。
other
TCPEndPoint 连接操作生成的 Inet 层错误。

停用 KeepAlive

WEAVE_ERROR DisableKeepAlive(
  void
)

WeaveConnection::DisableKeepAlive

对底层 TCP 连接停用 TCP keepalive 探测。

注意:此方法只能在由 TCP 连接支持的 Weave 连接上调用。只有当连接的状态允许发送时,才能调用此方法。

如果连接上未启用 keepalive,则此方法不会执行任何操作。

详情
返回值
WEAVE_NO_ERROR
成功停用对连接的 TCP keepalive 探测。
WEAVE_ERROR_NOT_IMPLEMENTED
如果针对不兼容的端点(例如BLE)。
WEAVE_ERROR_INCORRECT_STATE
如果 WeaveConnection 对象未处于发送消息的正确状态。
other
与 TCP 端点相关的 Inet 层错误会启用 keepalive 操作。

停用接收

void DisableReceive(
  void
)

禁止通过此 WeaveConnection 接收邮件。

应用使用此方法表示它尚未准备好通过 TCP 连接接收任何到达数据。要重新启用接收功能,应用需要调用 EnableReceive(),以便通过调用适当的回调允许 WeaveConnection 移交所收到的数据。

另请参阅
EnableReceive()

启用 KeepAlive

WEAVE_ERROR EnableKeepAlive(
  uint16_t interval,
  uint16_t timeoutCount
)

WeaveConnection::EnableKeepAlive

在底层 TCP 连接上启用 TCP keepalive 探测。

注意:此方法只能在由 TCP 连接支持的 Weave 连接上调用。- 只有当连接的状态允许发送时,才能调用此方法。

详情
参数
[in] interval
keepalive 探测之间的时间间隔(以秒为单位)。此值还可控制上次发送数据包与第一个 keepalive 探测的传输之间间隔的时间。
[in] timeoutCount
确认未连接的探测次数上限。

- 可多次调用该方法,以调整 keepalive 的时间间隔或超时计数。

详情
返回值
WEAVE_NO_ERROR
成功在连接上启用 TCP keepalive 探测。
WEAVE_ERROR_NOT_IMPLEMENTED
如果针对不兼容的端点(例如BLE)。
WEAVE_ERROR_INCORRECT_STATE
如果 WeaveConnection 对象未处于发送消息的正确状态。
other
与 TCP 端点相关的 Inet 层错误会启用 keepalive 操作。

启用接收

void EnableReceive(
  void
)

启用通过此 WeaveConnection 接收的功能。

应用使用此方法向 WeaveConnection 对象指明它已准备好接收任何通过 TCP 连接到达的数据。

另请参阅
DisableReceive()

GetPeerAddressInfo

WEAVE_ERROR GetPeerAddressInfo(
  IPPacketInfo & addrInfo
)

获取对等端的 IP 地址信息。

详情
参数
[out] addrInfo
对 IPPacketInfo 对象的引用。
返回值
WEAVE_NO_ERROR
成功时。
WEAVE_ERROR_NOT_IMPLEMENTED
如果为不兼容的端点(例如BLE)。

GetPeerDescription

void GetPeerDescription(
  char *buf,
  size_t bufSize
) const 

构造一个字符串,描述与连接关联的对等节点。

详情
参数
[in] buf
指向应该写入字符串的缓冲区的指针。提供的缓冲区不得小于 kGetPeerDescription_MaxLength。如果给定较小的缓冲区,则字符串将被截断以适应窗口大小。在所有情况下,输出都将包含一个 NUL 终止字符。
[in] bufSize
buf 所指向的缓冲区大小。

获取 TCPEndPoint

TCPEndPoint * GetTCPEndPoint(
  void
) const 

传入

bool IsIncoming(
  void
) const 

日志 ID

uint16_t LogId(
  void
) const 

版本

void Release(
  void
)

减少 WeaveConnection 对象的引用计数。

Release() 方法可减少与 WeaveConnection 对象相关联的引用计数。如果这导致引用计数为零,则连接将关闭并释放连接对象。出现这种情况时,应用不得再与该对象进行交互。

重置用户超时

WEAVE_ERROR ResetUserTimeout(
  void
)

WeaveConnection::ResetUserTimeout

将 TCP 用户超时套接字选项重置为系统默认设置。

注意:此方法只能在由 TCP 连接支持的 Weave 连接上调用。- 只有当连接的状态允许发送时,才能调用此方法。

- 如果没有在连接上设置用户超时,则此方法将不执行任何操作。

详情
返回值
WEAVE_NO_ERROR
成功重置连接的 TCP 用户超时时触发。
WEAVE_ERROR_NOT_IMPLEMENTED
如果针对不兼容的端点(例如BLE)。
WEAVE_ERROR_INCORRECT_STATE
如果 WeaveConnection 对象未处于发送消息的正确状态。
other
与 TCP 端点重置 TCP 用户超时相关的 Inet 层错误。

发送消息

WEAVE_ERROR SendMessage(
  WeaveMessageInfo *msgInfo,
  PacketBuffer *msgBuf
)

通过已建立的连接发送 Weave 消息。

详情
参数
[in] msgInfo
指向 WeaveMessageInfo 对象的指针。
[in] msgBuf
指向包含要发送的数据包的 PacketBuffer 对象的指针。
返回值
WEAVE_NO_ERROR
成功下达网络层。
WEAVE_ERROR_INCORRECT_STATE
如果 WeaveConnection 对象未处于发送消息的正确状态。
WEAVE_ERROR_INVALID_DESTINATION_NODE_ID
未指定目标节点标识符。
WEAVE_ERROR_SENDING_BLOCKED
如果邮件过长,无法发送。
other
与特定端点发送操作相关的 Inet 层错误。

SendTunneledMessage

WEAVE_ERROR SendTunneledMessage(
  WeaveMessageInfo *msgInfo,
  PacketBuffer *msgBuf
)

通过 Weave 连接发送隧道数据包的函数。

通过已建立的连接发送隧道式 Weave 消息。

详情
参数
[in] msgInfo
指向 WeaveMessageInfo 对象的指针。
[in] msgBuf
指向包含要发送的数据包的 PacketBuffer 对象的指针。
返回值
WEAVE_NO_ERROR
成功下达网络层。
WEAVE_ERROR_INCORRECT_STATE
如果 WeaveConnection 对象未处于发送消息的正确状态。
WEAVE_ERROR_INVALID_DESTINATION_NODE_ID
未指定目标节点标识符。
WEAVE_ERROR_SENDING_BLOCKED
如果邮件过长,无法发送。
other
与特定端点发送操作相关的 Inet 层错误。

SetConnectTimeout

void SetConnectTimeout(
  const uint32_t connTimeoutMsecs
)

为连接设置超时,以便连接成功或返回错误。

详情
参数
[in] connTimeoutMsecs

SetIdleTimeout

WEAVE_ERROR SetIdleTimeout(
  uint32_t timeoutMS
)

设置底层网络层连接的空闲超时。

详情
参数
[in] timeoutMS
超时(以毫秒为单位)。
返回值
WEAVE_NO_ERROR
成功设置连接的空闲超时时触发。
WEAVE_ERROR_INCORRECT_STATE
如果 WeaveConnection 对象未处于接收消息的正确状态。

设置传入项

void SetIncoming(
  bool val
)

SetUserTimeout

WEAVE_ERROR SetUserTimeout(
  uint32_t userTimeoutMillis
)

WeaveConnection::SetUserTimeout

设置 TCP 用户超时套接字选项。

当值大于 0 时,可指定在 TCP 强制关闭相应连接之前,传输的数据可能未经确认的最长时间(以毫秒为单位)。如果将选项值指定为 0,TCP 将使用系统默认值。如需了解更多详情,请参阅 RFC 5482。

详情
参数
[in] userTimeoutMillis
TCP 用户超时值(以毫秒为单位)。

注意:此方法只能在由 TCP 连接支持的 Weave 连接上调用。- 只有当连接的状态允许发送时,才能调用此方法。

- 可多次调用此方法来调整 TCP 用户超时。

详情
返回值
WEAVE_NO_ERROR
成功设置连接的 TCP 用户超时。
WEAVE_ERROR_NOT_IMPLEMENTED
如果针对不兼容的端点(例如BLE)。
WEAVE_ERROR_INCORRECT_STATE
如果 WeaveConnection 对象未处于发送消息的正确状态。
other
与 TCP 用户超时的 TCP 端点设置相关的 Inet 层错误。

关机

WEAVE_ERROR Shutdown(
  void
)

执行正常的 TCP 关闭,确保所有传出数据均由对等的 TCP 堆栈发送和接收。

对于大多数(但不是全部)TCP 实现,发送关闭操作都会导致远程主机也关闭自己一端的连接,导致连接关闭。后续调用 Close() 会终止 WeaveConnection

详情
返回值
WEAVE_NO_ERROR
成功关闭 tcp 连接后。
WEAVE_ERROR_NOT_IMPLEMENTED
如果针对不兼容的端点(例如BLE)。
WEAVE_ERROR_INCORRECT_STATE
如果 WeaveConnection 对象在开始关停之前未处于正确的状态,则会发生该错误。
other
与特定端点关闭操作相关的 Inet 层错误。
另请参阅
Close()Abort()