nl::Weave::Binding

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

Resumo

Um objeto Binding identifica o destino pretendido de uma comunicação do Weave (também conhecido como "ponto"), além de um conjunto de parâmetros de configuração que descrevem como a comunicação com o ponto deve ocorrer. As vinculações são independentes do protocolo do aplicativo falado entre as duas partes. Assim, eles capturam o "quem" e o "como" de uma comunicação, mas não o "o quê".

Configuração

Os aplicativos precisam configurar um Binding com parâmetros específicos para o tipo de canal de comunicação desejado. As vinculações fornecem suporte para uma variedade de transportes de rede, incluindo TCP, UDP, UDP com Weave Trust 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, além de chaves de grupos de aplicativos. A interface para configurar uma Binding usa um estilo de API declarativa que permite que os aplicativos declarem os próprios requisitos para a comunicação em termos simples.

Consulte a documentação de Binding::Configuration para ver mais detalhes.

Preparação

Antes da comunicação ocorrer, uma Binding precisa ser "preparada". O ato de preparar uma Vinculação envolve estabelecer o estado necessário para a comunicação. Isso pode incluir ações como resolver o endereço de rede do peering, estabelecer uma conexão de rede e negociar chaves de segurança. Depois de configurado pelo aplicativo, a classe Binding cuida de todas as etapas necessárias para se preparar para a comunicação, fazendo um callback para o aplicativo quando o processo é concluído. Dessa forma, as vinculações escondem a mecânica de comunicação, permitindo que os aplicativos se concentrem nas interações de alto nível.

Comunicação

Depois que um Binding é preparado, ele fica pronto para uso. Nesse estado, os aplicativos (ou, mais comumente, o código da camada de protocolo que funciona em nome de um aplicativo) solicitam a Binding para alocar um contexto de troca de Weave. O contexto da troca resultante vem pré-configurado para comunicação, permitindo que o aplicativo inicie imediatamente uma troca do Weave com o peering. O aplicativo pode continuar solicitando contextos de troca de Binding até que a Binding seja encerrada ou até que algum evento, por exemplo, uma falha de rede, encerre o canal de comunicação subjacente.

Mudanças no estado de vinculação

Durante o uso, uma Binding entrega eventos de API para o aplicativo, informando sobre mudanças no estado do Binding. Por exemplo, quando a preparação é bem-sucedida, o aplicativo recebe um evento informando que a Binding está pronta para uso. Da mesma forma, se o canal de comunicação subjacente falhar, um evento será entregue ao aplicativo informando que Binding não está mais no estado "ready".

Os eventos da API são entregues ao aplicativo por meio de uma função de callback de evento fornecida quando a Binding é alocada.

Duração da vinculação

As vinculações são contadas para permitir o uso compartilhado entre vários componentes de software. Quando uma Vinculação é alocada, uma referência única a ela é criada. O aplicativo é responsável por lançar essa referência em algum momento no futuro, de modo que a Binding fique livre para reutilização subsequente.

Quando um aplicativo termina de usar uma Binding, ele pode chamar Close() na vinculação. Isso libera a referência do aplicativo para a Binding e bloqueia todas as outras entregas de eventos da API. Quando a última referência a uma Binding é liberada, ela é automaticamente fechada.

Tipos públicos

 @23

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

 EventType

 State

void * AppState

void AddRef(
  void
)

WEAVE_ERROR AdjustResponseTimeout(
  ExchangeContext *apExchangeContext
) const 

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

Configuration BeginConfiguration()

bool CanBePrepared(
  void
) const 

void Close(
  void
)

WeaveConnection * GetConnection() const 

uint32_t GetDefaultResponseTimeout() const 

const WRMPConfig & GetDefaultWRMPConfig(
  void
) const 

uint8_t GetEncryptionType(
  void
) const 

EventCallback GetEventCallback() const 

WeaveExchangeManager * GetExchangeManager() const 

uint32_t GetKeyId(
  void
) const 

uint16_t GetLogId(
  void
) const 

uint32_t GetMaxWeavePayloadSize(
  const System::PacketBuffer *msgBuf
)

void GetPeerDescription(
  char *buf,
  uint32_t bufSize
) const 

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

uint64_t GetPeerNodeId(
  void
) const 

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

State GetState(
  void
) const 

bool IsAuthenticMessageFromPeer(
  const WeaveMessageInfo *msgInfo
)

bool IsConnectionTransport() const 

bool IsPreparing(
  void
) const 

bool IsReady(
  void
) const 

bool IsUDPTransport() const 

bool IsUnreliableUDPTransport() const 

bool IsWRMTransport() const 

WEAVE_ERROR NewExchangeContext(
  ExchangeContext *& appExchangeContext
)

void Release(
  void
)

WEAVE_ERROR RequestPrepare()

void Reset(
  void
)

void SetDefaultResponseTimeout(
  uint32_t msec
)

void SetDefaultWRMPConfig(
  const WRMPConfig & wrmpConfig
)

void SetEventCallback(
  EventCallback aEventCallback
)

void SetProtocolLayerCallback(
  EventCallback callback,
  void *state
)

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