O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.

nl :: Tecer:: Obrigatório

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

Captura o alvo pretendido de uma comunicação Weave e informações de configuração associadas.

Resumo

A Binding identifica objectos do alvo pretendido de uma comunicação tecer (também conhecida como o "ponto"), juntamente com um conjunto de parâmetros de configuração que descreve como a comunicação com os pares deve ter lugar. As ligações são independentes do protocolo do aplicativo falado entre as duas partes. Como tal, eles capturam o "quem" e o "como" de uma comunicação, mas não o "o quê".

Configuração

As candidaturas devem configurar uma ligação com parâmetros específicos para o tipo de canal de comunicação desejado. As ligações fornecem suporte para uma variedade de transportes de rede, incluindo TCP, UDP, UDP com Weave Reliable Messaging e Weave over BLE (WoBLE). Os aplicativos também podem solicitar o uso de mecanismos de segurança específicos para proteger as mensagens enviadas entre as partes. Isso inclui sessões CASE e PASE e chaves de grupo de aplicativos. A interface para configurar uma ligação usa um estilo API declarativa que permite que aplicativos de afirmar as suas exigências para a comunicação em termos simples.

Consulte a documentação para Encadernação :: Configuração para mais detalhes.

Preparação

Antes da comunicação ter lugar, a ligação deve ser "preparado". O ato de preparar um Binding envolve estabelecer o estado necessário para a comunicação ocorra. Isso pode incluir coisas como: resolver o endereço de rede do par, estabelecer uma conexão de rede e negociar chaves de segurança. Uma vez configurado pela aplicação, a ligação cuida de todas as etapas necessárias para se preparar para a comunicação, chamando de volta para o aplicativo quando o processo estiver concluído. Desta forma, os Bindings ocultam a mecânica da comunicação, permitindo que os aplicativos se concentrem nas interações de alto nível.

Comunicação

Uma vez que um Binding foi preparado torna-se pronto para uso. Neste estado, as aplicações (ou mais geralmente, código camada do protocolo de trabalho em nome de uma aplicação) solicitar o Binding para alocar um contexto troca tecer. O contexto de troca resultante vem pré-configurado para comunicação, permitindo que o aplicativo inicie imediatamente uma troca Weave com o par. A aplicação pode continuar a contextos de câmbio pedido do Binding até ao momento em que a encadernação é fechada, ou algum evento, por exemplo, uma falha de rede, termina o canal de comunicação subjacente.

Encadernação Alterações do Estado

Ao longo de sua utilização, uma ligação vai entregar eventos API para a aplicação informando-o de mudanças na ligação estado 's. Por exemplo, quando a preparação for bem sucedido, o aplicativo receberá um evento informando que a Binding está pronto para uso. Da mesma forma, se o canal de comunicação subjacente falhar, um evento é entregue ao aplicativo informando-o de que a ligação não está mais no estado imediata.

Eventos da API são entregues à aplicação através de uma função de evento de retorno de chamada fornecido quando a ligação é alocado.

Binding Lifetime

Encadernação são referência contados para permitir o uso compartilhado entre vários componentes de software. Quando uma ligação é alocado, é criada uma única referência à ligação. A aplicação é responsável para libertar esta referência em algum momento no futuro, de tal modo que a encadernação é livre para reutilização subsequente.

Quando uma aplicação é feita com uma ligação pode chamar Close () na ligação. Isso libera referência do aplicativo para os Encadernação e bloqueia todo o posterior envio de eventos da API. Quando a última referência a um Binding é liberado, ele é automaticamente fechada.

Tipos públicos

@23 {
kGetPeerDescription_MaxLength = nl::Weave::kWeavePeerDescription_MaxLength
}
enum
EventCallback )(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam) typedef
void(*
EventType {
kEvent_ConnectionEstablished = 1,
kEvent_BindingReady = 2,
kEvent_PrepareFailed = 3,
kEvent_BindingFailed = 4,
kEvent_PrepareRequested = 5,
kEvent_PASEParametersRequested = 6,
kEvent_TAKEParametersRequested = 7,
kEvent_DefaultCheck = 100
}
enum
State enum

Atributos públicos

AppState
void *

Funções públicas

AddRef (void)
void
Reserve uma referência ao objeto de ligação.
AdjustResponseTimeout ( ExchangeContext *apExchangeContext) const
Reconfigure um Exchange Context existente para ajustar o tempo limite de resposta.
AllocateRightSizedBuffer (PacketBuffer *& buf, const uint32_t desiredSize, const uint32_t minSize, uint32_t & outMaxPayloadSize)
BeginConfiguration ()
Sendo o processo de configuração do Binding .
CanBePrepared (void) const
bool
Close (void)
void
Feche o objeto de ligação e libere uma referência.
GetConnection () const
Obtenha o objeto de conexão Weave associado à ligação.
GetDefaultResponseTimeout () const
uint32_t
Obtenha o tempo limite de resposta de troca padrão a ser usado ao se comunicar com o par.
GetDefaultWRMPConfig (void) const
const WRMPConfig &
Obtenha a configuração WRMP padrão a ser usada ao se comunicar com o par.
GetEncryptionType (void) const
uint8_t
Recupere o tipo de criptografia de mensagem a ser usado ao criptografar mensagens de / para o par.
GetEventCallback () const
EventCallback
Obter a função que será chamado quando um evento ocorre API para a encadernação .
GetExchangeManager () const
GetKeyId (void) const
uint32_t
Recupere a id da chave de criptografia da mensagem a ser usada ao criptografar mensagens de / para o par.
GetLogId (void) const
uint16_t
Obtenha uma identificação exclusiva para a ligação.
GetMaxWeavePayloadSize (const System::PacketBuffer *msgBuf)
uint32_t
Obtenha o tamanho máximo de carga útil do Weave que pode caber dentro do PacketBuffer fornecido.
GetPeerDescription (char *buf, uint32_t bufSize) const
void
Constrói uma string que descreve o nó de mesmo nível e seu endereço / informações de conexão associados.
GetPeerIPAddress ( nl::Inet::IPAddress & address, uint16_t & port, InterfaceId & interfaceId) const
void
Recupere as informações do endereço IP do par, se disponível.
GetPeerNodeId (void) const
uint64_t
Recupere o id do nó do par de ligação.
GetProtocolLayerCallback (EventCallback & callback, void *& state) const
void
GetState (void) const
State
Recupere o estado atual da ligação.
IsAuthenticMessageFromPeer (const WeaveMessageInfo *msgInfo)
bool
Determine se uma determinada mensagem recebida é do par configurado e está devidamente autenticada.
IsConnectionTransport () const
bool
IsPreparing (void) const
bool
IsReady (void) const
bool
IsUDPTransport () const
bool
IsUnreliableUDPTransport () const
bool
IsWRMTransport () const
bool
NewExchangeContext ( ExchangeContext *& appExchangeContext)
Aloque um novo contexto de troca para se comunicar com o par que é o destino da ligação.
Release (void)
void
Libere uma referência ao objeto de ligação.
RequestPrepare ()
Solicitar a aplicação para configurar e preparar o Binding .
Reset (void)
void
Redefina a ligação de volta para um estado não configurado.
SetDefaultResponseTimeout (uint32_t msec)
void
Defina o tempo limite de resposta de troca padrão a ser usado ao se comunicar com o par.
SetDefaultWRMPConfig (const WRMPConfig & wrmpConfig)
void
Defina a configuração WRMP padrão a ser usada ao se comunicar com o par.
SetEventCallback (EventCallback aEventCallback)
void
Definir a função definida pelo aplicativo a ser chamado quando um evento ocorre API para a encadernação .
SetProtocolLayerCallback (EventCallback callback, void *state)
void
Definir uma função de evento de chamada de retorno para o código de camada de protocolo utilizando a encadernação em nome de uma aplicação.

Funções estáticas públicas

DefaultEventHandler (void *apAppState, EventType aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
void
Manipulador padrão para vincular eventos de API.

Aulas

nl :: Weave :: Encadernação :: Configuração

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

Structs

nl :: Weave :: Encadernação :: InEventParam

Parâmetros de entrada para um Binding evento API.

nl :: Weave :: Encadernação :: OutEventParam

Parâmetros de saída para um Binding evento API.

Tipos públicos

@ 23

 @23
Propriedades
kGetPeerDescription_MaxLength

Comprimento máximo de string (incluindo caractere NUL) retornado por GetPeerDescription () .

EventCallback

void(* EventCallback)(void *apAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutParam)

Tipo de evento

 EventType
Propriedades
kEvent_BindingFailed

A ligação falhou e não pode mais ser usada para se comunicar com o par.

kEvent_BindingReady

A ação de preparação na ligação foi bem-sucedida e a ligação agora pode ser usada para se comunicar com o par.

kEvent_ConnectionEstablished

A conexão Weave solicitada foi estabelecida.

kEvent_DefaultCheck

Usado para verificar o tratamento de eventos padrão correto no aplicativo.

kEvent_PASEParametersRequested

O aplicativo é solicitado a fornecer parâmetros a serem usados ​​durante o estabelecimento da sessão PASE.

kEvent_PrepareFailed

A ação de preparação na ligação falhou.

kEvent_PrepareRequested

O aplicativo é solicitado a configurar e preparar a ligação para uso pela pilha de rede.

kEvent_TAKEParametersRequested

O aplicativo é solicitado a fornecer parâmetros a serem usados ​​durante o estabelecimento da sessão TAKE.

Estado

 State

Atributos públicos

AppState

void * AppState

Funções públicas

AddRef

void AddRef(
  void
)

Reserve uma referência ao objeto de ligação.

AdjustResponseTimeout

WEAVE_ERROR AdjustResponseTimeout(
  ExchangeContext *apExchangeContext
) const 

Reconfigure um Exchange Context existente para ajustar o tempo limite de resposta.

Detalhes
Parâmetros
[in] apExchangeContext
Um ponteiro para um objeto Exchange Context a ser reconfigurado

AllocateRightSizedBuffer

WEAVE_ERROR AllocateRightSizedBuffer(
  PacketBuffer *& buf,
  const uint32_t desiredSize,
  const uint32_t minSize,
  uint32_t & outMaxPayloadSize
)

BeginConfiguration

Configuration BeginConfiguration()

Sendo o processo de configuração do Binding .

As candidaturas devem chamar BeginConfiguration () para configurar a ligação antes de prepará-la para a comunicação com os pares.

Detalhes
Devoluções
A ligação :: Configuração de objeto que pode ser usado para configurar a ligação.

CanBePrepared

bool CanBePrepared(
  void
) const 

Perto

void Close(
  void
)

Feche o objeto de ligação e libere uma referência.

Quando chamado, esse método faz com que a vinculação entre no estado Fechado. Todas as ações de preparação em andamento para a vinculação são canceladas e todos os recursos de comunicações externas mantidos pela vinculação são liberados.

Chamando Close () diminui a contagem de referência associado com a ligação, liberando o objeto se a contagem de referência torna-se zero.

GetConnection

WeaveConnection * GetConnection() const 

Obtenha o objeto de conexão Weave associado à ligação.

Detalhes
Devoluções
Um apontador para um WeaveConnection objeto, ou NULL se não há nenhuma conexão associada com a ligação.

GetDefaultResponseTimeout

uint32_t GetDefaultResponseTimeout() const 

Obtenha o tempo limite de resposta de troca padrão a ser usado ao se comunicar com o par.

Detalhes
Devoluções
Tempo limite de resposta em ms.

GetDefaultWRMPConfig

const WRMPConfig & GetDefaultWRMPConfig(
  void
) const 

Obtenha a configuração WRMP padrão a ser usada ao se comunicar com o par.

Detalhes
Devoluções
Uma referência a um WRMPConfig estrutura que contém os valores de configuração padrão.

GetEncryptionType

uint8_t GetEncryptionType(
  void
) const 

Recupere o tipo de criptografia de mensagem a ser usado ao criptografar mensagens de / para o par.

GetEventCallback

EventCallback GetEventCallback() const 

Obter a função que será chamado quando um evento ocorre API para a encadernação .

Detalhes
Devoluções
Um ponteiro para a função de retorno de chamada.

GetExchangeManager

WeaveExchangeManager * GetExchangeManager() const 

GetKeyId

uint32_t GetKeyId(
  void
) const 

Recupere a id da chave de criptografia da mensagem a ser usada ao criptografar mensagens de / para o par.

GetLogId

uint16_t GetLogId(
  void
) const 

Obtenha uma identificação exclusiva para a ligação.

GetMaxWeavePayloadSize

uint32_t GetMaxWeavePayloadSize(
  const System::PacketBuffer *msgBuf
)

Obtenha o tamanho máximo de carga útil do Weave que pode caber dentro do PacketBuffer fornecido.

Para UDP, incluindo UDP com WRM, o tamanho máximo da carga retornada garantirá que a mensagem Weave resultante não ultrapasse o UDP MTU configurado.

Além disso, esse método garantirá que a carga útil do Weave não sobrecarregue o PacketBuffer fornecido.

Detalhes
Parâmetros
[in] msgBuf
Um ponteiro para o PacketBuffer no qual a carga útil da mensagem será gravada.
Devoluções
O tamanho máximo da carga útil do Weave.

GetPeerDescription

void GetPeerDescription(
  char *buf,
  uint32_t bufSize
) const 

Constrói uma string que descreve o nó de mesmo nível e seu endereço / informações de conexão associados.

Detalhes
Parâmetros
[in] buf
Um ponteiro para um buffer no qual a string deve ser gravada. O buffer fornecido deve ser pelo menos tão grande quanto kGetPeerDescription_MaxLength. Se um buffer menor for fornecido, a string será truncada para caber. A saída incluirá um caractere de terminação NUL em todos os casos.
[in] bufSize
O tamanho do buffer apontado por buf.

GetPeerIPAddress

void GetPeerIPAddress(
  nl::Inet::IPAddress & address,
  uint16_t & port,
  InterfaceId & interfaceId
) const 

Recupere as informações do endereço IP do par, se disponível.

A disponibilidade das informações do endereço IP do ponto depende do estado e da configuração da vinculação. As informações de endereço IP estão disponíveis apenas ao usar um transporte baseado em IP (TCP, UDP ou UDP com WRMP). Antes do início da preparação, as informações de endereço só estarão disponíveis se tiverem sido definidas expressamente pelo aplicativo durante a configuração. Durante a fase de preparação, as informações do endereço estão disponíveis quando a preparação do endereço é concluída (por exemplo, após a conclusão da resolução DNS). Após a Binding está pronto, informações de endereço permanece disponível até a ligação é reposta.

Detalhes
Parâmetros
[out] address
Uma referência a um objeto IPAddress que receberá o endereço IP do par. Se as informações de endereço IP do ponto não estiver disponível, este valor será definido para IPAddress :: Qualquer .
[out] port
Uma referência a um número inteiro que receberá o número da porta do par. Se as informações do endereço IP do par não estiverem disponíveis, esse valor é indefinido.
[out] interfaceId
Uma referência a um inteiro que receberá a id da interface de rede por meio da qual o par pode ser alcançado. Se as informações do endereço IP do par não estiverem disponíveis, esse valor é indefinido.

GetPeerNodeId

uint64_t GetPeerNodeId(
  void
) const 

Recupere o id do nó do par de ligação.

Válido apenas quando o objeto de ligação for preparado.

Detalhes
Devoluções
ID de nó de trama do par

GetProtocolLayerCallback

void GetProtocolLayerCallback(
  EventCallback & callback,
  void *& state
) const 

GetState

State GetState(
  void
) const 

Recupere o estado atual da ligação.

Detalhes
Devoluções
O estado de ligação.

IsAuthenticMessageFromPeer

bool IsAuthenticMessageFromPeer(
  const WeaveMessageInfo *msgInfo
)

Determine se uma determinada mensagem recebida é do par configurado e está devidamente autenticada.

Este método confirma os seguintes detalhes sobre a mensagem fornecida:

  • A mensagem originou-se do nó par da ligação
  • A mensagem foi recebida pelo mesmo tipo de transporte da ligação. Se a mensagem foi recebida por uma conexão, o método também confirma que a mensagem foi recebida pela conexão exata associada à ligação.
  • A chave e o tipo de criptografia usados ​​para criptografar a mensagem correspondem àqueles configurados na ligação. Para ligações configuradas sem o uso de segurança, o método confirma que a mensagem recebida NÃO está criptografada.

Este método deve ser usado em protocolos como o WDM, onde os pares podem iniciar espontaneamente as trocas de volta para o nó local após uma troca inicial do nó para o par. Nesses casos, o método permite que o nó local confirme se a mensagem não solicitada recebida foi enviada pelo par associado. (Obviamente, para Bindings configurados sem o uso de criptografia de mensagem, essa afirmação não fornece nenhum valor de uma perspectiva de segurança. Ela apenas confirma que o id do nó remetente e os tipos de transporte correspondem.)

Observe que, se a associação não estiver no estado Pronto, esse método sempre retornará falso.

Detalhes
Parâmetros
[in] msgInfo
As informações da mensagem Weave para a mensagem recebida.
Devoluções
Verdadeiro se a mensagem for autenticamente do par.

IsConnectionTransport

bool IsConnectionTransport() const 

Está preparando

bool IsPreparing(
  void
) const 

Detalhes
Devoluções
True se a ligação está a ser preparado.

Está pronto

bool IsReady(
  void
) const 

Detalhes
Devoluções
True se a Binding está no estado Pronto.

IsUDPTransport

bool IsUDPTransport() const 

IsUnreliableUDPTransport

bool IsUnreliableUDPTransport() const 

IsWRMTransport

bool IsWRMTransport() const 

NewExchangeContext

WEAVE_ERROR NewExchangeContext(
  ExchangeContext *& appExchangeContext
)

Aloque um novo contexto de troca para se comunicar com o par que é o destino da ligação.

Detalhes
Parâmetros
[out] appExchangeContext
Uma referência a um ponteiro que receberá o objeto Exchange Context recém-alocado. O ponteiro será definido como NULL no caso de o método falhar.
Valores Retornados
WEAVE_NO_ERROR
Se o contexto de troca foi alocado com sucesso.
WEAVE_ERROR_NO_MEMORY
Se nenhuma memória estiver disponível para alocar o contexto de troca.
WEAVE_ERROR_INCORRECT_STATE
Se a encadernação não estiver no estado Pronto.
other
Outros erros relacionados à configuração do contexto de troca com base na configuração da ligação.

Liberação

void Release(
  void
)

Libere uma referência ao objeto de ligação.

Se não houver mais referências ao objeto de vinculação, a vinculação será fechada e liberada.

RequestPrepare

WEAVE_ERROR RequestPrepare()

Solicitar a aplicação para configurar e preparar o Binding .

Código da camada de protocolo pode utilizar este método numa Binding que não tenha sido configurado, ou falhou, para desencadear um evento de pedido (kEvent_PrepareRequested) solicitando que configurar e preparar a ligação para utilização.

Este método só pode ser chamado em Bindings nos estados NotConfigured ou Failed.

Se o aplicativo não suportar configuração / preparação sob demanda de Bindings, o método falhará com WEAVE_ERROR_NOT_IMPLEMENTED.

Redefinir

void Reset(
  void
)

Redefina a ligação de volta para um estado não configurado.

Quando Reset () é chamado, qualquer em andamento preparar ações para a ligação são canceladas e todos os recursos de comunicação externa realizada pela ligação são liberados. Reset () coloca a ligação no estado não configurado, após o que pode ser configurado e preparado de novo.

Redefinir () não altera a contagem de referência da ligação.

SetDefaultResponseTimeout

void SetDefaultResponseTimeout(
  uint32_t msec
)

Defina o tempo limite de resposta de troca padrão a ser usado ao se comunicar com o par.

Detalhes
Parâmetros
[in] timeout
O novo tempo limite de resposta em ms.

SetDefaultWRMPConfig

void SetDefaultWRMPConfig(
  const WRMPConfig & wrmpConfig
)

Defina a configuração WRMP padrão a ser usada ao se comunicar com o par.

Detalhes
Parâmetros
[in] aWRMPConfig
Uma referência a um WRMPConfig estrutura contendo a nova configuração padrão.

SetEventCallback

void SetEventCallback(
  EventCallback aEventCallback
)

Definir a função definida pelo aplicativo a ser chamado quando um evento ocorre API para a encadernação .

Detalhes
Parâmetros
[in] aEventCallback
Um ponteiro para a função de retorno de chamada.

SetProtocolLayerCallback

void SetProtocolLayerCallback(
  EventCallback callback,
  void *state
)

Definir uma função de evento de chamada de retorno para o código de camada de protocolo utilizando a encadernação em nome de uma aplicação.

Esta função será chamada para além da função de retorno definido pela aplicação quando os eventos API ocorrer para a encadernação .

Detalhes
Parâmetros
[in] callback
Um ponteiro para a função de retorno de chamada.
[in] state
Um ponteiro para um objeto de estado que será fornecido ao código da camada de protocolo quando ocorrer um retorno de chamada da camada de protocolo.

Funções estáticas públicas

DefaultEventHandler

void DefaultEventHandler(
  void *apAppState,
  EventType aEvent,
  const InEventParam & aInParam,
  OutEventParam & aOutParam
)

Manipulador padrão para vincular eventos de API.

Os aplicativos são obrigados a chamar esse método para quaisquer eventos de API que eles não reconhecem ou manipulam. Os parâmetros fornecidos devem ser iguais aos passados ​​pela vinculação à função de manipulador de eventos do aplicativo.

Detalhes
Parâmetros
[in] apAppState
Um ponteiro para informações de estado definidas pelo aplicativo associadas à vinculação.
[in] aEvent
ID do evento passado pelo retorno de chamada do evento
[in] aInParam
Referência dos parâmetros do evento de entrada passados ​​pelo retorno de chamada do evento
[in] aOutParam
Referência dos parâmetros do evento de saída passados ​​pelo retorno de chamada do evento