nl :: Tecer:: Obrigatório

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

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
)