nl::Weave::Binding

Erfasst das beabsichtigte Ziel einer Weave-Kommunikation und die zugehörigen Konfigurationsinformationen.

Zusammenfassung

Ein Binding-Objekt identifiziert das beabsichtigte Ziel einer Weave-Kommunikation (auch als "Peer" bezeichnet) zusammen mit einer Reihe von Konfigurationsparametern, die beschreiben, wie die Kommunikation mit dem Peer stattfinden soll. Bindungen sind unabhängig vom Anwendungsprotokoll, das zwischen den beiden Parteien gesprochen wird. Daher erfassen sie das „Wer“ und „Wie“ einer Kommunikation, aber nicht das „Was“.

Configuration

Anwendungen müssen eine Binding mit Parametern konfigurieren, die für den gewünschten Kommunikationskanal spezifisch sind. Bindungen bieten Unterstützung für eine Reihe von Netzwerktransporten, einschließlich TCP, UDP, UDP mit Weave Zuverlässiges Messaging und Weave over BLE (WoBLE). Anwendungen können auch die Verwendung bestimmter Sicherheitsmechanismen zum Schutz von Nachrichten anfordern, die zwischen den Parteien gesendet werden. Dazu gehören CASE- und PASE-Sitzungen sowie Anwendungsgruppenschlüssel. Die Schnittstelle zum Konfigurieren einer Binding verwendet einen deklarativen API-Stil, mit dem Anwendungen ihre Anforderungen an die Kommunikation in einfachen Worten angeben können.

Weitere Informationen finden Sie in der Dokumentation zu Binding::Configuration (Binding::Configuration).

Vorbereitung

Vor der Kommunikation muss eine Bindung vorbereitet werden. Bei der Vorbereitung einer Verbindlichkeit wird der erforderliche Zustand für die Kommunikation festgelegt. Dies kann Dinge wie das Auflösen der Netzwerkadresse des Peers, das Herstellen einer Netzwerkverbindung und das Aushandeln von Sicherheitsschlüsseln umfassen. Nach der Konfiguration durch die Anwendung übernimmt das Binding alle Schritte, die zur Vorbereitung der Kommunikation erforderlich sind, und ruft die Anwendung nach Abschluss des Vorgangs zurück. Auf diese Weise verbergen Bindings die Mechanismen der Kommunikation, sodass sich Anwendungen auf die allgemeinen Interaktionen konzentrieren können.

Kommunikation

Sobald eine Binding vorbereitet wurde, ist sie einsatzbereit. In diesem Status fordern Anwendungen (oder häufiger Protokollschichtcode, der im Auftrag einer Anwendung arbeitet) das Binding an, um einen Weave-Austauschkontext zuzuweisen. Der resultierende Austauschkontext ist für die Kommunikation vorkonfiguriert, sodass die Anwendung sofort einen Weave-Austausch mit dem Peer initiieren kann. Die Anwendung kann weiterhin Austauschkontexte aus der Bindung anfordern, bis die Bindung geschlossen oder ein Ereignis (z.B. ein Netzwerkfehler) den zugrunde liegenden Kommunikationskanal beendet.

Änderungen des Bindungsstatus

Bei einer Bindung werden API-Ereignisse an die Anwendung gesendet, um sie über Änderungen am Status der Bindung zu informieren. Wenn die Vorbereitung beispielsweise erfolgreich war, empfängt die Anwendung ein Ereignis, das sie darüber informiert, dass die Binding verwendet werden kann. Wenn der zugrunde liegende Kommunikationskanal fehlschlägt, wird ein Ereignis an die Anwendung gesendet, in dem sie darüber informiert wird, dass das Binding-Objekt nicht mehr im Status „Bereit“ ist.

API-Ereignisse werden über eine Ereignis-Callback-Funktion an die Anwendung gesendet, wenn das Binding zugewiesen wird.

Lebensdauer der Bindung

Bindungen werden als Referenz gezählt, um eine gemeinsame Verwendung durch mehrere Softwarekomponenten zu ermöglichen. Wenn eine Binding 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 für eine spätere Wiederverwendung kostenlos ist.

Wenn eine Anwendung mit einem Binding fertig ist, kann sie Close() für die Bindung aufrufen. Dadurch wird der Verweis der Anwendung auf die Bindung freigegeben und die weitere Übermittlung von API-Ereignissen blockiert. Wenn der letzte Verweis auf eine Binding aufgehoben wird, wird er 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
)