nl::Weave::Binding

Capture la cible prévue d'une communication Weave et les informations de configuration associées.

Résumé

Un objet Binding identifie la cible d'une communication Weave (également appelée "peer") ainsi qu'un ensemble de paramètres de configuration décrivant le mode de communication avec le pair. Les liaisons sont indépendantes du protocole d'application parlé entre les deux parties. Ainsi, ils capturent le « qui » et le « comment » d'une communication, mais pas le « quoi ».

Configuration

Les applications doivent configurer une liaison avec des paramètres spécifiques au type de canal de communication souhaité. Les liaisons prennent en charge toute une gamme de transports réseau, y compris TCP, UDP, UDP avec Weave Expect Messaging et Weave over BLE (WoBLE). Les applications peuvent également demander l'utilisation de mécanismes de sécurité spécifiques pour protéger les messages échangés entre les parties. Il s'agit des sessions CASE et PASE, ainsi que des clés de groupe d'applications. L'interface de configuration d'une liaison utilise un style d'API déclaratif qui permet aux applications d'indiquer leurs exigences de communication en termes simples.

Pour en savoir plus, consultez la documentation sur Binding::Configuration.

Préparation

Avant la communication, une liaison doit être "préparée". La préparation d'une liaison implique d'établir l'état nécessaire à la communication. Il peut s'agir de résoudre l'adresse réseau du pair, d'établir une connexion réseau et de négocier des clés de sécurité. Une fois configurée par l'application, la liaison effectue toutes les étapes nécessaires à la préparation de la communication, en rappelant l'application une fois le processus terminé. De cette manière, les liaisons masquent le mécanisme de communication, ce qui permet aux applications de se concentrer sur les interactions de haut niveau.

Communication

Une fois qu'une Binding a été préparée, elle peut être utilisée. Dans cet état, les applications (ou, plus généralement, le code de couche de protocole travaillant pour le compte d'une application) demandent la liaison pour allouer un contexte d'échange Weave. Le contexte d'échange qui en résulte est préconfiguré pour la communication, ce qui permet à l'application d'initier immédiatement un échange Weave avec le pair. L'application peut continuer à demander des contextes d'échange à partir de la liaison jusqu'à ce que la liaison soit fermée ou qu'un événement (par exemple, une défaillance du réseau) mette fin au canal de communication sous-jacent.

Changements d'état de Liaison

Au cours de son utilisation, une liaison fournira des événements d'API à l'application pour l'informer des modifications de l'état de la liaison. Par exemple, une fois la préparation terminée, l'application reçoit un événement l'informant que la liaison est prête à être utilisée. De même, si le canal de communication sous-jacent échoue, un événement est envoyé à l'application pour l'informer que la liaison n'est plus à l'état "prêt".

Les événements d'API sont transmis à l'application via une fonction de rappel d'événement fournie lorsque la Binding est allouée.

Durée de vie de Binding

Les liaisons sont comptabilisées comme des références pour permettre une utilisation partagée entre plusieurs composants logiciels. Lorsqu'une liaison est allouée, une référence unique à la liaison est créée. L'application est tenue de publier cette référence à l'avenir afin que la liaison soit libre pour une réutilisation ultérieure.

Lorsqu'une application a terminé avec une Binding, elle peut appeler Close() sur la liaison. La référence de l'application à la Liaison est alors libérée et toute diffusion ultérieure d'événements d'API est bloquée. Lorsque la dernière référence à une liaison est libérée, elle est automatiquement fermée.

Types publics

 @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
)