nl::Weave::Binding

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

Resumen

Un objeto Binding identifica el destino previsto de una comunicación de Weave (también conocida como "intercambio de tráfico"), junto con un conjunto de parámetros de configuración que describen cómo debe ocurrir la comunicación con el par. Las vinculaciones son independientes del protocolo de aplicación que se habla entre las dos partes. Así, capturan "quién" y el "cómo" de una comunicación, pero no el "qué".

Configuration

Las aplicaciones deben configurar una vinculación con parámetros específicos para el tipo de canal de comunicación deseado. Las vinculaciones proporcionan compatibilidad con un rango de transportes de red, incluidos TCP, UDP, UDP con mensajes confiables de Weave y Weave a través de BLE (WoBLE). Las aplicaciones también pueden solicitar el uso de mecanismos de seguridad específicos para proteger los mensajes enviados entre las partes. Entre ellas, se incluyen las sesiones CASE y PASE, además de las claves de grupo de aplicaciones. La interfaz para configurar una vinculación usa un estilo de API declarativo que permite a las aplicaciones indicar sus requisitos para la comunicación en términos simples.

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

Preparación

Antes de llevar a cabo la comunicación, se debe "preparar" una Vinculación. El acto de preparar una vinculación implica establecer el estado necesario para que se produzca la comunicación. Esto puede incluir tareas como resolver la dirección de red del intercambio de tráfico, establecer una conexión de red y negociar llaves de seguridad. Una vez que la aplicación la configura, la vinculación se encarga de todos los pasos necesarios para prepararse para la comunicación y vuelve a llamar a la aplicación cuando se completa el proceso. De esta manera, las vinculaciones ocultan la mecánica de la comunicación, lo que permite a las aplicaciones concentrarse en las interacciones de alto nivel.

Comunicación

Una vez que se haya preparado una Binding, estará lista para usarse. En este estado, las aplicaciones (o, más comúnmente, el código de la capa de protocolo que funciona en nombre de una aplicación) solicitan la vinculación para asignar un contexto de intercambio de Weave. El contexto de intercambio resultante viene preconfigurado para la comunicación, lo que permite que la aplicación inicie de inmediato 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 hasta que algún evento, p.ej., una falla de la red, cancele el canal de comunicación subyacente.

Cambios de estado de la vinculación

En el transcurso de su uso, una vinculación entregará eventos de API a la aplicación informándole de los cambios en el estado de la vinculación. Por ejemplo, cuando la preparación se realiza correctamente, la aplicación recibirá un evento que le informa que la Binding está lista para usarse. De manera similar, si el canal de comunicación subyacente falla, se entrega un evento a la aplicación que le informa que la Binding ya no está lista.

Los eventos de la API se entregan a la aplicación a través de una función de devolución de llamada de evento que se proporciona cuando se asigna la Binding.

Duración de la vinculación

Las vinculaciones se cuentan como referencias para permitir el uso compartido entre varios componentes de software. Cuando se asigna una Vinculación, se crea una única referencia a la vinculación. La aplicación es responsable de liberar esta referencia en algún momento en el futuro, de modo que la Binding sea gratuita para su posterior reutilización.

Cuando una aplicación finaliza con una Binding, puede llamar a Close() en la vinculación. Esto libera la referencia de la aplicación a la vinculación y bloquea todas las demás entregas de eventos de la API. Cuando se libera la última referencia a una Binding, esta 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
)