nl :: Tecer:: Obrigatório

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

Resumo

Um objeto Binding identifica o alvo pretendido de uma comunicação Weave (também conhecido como "par"), junto com um conjunto de parâmetros de configuração que descreve como a comunicação com o par deve ocorrer. 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

Os aplicativos devem configurar um Binding 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 um Binding usa um estilo de API declarativo que permite aos aplicativos declarar seus requisitos para a comunicação em termos simples.

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

Preparação

Antes de ocorrer a comunicação, uma Vinculação deve ser "preparada". O ato de preparar uma Ligação envolve o estabelecimento do estado necessário para que 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 pelo aplicativo, o Binding cuida de todas as etapas necessárias para se preparar para a comunicação, retornando ao aplicativo quando o processo for 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

Assim que uma Encadernação for preparada, ela estará pronta para uso. Nesse estado, os aplicativos (ou mais comumente, o código da camada de protocolo trabalhando em nome de um aplicativo) solicitam que o Binding aloque um contexto de troca do Weave. O contexto de troca resultante vem pré-configurado para comunicação, permitindo que o aplicativo inicie imediatamente uma troca Weave com o par. O aplicativo pode continuar a solicitar contextos de troca do Binding até que o Binding seja fechado ou algum evento, por exemplo, uma falha de rede, termine o canal de comunicação subjacente.

Alterações de estado de ligação

Durante seu uso, um Binding entregará eventos de API ao aplicativo informando-o sobre as mudanças no estado do Binding . Por exemplo, quando a preparação for bem-sucedida, o aplicativo receberá um evento informando que o Binding está pronto para uso. Da mesma forma, se o canal de comunicação subjacente falhar, um evento será entregue ao aplicativo informando que o Binding não está mais no estado pronto.

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

Tempo de vida obrigatório

As ligações são contadas por referência para permitir o uso compartilhado entre vários componentes de software. Quando uma vinculação é alocada, uma única referência à vinculação é criada. O aplicativo é responsável por liberar essa referência em algum momento no futuro, de forma que a Ligação esteja livre para reutilização subsequente.

Quando um aplicativo é feito com um Binding, ele pode chamar Close () no binding. Isso libera a referência do aplicativo ao Binding e bloqueia todas as entregas futuras de eventos de API. Quando a última referência a uma ligação 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
)