nl::Weave::Binding

Erfasst das beabsichtigte Ziel einer Weave-Kommunikation und zugehörige 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 erfolgen soll. Bindungen sind unabhängig vom Anwendungsprotokoll, das zwischen den beiden Parteien gesprochen wird. So erfassen sie das „Wer“, und das „Wie“ Kommunikation, aber nicht das „Was“.

Configuration

Anwendungen müssen eine Binding mit Parametern konfigurieren, die für den gewünschten Kommunikationskanal spezifisch sind. Bindungen unterstützen eine Reihe von Netzwerktransporten, einschließlich TCP, UDP, UDP mit Weave Reliable Messaging und Weave over BLE (WoBLE). Anwendungen können auch den Einsatz bestimmter Sicherheitsmechanismen anfordern, 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 Binding verwendet einen deklarativen API-Stil, über den Anwendungen ihre Anforderungen an die Kommunikation einfach formulieren können.

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

Vorbereitung

Bevor eine Kommunikation stattfindet, muss eine Bindung vorbereitet werden. Bei der Vorbereitung einer Bindung wird der erforderliche Status für die Kommunikation geschaffen. Dazu gehören beispielsweise das Auflösen der Netzwerkadresse des Peers, das Herstellen einer Netzwerkverbindung und das Aushandeln von Sicherheitsschlüsseln. Nach der Konfiguration durch die Anwendung übernimmt die Binding alle Schritte, die zur Vorbereitung der Kommunikation erforderlich sind. Nach Abschluss des Vorgangs wird die Anwendung aufgerufen. Auf diese Weise verbergen Bindungen die Kommunikationsmechanismen, sodass sich Anwendungen auf die übergeordneten Interaktionen konzentrieren können.

Kommunikation

Sobald eine Binding vorbereitet wurde, ist sie einsatzbereit. In diesem Zustand fordern Anwendungen (oder häufiger Protokollschichtcode, der für eine 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 wird oder ein Ereignis (z.B. ein Netzwerkfehler) den zugrunde liegenden Kommunikationskanal beendet.

Statusänderungen der Bindung

Im Laufe der Verwendung stellt ein Binding API-Ereignisse an die Anwendung bereit, um sie über Änderungen am Status der Bindung zu informieren. Wenn die Vorbereitung erfolgreich ist, erhält die Anwendung beispielsweise ein Ereignis, das sie darüber informiert, dass das Binding einsatzbereit ist. Wenn der zugrunde liegende Kommunikationskanal fehlschlägt, wird ein Ereignis an die Anwendung gesendet, um sie darüber zu informieren, dass die Binding nicht mehr im Status „Ready“ (Bereit) ist.

API-Ereignisse werden der Anwendung über eine Ereignis-Callback-Funktion gesendet, die beim Zuweisen der Binding bereitgestellt wird.

Bindunglebensdauer

Bindungen werden als Referenz gezählt, um die gemeinsame Nutzung über mehrere Softwarekomponenten hinweg zu ermöglichen. Wenn eine Binding zugewiesen wird, wird ein einzelner Verweis auf die Bindung erstellt. Die Anwendung ist dafür verantwortlich, diese Referenz an einem bestimmten Punkt in der Zukunft freizugeben, sodass die Bindung später kostenlos wiederverwendet werden kann.

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