nl::Weave::Bindung

Erfassen das gewünschte Ziel einer Weave-Kommunikation und die zugehörigen Konfigurationsinformationen

Fazit

Ein Bindungsobjekt gibt das vorgesehene Ziel einer Weave-Kommunikation (auch „&Peer“ genannt) sowie eine Reihe von Konfigurationsparametern an, die die Kommunikation mit dem Peer definieren. Bindungen sind unabhängig vom Anwendungsprotokoll, das zwischen den beiden Parteien gesprochen wird. Daher erfassen sie die Eigenschaften „wer“ und „wie“ einer Kommunikation, aber nicht „wie“.

Configuration

Apps müssen eine Bindung mit Parametern konfigurieren, die für den gewünschten Kommunikationskanaltyp relevant sind. Bindungen bieten Unterstützung für eine Vielzahl von Netzwerktransporten, einschließlich TCP, UDP, UDP mit Weave Zuverlässige Messaging und Weave über BLE (WoBLE). Außerdem können Anwendungen die Verwendung bestimmter Sicherheitsmechanismen erwirken, um Nachrichten zu schützen, die zwischen den Parteien gesendet werden. Dazu gehören CASE- und PASE-Sitzungen sowie Anwendungsgruppenschlüssel. Die Schnittstelle zum Konfigurieren einer Bindung verwendet ein deklaratives API-Design, mit dem Anwendungen ihre Anforderungen für die Kommunikation in einfachen Worten darstellen können.

Weitere Informationen finden Sie in der Dokumentation zu Bindung::Konfiguration.

Vorbereitung

Vor der Kommunikation muss eine Bindung vorab vorbereitet sein. Durch die Vorbereitung einer Bindung wird der erforderliche Status für die Kommunikation festgelegt. Sie können beispielsweise die Netzwerkadresse des Peers auflösen, eine Netzwerkverbindung herstellen und Sicherheitsschlüssel verhandeln. Sobald die Anwendung von der Bindung konfiguriert wurde, übernimmt sie alle Schritte, die für die Kommunikation erforderlich sind. Sie ruft die Anwendung zurück, wenn der Vorgang abgeschlossen ist. So wird die Kommunikation über Bindungen ausgeblendet, sodass sich die Apps auf die wichtigsten Interaktionen konzentrieren können.

Kommunikation

Sobald eine Bindung vorbereitet wurde, kann sie verwendet werden. In diesem Fall fordern Anwendungen (oder häufiger ein Protokollschichtcode, der im Auftrag einer Anwendung arbeitet) die Bindung an, um einen Weave-Exchange-Kontext zuzuweisen. Der resultierende Exchange-Kontext ist für die Kommunikation vorkonfiguriert, sodass die Anwendung sofort einen Weave-Exchange mit dem Peer starten kann. Die Anwendung kann weiterhin Exchange-Kontexte von der Bindung anfordern, bis die Bindung geschlossen wird oder ein Ereignis, z.B. ein Netzwerkausfall, den zugrunde liegenden Kommunikationskanal beendet.

Statusänderungen Bindung

Im Laufe der Verwendung werden durch eine Bindung API-Ereignisse an die Anwendung gesendet, um sie über Änderungen im Status Bindung zu informieren. Wenn die Vorbereitung erfolgreich ist, erhält die Anwendung ein Ereignis mit dem Hinweis, dass die Bindung einsatzbereit ist. Gleiches gilt, wenn der zugrunde liegende Kommunikationskanal fehlschlägt, ein Ereignis an die Anwendung gesendet wird, dass die Bindung nicht mehr im Status „Bereit“ ist.

API-Ereignisse werden über eine Ereignis-Callback-Funktion an die Anwendung gesendet, die bereitgestellt wird, wenn die Bindung zugewiesen ist.

Bindung

Bindung wird als Referenz gezählt, um die gemeinsame Verwendung über mehrere Softwarekomponenten hinweg zu ermöglichen. Wenn eine Bindung zugewiesen wird, wird ein einzelner Verweis auf die Bindung erstellt. Die Anwendung ist dafür verantwortlich, diese Referenz zu einem späteren Zeitpunkt freizugeben, sodass die Bindung zur späteren Wiederverwendung frei ist.

Wenn eine Anwendung mit einer Bindung abgeschlossen ist, kann sie Schließen() für die Bindung aufrufen. Dadurch werden die Verweise auf die Bindung freigegeben und alle weiteren API-Ereignisse werden blockiert. Wenn die letzte Referenz auf eine Bindung veröffentlicht wird, wird sie automatisch geschlossen.

Öffentliche Typen

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