nl :: Tecer:: Obrigatório:: Configuração

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

Fornece uma interface de estilo declarativo para configurar e preparar um objeto Binding .

Resumo

Ao configurar um Binding , os aplicativos devem chamar pelo menos um método de cada um dos seguintes grupos de configuração: Destino, Transporte e Segurança. Outros métodos podem ser chamados conforme necessário para substituir o comportamento padrão.

Se configurações mutuamente exclusivas são chamadas (por exemplo, Transport_TCP () seguido por Transport_UDP () ), o último a ser chamado vence.

Funções públicas
`ConfigureFromMessage (const WeaveMessageInfo aMsgInfo, const Inet::IPPacketInfo aPacketInfo)`	`Configuration &` Configure a ligação para permitir a comunicação com o remetente de uma mensagem recebida.
`DNS_Options (uint8_t dnsOptions)`	`Configuration &` Ao resolver o nome do host do par, use as opções de DNS especificadas.
`Exchange_ResponseTimeoutMsec (uint32_t aResponseTimeoutMsec)`	`Configuration &` Defina o tempo limite de resposta padrão para contextos de troca criados a partir deste objeto Binding .
`GetError (void) const`	`WEAVE_ERROR` Retorne qualquer erro que tenha ocorrido durante a configuração do Binding .
`PrepareBinding (void)`	`WEAVE_ERROR` Sendo o processo de preparação da Encadernação para comunicação com o par.
`Security_AppGroupKey (uint32_t aAppGroupGlobalId, uint32_t aRootKeyId, bool aUseRotatingKey)`	`Configuration &` Ao se comunicar com o par, envie e receba mensagens criptografadas para um determinado grupo de aplicativos Weave.
`Security_AuthenticationMode (WeaveAuthMode aAuthMode)`	`Configuration &` Defina o modo de autenticação solicitado a ser usado para autenticar o par.
`Security_CASESession (void)`	`Configuration &` Ao se comunicar com o par, envie e receba mensagens criptografadas usando uma chave de sessão CASE estabelecida com o nó do par.
`Security_EncryptionType (uint8_t aEncType)`	`Configuration &` Ao se comunicar com o par, envie e receba mensagens criptografadas usando o tipo de criptografia de mensagem especificado.
`Security_Key (uint32_t aKeyId)`	`Configuration &` Ao se comunicar com o par, envie e receba mensagens criptografadas usando uma chave especificada.
`Security_None (void)`	`Configuration &` Ao se comunicar com o par, envie e receba sem criptografia (ou seja,
`Security_PASESession (uint8_t aPasswordSource)`	`Configuration &` Ao comunicar-se com o par, envie e receba mensagens criptografadas usando uma chave de sessão PASE estabelecida com o nó do par.
`Security_SharedCASESession (void)`	`Configuration &` Ao se comunicar com o par, envie e receba mensagens criptografadas usando uma chave de sessão CASE compartilhada estabelecida com o roteador Nest core.
`Security_SharedCASESession (uint64_t aRouterNodeId)`	`Configuration &` Ao se comunicar com o par, envie e receba mensagens criptografadas usando uma chave de sessão CASE compartilhada estabelecida com um nó de roteador especificado.
`Security_TAKESession ()`	`Configuration &` Ao se comunicar com o par, envie e receba mensagens criptografadas usando uma chave de sessão TAKE estabelecida com o nó do par.
`TargetAddress_IP ( nl::Inet::IPAddress aPeerAddress, uint16_t aPeerPort, InterfaceId aInterfaceId)`	`Configuration &` Ao se comunicar com o par, use o endereço IP específico, a porta e a interface de rede.
`TargetAddress_IP (const char *aHostName, uint16_t aPeerPort, InterfaceId aInterfaceId)`	`Configuration &` Ao se comunicar com o par, use o nome do host específico, a porta e a interface de rede.
`TargetAddress_IP (const char *aHostName, size_t aHostNameLen, uint16_t aPeerPort, InterfaceId aInterfaceId)`	`Configuration &` Ao se comunicar com o par, use o nome do host específico, a porta e a interface de rede.
`TargetAddress_WeaveFabric (uint16_t aSubnetId)`	`Configuration &` Ao se comunicar com o par, use um endereço de tecido Weave derivado da id do nó do par e uma sub-rede especificada.
`TargetAddress_WeaveService (void)`	`Configuration &` Ao se comunicar com o par, use um endereço de fabric de serviço Weave derivado do id de nó do par.
`Target_NodeId (uint64_t aPeerNodeId)`	`Configuration &` Configure a ligação para se comunicar com um ID de nó específico do Weave.
`Target_ServiceEndpoint (uint64_t aPeerNodeId)`	`Configuration &` Configure a ligação para se comunicar com um ponto de extremidade de serviço específico do Weave.
`Transport_DefaultWRMPConfig (const WRMPConfig & aWRMPConfig)`	`Configuration &` Defina a configuração WRMP padrão para contextos de troca criados a partir deste objeto Binding .
`Transport_ExistingConnection ( WeaveConnection *apConnection)`	`Configuration &` Use uma conexão Weave existente para se comunicar com o par.
`Transport_TCP (void)`	`Configuration &` Use o TCP para se comunicar com o par.
`Transport_UDP (void)`	`Configuration &` Use UDP para se comunicar com o par.
`Transport_UDP_PathMTU (uint32_t aPathMTU)`	`Configuration &` Defina o MTU do caminho esperado para pacotes UDP que viajam para o par.
`Transport_UDP_WRM (void)`	`Configuration &` Use o protocolo Weave Reliable Messaging ao se comunicar com o par.

Funções públicas

ConfigureFromMessage

Configuration & ConfigureFromMessage(
  const WeaveMessageInfo *aMsgInfo,
  const Inet::IPPacketInfo *aPacketInfo
)

Configure a ligação para permitir a comunicação com o remetente de uma mensagem recebida.

Detalhes

Parâmetros

`[in] aMsgInfo`	Estrutura de informações da mensagem associada à mensagem recebida.
`[in] aPacketInfo`	Informações do pacote para a mensagem recebida.

DNS_Options

Configuration & DNS_Options(
  uint8_t dnsOptions
)

Ao resolver o nome do host do par, use as opções de DNS especificadas.

Detalhes

Parâmetros

[in] dnsOptions

Um valor inteiro que controla como a resolução do nome do host é executada. O valor deve ser um dos valores da enumeração # :: nl :: Inet :: DNSOptions.

Devoluções

Uma referência ao objeto de ligação.

Exchange_ResponseTimeoutMsec

Configuration & Exchange_ResponseTimeoutMsec(
  uint32_t aResponseTimeoutMsec
)

Defina o tempo limite de resposta padrão para contextos de troca criados a partir deste objeto Binding .

Detalhes

Parâmetros

[in] aResponseTimeoutMsec

O tempo de resposta padrão, em ms.

Devoluções

Uma referência ao objeto de ligação.

GetError

WEAVE_ERROR GetError(
  void
) const

Retorne qualquer erro que tenha ocorrido durante a configuração do Binding .

PrepareBinding

WEAVE_ERROR PrepareBinding(
  void
)

Sendo o processo de preparação da Encadernação para comunicação com o par.

Security_AppGroupKey

Configuration & Security_AppGroupKey(
  uint32_t aAppGroupGlobalId,
  uint32_t aRootKeyId,
  bool aUseRotatingKey
)

Ao se comunicar com o par, envie e receba mensagens criptografadas para um determinado grupo de aplicativos Weave.

Detalhes

Parâmetros

`[in] aAppGroupGlobalId`	A id global do grupo de aplicativos para o qual as mensagens devem ser criptografadas.
`[in] aRootKeyId`	A chave raiz usada para derivar chaves de criptografia para o Grupo de Aplicativos Weave especificado.
`[in] aUseRotatingKey`	Verdadeiro se o Grupo de aplicativos Weave usar chaves de mensagem rotativas.

Devoluções

Uma referência ao objeto Binding .

Security_AuthenticationMode

Configuration & Security_AuthenticationMode(
  WeaveAuthMode aAuthMode
)

Defina o modo de autenticação solicitado a ser usado para autenticar o par.

Detalhes

Parâmetros

[in] aAuthMode

O modo de autenticação solicitado.

Devoluções

Uma referência ao objeto Binding .

Security_CASESession

Configuration & Security_CASESession(
  void
)

Ao se comunicar com o par, envie e receba mensagens criptografadas usando uma chave de sessão CASE estabelecida com o nó do par.

Se a sessão necessária não estiver disponível, ela será estabelecida automaticamente como parte da preparação da encadernação.

Detalhes
Devoluções	Uma referência ao objeto de ligação.

Security_EncryptionType

Configuration & Security_EncryptionType(
  uint8_t aEncType
)

Ao se comunicar com o par, envie e receba mensagens criptografadas usando o tipo de criptografia de mensagem especificado.

Detalhes

Parâmetros

[in] aEncType

O tipo de criptografia da mensagem Weave.

Devoluções

Uma referência ao objeto Binding .

Chave de segurança

Configuration & Security_Key(
  uint32_t aKeyId
)

Ao se comunicar com o par, envie e receba mensagens criptografadas usando uma chave especificada.

Detalhes

Parâmetros

[in] aKeyId

A id da chave de criptografia. A chave especificada deve ser adequada para a criptografia de mensagem do Weave.

Devoluções

Uma referência ao objeto Binding .

Security_None

Configuration & Security_None(
  void
)

Ao se comunicar com o par, envie e receba sem criptografia (ou seja,

mensagens não seguras).

Detalhes
Devoluções	Uma referência ao objeto de ligação.

Security_PASESession

Configuration & Security_PASESession(
  uint8_t aPasswordSource
)

Ao comunicar-se com o par, envie e receba mensagens criptografadas usando uma chave de sessão PASE estabelecida com o nó do par.

Se a sessão necessária não estiver disponível, ela será estabelecida automaticamente como parte da preparação da encadernação.

Detalhes

Parâmetros

[in] aPasswordSource

A fonte da senha a ser usada durante o estabelecimento da sessão PASE.

Devoluções

Uma referência ao objeto de ligação.

Security_SharedCASESession

Configuration & Security_SharedCASESession(
  void
)

Ao se comunicar com o par, envie e receba mensagens criptografadas usando uma chave de sessão CASE compartilhada estabelecida com o roteador Nest core.

Se a sessão necessária não estiver disponível, ela será estabelecida automaticamente como parte da preparação da encadernação.

Detalhes
Devoluções	Uma referência ao objeto de ligação.

Security_SharedCASESession

Configuration & Security_SharedCASESession(
  uint64_t aRouterNodeId
)

Ao se comunicar com o par, envie e receba mensagens criptografadas usando uma chave de sessão CASE compartilhada estabelecida com um nó de roteador especificado.

Se a sessão necessária não estiver disponível, ela será estabelecida automaticamente como parte da preparação da encadernação.

Detalhes

Parâmetros

[in] aRouterNodeId

O ID do nó Weave do roteador com o qual a sessão CASE compartilhada deve ser estabelecida.

Devoluções

Uma referência ao objeto de ligação.

Security_TAKESession

Configuration & Security_TAKESession()

Ao se comunicar com o par, envie e receba mensagens criptografadas usando uma chave de sessão TAKE estabelecida com o nó do par.

Se a sessão necessária não estiver disponível, ela será estabelecida automaticamente como parte da preparação da encadernação.

Detalhes
Devoluções	Uma referência ao objeto de ligação.

TargetAddress_IP

Configuration & TargetAddress_IP(
  nl::Inet::IPAddress aPeerAddress,
  uint16_t aPeerPort,
  InterfaceId aInterfaceId
)

Ao se comunicar com o par, use o endereço IP específico, a porta e a interface de rede.

Detalhes

Parâmetros

`[in] aPeerAddress`	Endereço IP para o par
`[in] aPeerPort`	Porta remota
`[in] aInterfaceId`	O ID da interface de rede local a ser usada para comunicação

Devoluções

Uma referência ao objeto de ligação.

TargetAddress_IP

Configuration & TargetAddress_IP(
  const char *aHostName,
  uint16_t aPeerPort,
  InterfaceId aInterfaceId
)

Ao se comunicar com o par, use o nome do host específico, a porta e a interface de rede.

NOTA: O chamador deve garantir que a string do nome do host fornecida permaneça válida até a conclusão da fase de preparação da ligação.

Detalhes

Parâmetros

`[in] aHostName`	Uma string terminada em NULL contendo o nome do host do par.
`[in] aPeerPort`	Porta remota a ser usada ao se comunicar com o par.
`[in] aInterfaceId`	O ID da interface de rede local a ser usada para comunicação.

Devoluções

Uma referência ao objeto de ligação.

TargetAddress_IP

Configuration & TargetAddress_IP(
  const char *aHostName,
  size_t aHostNameLen,
  uint16_t aPeerPort,
  InterfaceId aInterfaceId
)

Ao se comunicar com o par, use o nome do host específico, a porta e a interface de rede.

NOTA: O chamador deve garantir que a string do nome do host fornecida permaneça válida até que a fase de preparação da ligação seja concluída.

Detalhes

Parâmetros

`[in] aHostName`	Uma string contendo o nome do host do par. Esta string não precisa ser terminada em NULL.
`[in] aHostNameLen`	O comprimento da string apontada por aHostName.
`[in] aPeerPort`	Porta remota a ser usada ao se comunicar com o par.
`[in] aInterfaceId`	O ID da interface de rede local a ser usada para comunicação.

Devoluções

Uma referência ao objeto de ligação.

TargetAddress_WeaveFabric

Configuration & TargetAddress_WeaveFabric(
  uint16_t aSubnetId
)

Ao se comunicar com o par, use um endereço de tecido Weave derivado da id do nó do par e uma sub-rede especificada.

Detalhes

Parâmetros

[in] aSubnetId

O ID de sub-rede a ser usado na formação do endereço de tecido Weave do par.

Devoluções

Uma referência ao objeto de ligação.

TargetAddress_WeaveService

Configuration & TargetAddress_WeaveService(
  void
)

Ao se comunicar com o par, use um endereço de fabric de serviço Weave derivado do id de nó do par.

Detalhes
Devoluções	Uma referência ao objeto de ligação.

Target_NodeId

Configuration & Target_NodeId(
  uint64_t aPeerNodeId
)

Configure a ligação para se comunicar com um ID de nó específico do Weave.

Detalhes

Parâmetros

[in] aPeerNodeId

ID do nó do nó par.

Devoluções

Uma referência ao objeto de ligação.

Target_ServiceEndpoint

Configuration & Target_ServiceEndpoint(
  uint64_t aPeerNodeId
)

Configure a ligação para se comunicar com um ponto de extremidade de serviço específico do Weave.

Se não for configurado de outra forma, o endereço do par é definido como o endereço da tela Weave do ponto de extremidade do serviço.

Detalhes

Parâmetros

[in] serviceEndpointId

O id do nó do terminal de serviço com o qual a comunicação ocorrerá.

Devoluções

Uma referência ao objeto de ligação.

Transport_DefaultWRMPConfig

Configuration & Transport_DefaultWRMPConfig(
  const WRMPConfig & aWRMPConfig
)

Defina a configuração WRMP padrão para contextos de troca criados a partir deste objeto Binding .

Detalhes

Parâmetros

[in] aWRMPConfig

Uma referência à nova configuração WRMP padrão.

Devoluções

Uma referência ao objeto de ligação.

Transport_ExistingConnection

Configuration & Transport_ExistingConnection(
  WeaveConnection *apConnection
)

Use uma conexão Weave existente para se comunicar com o par.

NOTA: A contagem de referência no objeto de conexão é incrementada quando a preparação da ligação é bem-sucedida. Assim, o aplicativo é responsável por garantir que o objeto de conexão permaneça ativo até esse momento.

Detalhes

Parâmetros

[in] con

Um ponteiro para a conexão Weave existente.

Devoluções

Uma referência ao objeto de ligação.

Transport_TCP

Configuration & Transport_TCP(
  void
)

Use o TCP para se comunicar com o par.

Detalhes
Devoluções	Uma referência ao objeto de ligação.

Transport_UDP

Configuration & Transport_UDP(
  void
)

Use UDP para se comunicar com o par.

Detalhes
Devoluções	Uma referência ao objeto de ligação.

Transport_UDP_PathMTU

Configuration & Transport_UDP_PathMTU(
  uint32_t aPathMTU
)

Defina o MTU do caminho esperado para pacotes UDP que viajam para o par.

Para alguns protocolos do Weave, isso será usado para ajustar dinamicamente o tamanho da carga útil da mensagem do Weave.

Detalhes

Parâmetros

[in] aPathMTU

O MTU do caminho esperado para pacotes UDP que viajam para o par.

Devoluções

Uma referência ao objeto de ligação.

Transport_UDP_WRM

Configuration & Transport_UDP_WRM(
  void
)

Use o protocolo Weave Reliable Messaging ao se comunicar com o par.

Detalhes
Devoluções	Uma referência ao objeto de ligação.