nl :: Tejido:: Unión

Captura el objetivo previsto de una comunicación Weave y la información de configuración asociada.

Resumen

A Binding identifica objeto al objetivo pretendido de una comunicación de la armadura (también conocida como la "pares"), además de un conjunto de parámetros de configuración que describe cómo la comunicación con el interlocutor debe tener lugar. Los enlaces son independientes del protocolo de aplicación que se habla entre las dos partes. Como tales, capturan el "quién" y el "cómo" de una comunicación, pero no el "qué".

Configuración

Las solicitudes deben configurar una unión con parámetros específicos para el tipo de canal de comunicación deseada. Los enlaces brindan soporte para una variedad de transportes de red, incluidos TCP, UDP, UDP con Weave Reliable Messaging y Weave over BLE (WoBLE). Las aplicaciones también pueden solicitar el uso de mecanismos de seguridad específicos para proteger los mensajes enviados entre las partes. Estos incluyen sesiones CASE y PASE, y claves de grupo de aplicaciones. La interfaz para la configuración de una unión utiliza un estilo declarativo API que permite a las aplicaciones afirman sus requisitos para la comunicación en términos simples.

Consulte la documentación de Encuadernación :: Configuración para más detalles.

Preparación

Antes de la comunicación que tiene lugar, una unión debe ser "preparado". El acto de la preparación de una encuadernación consiste en establecer el estado necesario para la comunicación tenga lugar. Esto puede incluir cosas como: resolver la dirección de red del par, establecer una conexión de red y negociar claves de seguridad. Una vez configurada la aplicación, la unión se encarga de todos los pasos necesarios para prepararse para la comunicación, volver a llamar a la aplicación cuando el proceso se haya completado. De esta manera, los Bindings ocultan la mecánica de la comunicación, permitiendo que las aplicaciones se concentren en las interacciones de alto nivel.

Comunicación

Una vez que una encuadernación ha sido preparado se hace listo para su uso. En este estado, las aplicaciones (o más comúnmente, el código de capa de protocolo de trabajo en nombre de una aplicación) solicitan al Encuadernación para asignar un contexto de cambio de la armadura. El contexto de intercambio resultante viene preconfigurado para la comunicación, lo que permite que la aplicación inicie inmediatamente un intercambio de Weave con el par. La aplicación puede continuar a contextos de cambio solicitud de la unión hasta que la unión está cerrada, o algún evento, por ejemplo, un fallo de red, termina el canal de comunicación subyacente.

Encuadernación Cambios de estado

En el transcurso de su uso, una unión entregará sucesos de API a la aplicación informándole de los cambios en la unión estatal 's. Por ejemplo, cuando la preparación tiene éxito, la aplicación recibirá un evento informándole de que la encuadernación está listo para su uso. Del mismo modo, si falla el canal de comunicación subyacente, un evento se entrega a la aplicación informándole de que la unión ya no está en el estado listo es.

Sucesos de API se entregan a la aplicación a través de una función de evento de devolución de llamada suministrada cuando la unión se asigna.

unión de por vida

La unión se cuentan referencia para permitir el uso compartido a través de múltiples componentes de software. Cuando una unión se asigna, se crea una sola referencia a la unión. La aplicación es responsable de la liberación de esta referencia en algún momento en el futuro, de forma que la encuadernación es libre para su posterior reutilización.

Cuando una aplicación se realiza con una unión que puede llamar a Close () en la unión. Esto libera la referencia de la aplicación de las Encuadernación y bloquea toda nueva entrega de sucesos de API. Cuando la última referencia a una encuadernación se libera, se cierra automáticamente.

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
)