nl :: Tejido:: Unión

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

Resumen

Un objeto Binding identifica el objetivo previsto de una comunicación Weave (también conocido como "par"), junto con un conjunto de parámetros de configuración que describen cómo debe tener lugar la comunicación con el par. 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 aplicaciones deben configurar un enlace con parámetros específicos para el tipo de canal de comunicación deseado. 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 configurar un enlace utiliza un estilo API declarativo que permite que las aplicaciones establezcan sus requisitos para la comunicación en términos simples.

Consulte la documentación de Binding :: Configuration para obtener más detalles.

Preparación

Antes de que tenga lugar la comunicación, se debe "preparar" un enlace . El acto de preparar un Encuadernación implica establecer el estado necesario para que se produzca la comunicación. 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 configurado por la aplicación, el enlace se encarga de todos los pasos necesarios para preparar la comunicación y vuelve a llamar a la aplicación cuando se completa el proceso. De esta manera, los Bindings ocultan la mecánica de la comunicación, lo que permite que las aplicaciones se concentren en las interacciones de alto nivel.

Comunicación

Una vez que se ha preparado una encuadernación , está lista para su uso. En este estado, las aplicaciones (o más comúnmente, el código de capa de protocolo que trabaja en nombre de una aplicación) solicitan al enlace que asigne un contexto de intercambio de tejido. 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 solicitando contextos de intercambio de la vinculación hasta que se cierre la vinculación , o algún evento, por ejemplo, un fallo de red, finalice el canal de comunicación subyacente.

Cambios de estado vinculantes

Durante el transcurso de su uso, un enlace entregará eventos de API a la aplicación informándole de los cambios en el estado del enlace . Por ejemplo, cuando la preparación tiene éxito, la aplicación recibirá un evento informándole que el enlace está listo para su uso. De manera similar, si falla el canal de comunicación subyacente, se envía un evento a la aplicación informándole que el enlace ya no está en el estado listo.

Los eventos de la API se envían a la aplicación a través de una función de devolución de llamada de eventos proporcionada cuando se asigna el enlace .

Enlace de por vida

Los enlaces se cuentan por referencias para permitir el uso compartido entre varios componentes de software. Cuando una unión se asigna, se crea una sola referencia a la unión. La aplicación es responsable de publicar esta referencia en algún momento en el futuro, de modo que el enlace sea ​​gratuito para su posterior reutilización.

Cuando una aplicación termina con un enlace , puede llamar a Close () en el enlace. Esto libera la referencia de la aplicación al enlace y bloquea toda entrega posterior de eventos de API. Cuando se libera la última referencia a un enlace , 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
)