nl:: Weave:: WeaveConnection
#include <src/lib/core/WeaveMessageLayer.h>
A definição da classe Weave Connection.
Resumo
Ele representa uma conexão TCP ou BLE com outro nó do Weave.
Tipos públicos |
|
---|---|
@58{
|
tipo enumerado |
ConnectionClosedFunct)(WeaveConnection *con, WEAVE_ERROR conErr)
|
typedefvoid(*
Essa função é o callback do aplicativo que é invocado quando uma conexão é fechada. |
ConnectionCompleteFunct)(WeaveConnection *con, WEAVE_ERROR conErr)
|
typedefvoid(*
Essa função é o callback do aplicativo invocado quando a configuração da conexão é concluída. |
MessageReceiveFunct)(WeaveConnection *con, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
|
typedefvoid(*
Essa função é o callback do aplicativo que é invocado quando uma mensagem é recebida por uma conexão do Weave. |
NetworkType{
|
tipo enumerado O tipo de rede do objeto de conexão do Weave. |
ReceiveErrorFunct)(WeaveConnection *con, WEAVE_ERROR err)
|
typedefvoid(*
Essa função é o callback do aplicativo invocado ao encontrar um erro ao receber uma mensagem do Weave. |
State{
|
tipo enumerado O estado do objeto de conexão do Weave. |
TunneledMsgReceiveFunct)(WeaveConnection *con, const WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
|
typedefvoid(*
Essa função é o callback do aplicativo invocado depois do recebimento de um pacote de dados encapsulado pela conexão do Weave. |
Atributos públicos |
|
---|---|
AppState
|
void *
Um ponteiro para o objeto de estado específico do aplicativo.
|
AuthMode
|
WeaveAuthMode
[SOMENTE LEITURA] O modo de autenticação usado para estabelecer as chaves de criptografia padrão para a conexão.
|
DefaultEncryptionType
|
uint8_t
O tipo de criptografia padrão de mensagens.
|
DefaultKeyId
|
uint16_t
A chave de criptografia padrão a ser usada ao enviar mensagens.
|
MessageLayer
|
[SOMENTE LEITURA] O objeto WeaveMessageLayer associado.
|
NetworkType
|
uint8_t
[SOMENTE LEITURA] O tipo de rede do endpoint final associado.
|
OnConnectionClosed
|
|
OnConnectionComplete
|
|
OnMessageReceived
|
|
OnReceiveError
|
|
OnTunneledMessageReceived
|
|
PeerAddr
|
IPAddress
[SOMENTE LEITURA] O endereço IP do nó de peering.
|
PeerNodeId
|
uint64_t
[SOMENTE LEITURA] O identificador de nó do peering.
|
PeerPort
|
uint16_t
[SOMENTE LEITURA] O número da porta do nó de peering.
|
ReceiveEnabled
|
bool
[SOMENTE Leitura] Verdadeiro se o recebimento estiver ativado. Caso contrário, é falso.
|
SendDestNodeId
|
bool
Verdadeiro se todas as mensagens enviadas por essa conexão precisarem incluir um identificador de nó de destino explicitamente codificado. Caso contrário, será falso.
|
SendSourceNodeId
|
bool
Verdadeiro se todas as mensagens enviadas por essa conexão precisarem incluir um identificador de nó de origem codificado explicitamente. Caso contrário, será falso.
|
State
|
uint8_t
[SOMENTE LEITURA] O estado do objeto WeaveConnection.
|
Funções públicas |
|
---|---|
Abort(void)
|
void
Realiza um fechamento suave do WeaveConnection baseado em TCP ou BLE, descartando qualquer dado que esteja no período de voo de ou para o peering.
|
AddRef(void)
|
void
Reserve uma referência ao objeto WeaveConnection.
|
Close(void)
|
Realiza um fechamento suave sem bloqueio do WeaveConnection baseado em TCP ou BLE, entregando todos os dados de saída restantes antes de informar educadamente ao host remoto que redefinimos a conexão.
|
Close(bool suppressCloseLog)
|
Realiza um fechamento suave sem bloqueio do WeaveConnection baseado em TCP ou BLE, entregando todos os dados de saída restantes antes de informar educadamente ao host remoto que redefinimos a conexão.
|
Connect(uint64_t peerNodeId)
|
Conectar a um nó do Weave usando um endereço IP do Fabric derivado do identificador de nós especificado.
|
Connect(uint64_t peerNodeId, const IPAddress & peerAddr, uint16_t peerPort)
|
Conecte-se a um nó do Weave usando um identificador de nós e/ou um endereço IP.
|
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, const IPAddress & peerAddr, uint16_t peerPort, InterfaceId intf)
|
Conectar a um nó do Weave usando um identificador de nós e/ou um endereço IP em uma interface específica.
|
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t defaultPort)
|
Conecte-se a um nó do Weave usando um identificador de nós e/ou um nome de host de string.
|
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t peerAddrLen, uint16_t defaultPort)
|
Conecte-se a um nó do Weave usando um identificador de nós e/ou um endereço de peering de string.
|
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t peerAddrLen, uint8_t dnsOptions, uint16_t defaultPort)
|
Conecte-se a um nó do Weave usando um identificador de nós e/ou um endereço de peering de string.
|
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, HostPortList hostPortList, InterfaceId intf)
|
Conecte-se a um nó do Weave usando um identificador de nós e/ou uma lista de nomes do host e portas.
|
Connect(uint64_t peerNodeId, WeaveAuthMode authMode, HostPortList hostPortList, uint8_t dnsOptions, InterfaceId intf)
|
Conecte-se a um nó do Weave usando um identificador de nós e/ou uma lista de nomes do host e portas.
|
DisableKeepAlive(void)
|
|
DisableReceive(void)
|
void
Desative o recebimento por meio dessa WeaveConnection.
|
EnableKeepAlive(uint16_t interval, uint16_t timeoutCount)
|
|
EnableReceive(void)
|
void
Ative o recebimento por meio desta WeaveConnection.
|
GetPeerAddressInfo(IPPacketInfo & addrInfo)
|
Consiga as informações de endereço IP do peering.
|
GetPeerDescription(char *buf, size_t bufSize) const
|
void
Cria uma string que descreve o nó de peering associado à conexão.
|
GetTCPEndPoint(void) const
|
TCPEndPoint *
|
IsIncoming(void) const
|
bool
|
LogId(void) const
|
uint16_t
|
Release(void)
|
void
Reduzir a contagem de referência no objeto WeaveConnection.
|
ResetUserTimeout(void)
|
|
SendMessage(WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
|
Envie uma mensagem do Weave por uma conexão estabelecida.
|
SendTunneledMessage(WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
|
Função para enviar um pacote encapsulado por uma conexão Weave.
|
SetConnectTimeout(const uint32_t connTimeoutMsecs)
|
void
Defina o tempo limite de conclusão da conexão ou retorne um erro.
|
SetIdleTimeout(uint32_t timeoutMS)
|
Defina o tempo limite de inatividade na conexão da camada de rede subjacente.
|
SetIncoming(bool val)
|
void
|
SetUserTimeout(uint32_t userTimeoutMillis)
|
|
Shutdown(void)
|
Realiza um encerramento elegante de TCP, garantindo que todos os dados de saída tenham sido enviados e recebidos pela pilha TCP de peering.
|
Tipos públicos
58
@58
Propriedades | |
---|---|
kGetPeerDescription_MaxLength
|
Tamanho máximo da string (incluindo o caractere NUL) retornado por GetPeerDescription(). |
ConnectionClosedFunct
void(* ConnectionClosedFunct)(WeaveConnection *con, WEAVE_ERROR conErr)
Essa função é o callback do aplicativo que é invocado quando uma conexão é fechada.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
ConnectionCompleteFunct
void(* ConnectionCompleteFunct)(WeaveConnection *con, WEAVE_ERROR conErr)
Essa função é o callback do aplicativo invocado quando a configuração da conexão é concluída.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
MessageReceiveFunct
void(* MessageReceiveFunct)(WeaveConnection *con, WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Essa função é o callback do aplicativo que é invocado quando uma mensagem é recebida por uma conexão do Weave.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
NetworkType
NetworkType
O tipo de rede do objeto de conexão do Weave.
Propriedades | |
---|---|
kNetworkType_BLE
|
Tipo de rede BLE. |
kNetworkType_IP
|
Tipo de rede TCP/IP. |
kNetworkType_Unassigned
|
Tipo de rede não atribuído. |
FunErrorFunct
void(* ReceiveErrorFunct)(WeaveConnection *con, WEAVE_ERROR err)
Essa função é o callback do aplicativo invocado ao encontrar um erro ao receber uma mensagem do Weave.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
Estado
State
O estado do objeto de conexão do Weave.
Propriedades | |
---|---|
kState_Closed
|
Indica quando a conexão é encerrada. |
kState_Connected
|
Estado quando a conexão é estabelecida. |
kState_Connecting
|
Estado quando há uma tentativa de conexão. |
kState_EstablishingSession
|
Indique quando uma sessão segura está sendo estabelecida. |
kState_ReadyToConnect
|
Estado após a inicialização da conexão do Weave. |
kState_Resolving
|
Status quando a resolução de nome DNS está sendo realizada. |
kState_SendShutdown
|
Estado quando a conexão está sendo encerrada. |
TunneledMsgReceiveFunct
void(* TunneledMsgReceiveFunct)(WeaveConnection *con, const WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf)
Essa função é o callback do aplicativo invocado depois do recebimento de um pacote de dados encapsulado pela conexão do Weave.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
Atributos públicos
Estado do app
void * AppState
Um ponteiro para o objeto de estado específico do aplicativo.
Modo Auth
WeaveAuthMode AuthMode
[SOMENTE LEITURA] O modo de autenticação usado para estabelecer as chaves de criptografia padrão para a conexão.
Tipo de criptografia padrão
uint8_t DefaultEncryptionType
O tipo de criptografia padrão de mensagens.
Código da chave padrão
uint16_t DefaultKeyId
A chave de criptografia padrão a ser usada ao enviar mensagens.
MessageLayer
WeaveMessageLayer * MessageLayer
[SOMENTE LEITURA] O objeto WeaveMessageLayer associado.
NetworkType
uint8_t NetworkType
[SOMENTE LEITURA] O tipo de rede do endpoint final associado.
OnConnectionClosed
ConnectionClosedFunct OnConnectionClosed
OnConnectionComplete
ConnectionCompleteFunct OnConnectionComplete
OnMessageReceived
MessageReceiveFunct OnMessageReceived
OnReceiveError
ReceiveErrorFunct OnReceiveError
OnTunneledMessageReceived
TunneledMsgReceiveFunct OnTunneledMessageReceived
Peering
IPAddress PeerAddr
[SOMENTE LEITURA] O endereço IP do nó de peering.
PeeringNodeId
uint64_t PeerNodeId
[SOMENTE LEITURA] O identificador de nó do peering.
Porta de peering
uint16_t PeerPort
[SOMENTE LEITURA] O número da porta do nó de peering.
ReceiveEnabled
bool ReceiveEnabled
[SOMENTE Leitura] Verdadeiro se o recebimento estiver ativado. Caso contrário, é falso.
EnviarDestNodeId
bool SendDestNodeId
Verdadeiro se todas as mensagens enviadas por essa conexão precisarem incluir um identificador de nó de destino explicitamente codificado. Caso contrário, será falso.
EnviarSourceNodeId
bool SendSourceNodeId
Verdadeiro se todas as mensagens enviadas por essa conexão precisarem incluir um identificador de nó de origem codificado explicitamente. Caso contrário, será falso.
Funções públicas
Cancelar
void Abort( void )
Realiza um fechamento suave do WeaveConnection baseado em TCP ou BLE, descartando qualquer dado que esteja no período de voo de ou para o peering.
Uma chamada para Abort() encerra imediatamente a conexão subjacente. Depois disso, o objeto WeaveConnection não pode mais ser usado para comunicação adicional.
Chamar Abort() reduz a contagem de referência associada ao objeto WeaveConnection, independentemente de a conexão estar aberta ou ativa no momento em que o método é chamado. Se isso fizer com que a contagem de referência chegue a zero, os recursos associados ao objeto de conexão serão liberados. Quando isso acontece, o aplicativo não pode ter mais interações com o objeto.
Veja também:Shutdown(), Abort(), AddRef() e Release().
Adicionar referência
void AddRef( void )
Reserve uma referência ao objeto WeaveConnection.
O método AddRef() incrementa a contagem de referências associada ao objeto WeaveConnection. Para cada chamada para AddRef(), o aplicativo é responsável por fazer uma chamada correspondente para Release(), Close() ou Abort().
Fechar
WEAVE_ERROR Close( void )
Realiza um fechamento suave sem bloqueio do WeaveConnection baseado em TCP ou BLE, entregando todos os dados de saída restantes antes de informar educadamente ao host remoto que redefinimos a conexão.
Esse método não garante que todas as mensagens enviadas não confirmadas no nível de protocolo do aplicativo sejam recebidas por peering remoto. Para TCP e BLE, a pilha de protocolo subjacente fará o possível para entregar todos os dados de saída pendentes antes de redefinir a conexão. Para TCP, Shutdown() deve ser usado antes de Close() se uma confirmação de confirmação de mensagem de camada de transporte for necessária antes de fechar a conexão. As conexões BLE não fornecem equivalente de Shutdown().
Para conexões baseadas em BLE, Close() fecha o WeaveConnection e retorna imediatamente, mas pode causar a retenção do objeto BLEEndPoint subjacente até que todos os dados de saída sejam enviados. Esse é um efeito colateral da implementação do protocolo de transporte Weave over BLE existente na BleLayer do Weave.
Depois que Close() for chamado, o objeto WeaveConnection não poderá mais ser usado para comunicação adicional.
Chamar Close() reduz a contagem de referência associada ao objeto WeaveConnection, independentemente de a conexão estar aberta ou ativa no momento em que o método é chamado. Se isso fizer com que a contagem de referência chegue a zero, os recursos associados ao objeto de conexão serão liberados. Quando isso acontece, o aplicativo não pode ter mais interações com o objeto.
Detalhes | |
---|---|
Retorna |
WEAVE_NO_ERROR incondicional.
|
Shutdown(), Abort(), AddRef() e Release().
Fechar
WEAVE_ERROR Close( bool suppressCloseLog )
Realiza um fechamento suave sem bloqueio do WeaveConnection baseado em TCP ou BLE, entregando todos os dados de saída restantes antes de informar educadamente ao host remoto que redefinimos a conexão.
Esse método não garante que todas as mensagens enviadas não confirmadas no nível de protocolo do aplicativo sejam recebidas por peering remoto. Para TCP e BLE, a pilha de protocolo subjacente fará o possível para entregar todos os dados de saída pendentes antes de redefinir a conexão. Para TCP, Shutdown() deve ser usado antes de Close() se uma confirmação de confirmação de mensagem de camada de transporte for necessária antes de fechar a conexão. As conexões BLE não fornecem equivalente de Shutdown().
Para conexões baseadas em BLE, Close() fecha o WeaveConnection e retorna imediatamente, mas pode causar a retenção do objeto BLEEndPoint subjacente até que todos os dados de saída sejam enviados. Esse é um efeito colateral da implementação do protocolo de transporte Weave over BLE existente na BleLayer do Weave.
Depois que Close() for chamado, o objeto WeaveConnection não poderá mais ser usado para comunicação adicional.
Chamar Close() reduz a contagem de referência associada ao objeto WeaveConnection, independentemente de a conexão estar aberta ou ativa no momento em que o método é chamado. Se isso fizer com que a contagem de referência chegue a zero, os recursos associados ao objeto de conexão serão liberados. Quando isso acontece, o aplicativo não pode ter mais interações com o objeto.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Retorna |
WEAVE_NO_ERROR incondicional.
|
Shutdown(), Abort(), AddRef() e Release().
Connect
WEAVE_ERROR Connect( uint64_t peerNodeId )
Conectar a um nó do Weave usando um endereço IP do Fabric derivado do identificador de nós especificado.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||
Valores de retorno |
|
Connect
WEAVE_ERROR Connect( uint64_t peerNodeId, const IPAddress & peerAddr, uint16_t peerPort )
Conecte-se a um nó do Weave usando um identificador de nós e/ou um endereço IP.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||
Valores de retorno |
|
Connect
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, const IPAddress & peerAddr, uint16_t peerPort, InterfaceId intf )
Conectar a um nó do Weave usando um identificador de nós e/ou um endereço IP em uma interface específica.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||
Valores de retorno |
|
Connect
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t defaultPort )
Conecte-se a um nó do Weave usando um identificador de nós e/ou um nome de host de string.
Se fornecido, o peerAddr pode ser:
: : [ ]:
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||
Valores de retorno |
|
Connect
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t peerAddrLen, uint16_t defaultPort )
Conecte-se a um nó do Weave usando um identificador de nós e/ou um endereço de peering de string.
Se fornecido, o peerAddr pode ser:
: : [ ]:
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||
Valores de retorno |
|
Connect
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, const char *peerAddr, uint16_t peerAddrLen, uint8_t dnsOptions, uint16_t defaultPort )
Conecte-se a um nó do Weave usando um identificador de nós e/ou um endereço de peering de string.
Se fornecido, o peerAddr pode ser:
: : [ ]:
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
Connect
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, HostPortList hostPortList, InterfaceId intf )
Conecte-se a um nó do Weave usando um identificador de nós e/ou uma lista de nomes do host e portas.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||
Valores de retorno |
|
Connect
WEAVE_ERROR Connect( uint64_t peerNodeId, WeaveAuthMode authMode, HostPortList hostPortList, uint8_t dnsOptions, InterfaceId intf )
Conecte-se a um nó do Weave usando um identificador de nós e/ou uma lista de nomes do host e portas.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||
Valores de retorno |
|
Desativar KeepAlive
WEAVE_ERROR DisableKeepAlive( void )
WeaveConnection::DisableKeepAlive
Desativar sondagens de sinal de atividade TCP na conexão TCP subjacente.
Observação:esse método só pode ser chamado em uma conexão Weave apoiada por uma conexão TCP. Esse método só pode ser chamado quando a conexão estiver em um estado que permite o envio.
Esse método não terá efeito se os sinais de atividade não estiverem ativados na conexão.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Valores de retorno |
|
Desativar recebimento
void DisableReceive( void )
Desative o recebimento por meio dessa WeaveConnection.
Esse método é usado pelo aplicativo para indicar que ele não está pronto para receber dados recebidos pela conexão TCP. Para reativar o recebimento, o aplicativo precisa chamar EnableReceive() para permitir que WeaveConnection entregue os dados recebidos invocando os callbacks adequados.
Veja também:EnableReceive()
Ativar KeepAlive
WEAVE_ERROR EnableKeepAlive( uint16_t interval, uint16_t timeoutCount )
WeaveConnection::EnableKeepAlive
Ativar sondagens de sinal de atividade TCP na conexão TCP subjacente.
Observação:esse método só pode ser chamado em uma conexão Weave apoiada por uma conexão TCP. - Esse método só pode ser chamado quando a conexão está em um estado que permite o envio.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
- Esse método pode ser chamado várias vezes para ajustar o intervalo de sinal de atividade ou a contagem de tempo limite.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Valores de retorno |
|
Ativar recebimento
void EnableReceive( void )
Ative o recebimento por meio desta WeaveConnection.
Esse método é usado pelo aplicativo para indicar ao objeto WeaveConnection que ele está pronto para receber qualquer dado que chegar pela conexão TCP.
Veja também:DisableReceive()
GetPeerAddressInfo
WEAVE_ERROR GetPeerAddressInfo( IPPacketInfo & addrInfo )
Consiga as informações de endereço IP do peering.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
GetPeerDescription
void GetPeerDescription( char *buf, size_t bufSize ) const
Cria uma string que descreve o nó de peering associado à conexão.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
GetPointEndPoint
TCPEndPoint * GetTCPEndPoint( void ) const
Recebido
bool IsIncoming( void ) const
Código do registro
uint16_t LogId( void ) const
Versão
void Release( void )
Reduzir a contagem de referência no objeto WeaveConnection.
O método Release() diminui a contagem de referência associada ao objeto WeaveConnection. Se isso fizer com que a contagem de referência chegue a zero, a conexão será encerrada e o objeto de conexão será liberado. Quando isso acontece, o aplicativo não pode ter mais interações com o objeto.
Redefinir UserTimeout
WEAVE_ERROR ResetUserTimeout( void )
WeaveConnection::ResetUserTimeout.
Redefinir a opção de soquete do tempo limite do usuário TCP para o padrão do sistema.
Observação: esse método só pode ser chamado em uma conexão Weave apoiada por uma conexão TCP. - Esse método só pode ser chamado quando a conexão está em um estado que permite o envio.
- Esse método não faz nada se o tempo limite do usuário não tiver sido definido na conexão.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Valores de retorno |
|
Mensagem de envio
WEAVE_ERROR SendMessage( WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Envie uma mensagem do Weave por uma conexão estabelecida.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||
Valores de retorno |
|
Enviar túnel enviado
WEAVE_ERROR SendTunneledMessage( WeaveMessageInfo *msgInfo, PacketBuffer *msgBuf )
Função para enviar um pacote encapsulado por uma conexão Weave.
Envie uma mensagem do Weave em um túnel por uma conexão estabelecida.
Detalhes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||
Valores de retorno |
|
SetConnectTimeout
void SetConnectTimeout( const uint32_t connTimeoutMsecs )
Defina o tempo limite de conclusão da conexão ou retorne um erro.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
Definir o tempo limite
WEAVE_ERROR SetIdleTimeout( uint32_t timeoutMS )
Defina o tempo limite de inatividade na conexão da camada de rede subjacente.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
Definirrecebimento
void SetIncoming( bool val )
Definir o tempo limite do usuário
WEAVE_ERROR SetUserTimeout( uint32_t userTimeoutMillis )
WeaveConnection::SetUserTimeout.
Define a opção de soquete do tempo limite do usuário TCP.
Quando o valor é maior que 0, ele especifica o tempo máximo em milissegundos que os dados transmitidos podem permanecer não reconhecidos antes que o TCP feche à conexão correspondente. Se o valor da opção for especificado como 0, o TCP usará o padrão do sistema. Consulte o RFC 5482 para mais detalhes.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
Observação: esse método só pode ser chamado em uma conexão Weave apoiada por uma conexão TCP. - Esse método só pode ser chamado quando a conexão está em um estado que permite o envio.
- Esse método pode ser chamado várias vezes para ajustar o tempo limite do usuário de TCP.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Valores de retorno |
|
Desligamento
WEAVE_ERROR Shutdown( void )
Realiza um encerramento elegante de TCP, garantindo que todos os dados de saída tenham sido enviados e recebidos pela pilha TCP de peering.
Na maioria das implementações (mas não de todas) do TCP, o recebimento de um encerramento de envio fará com que o host remoto também encerre o lado da conexão, resultando em um encerramento de conexão. Uma chamada subsequente para Close() encerraria a WeaveConnection.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Valores de retorno |
|
Close() e Abort().