nl::Tratado:Vinculação

Captura o destino 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 " peers") com um conjunto de parâmetros de configuração que descrevem como a comunicação com o par precisa ocorrer. As vinculações são independentes do protocolo de aplicativo falado entre as duas partes. Dessa forma, eles capturam o "quem" e o "como" de uma comunicação, mas não o "o que".

Configuration

Os aplicativos precisam configurar uma Vinculação 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 Trusted Messaging e Weave via 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 as sessões CASE e PASE e as chaves do grupo de aplicativos. A interface para configurar uma Vinculação usa um estilo de API declarativa que permite que os aplicativos declarem os requisitos de comunicação em termos simples.

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

preparação

Antes da comunicação, uma Binding precisa ser "prepared." O ato de preparar uma vinculação envolve estabelecer o estado necessário para a comunicação. Isso pode incluir, por exemplo: resolver o endereço de rede do terminal, estabelecer uma conexão de rede e negociar chaves de segurança. Depois de configurado pelo aplicativo, a Binding cuida de todas as etapas necessárias para se preparar para a comunicação, chamando o app novamente quando o processo é concluído. Dessa forma, as vinculações ocultam a mecânica da comunicação, permitindo que os aplicativos se concentrem nas interações de alto nível.

Comunicação

Depois que uma Binding for preparada, ela estará pronta 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 do Weave. O contexto de troca resultante vem pré-configurado para comunicação, permitindo que o app inicie imediatamente uma troca do Weave com o par. O aplicativo pode continuar a solicitar contextos de troca da Vinculação até que a Vinculação seja encerrada ou algum evento, como uma falha de rede, encerre o canal de comunicação subjacente.

Alterações no estado Binding

Durante o uso, uma Binding enviará eventos de API ao aplicativo, informando-as sobre as alterações no estado da vinculação. Por exemplo, quando a preparação for bem-sucedida, o aplicativo receberá um evento informando que a Binding está pronta para uso. Da mesma forma, se o canal de comunicação subjacente falhar, um evento será enviado ao aplicativo informando que a vinculação não estará mais no estado pronto.

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

Ciclo de vida de Binding

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

Quando um aplicativo terminar de usar uma Binding, poderá chamar Close() na vinculação. Isso libera a referência do aplicativo à Binding e bloqueia todas as entregas adicionais de eventos de API. Quando a última referência a uma Binding for liberada, ela será fechada automaticamente.

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
)