nl::Weave::Binding

Przechwytuje zamierzony cel komunikacji Weave i powiązane informacje o konfiguracji.

Podsumowanie

Obiekt Binding określa zamierzone miejsce docelowe komunikacji Weave (zwanej też „peerem”), wraz z zbiorem parametrów konfiguracji opisujących, jak powinna następować komunikacja z elementem równorzędnym. Powiązania są niezależne od protokołu aplikacji wymienianego między stronami. Dzięki temu zbierają dane na temat tego, oraz instrukcji komunikacji, ale nie „co”.

Konfiguracja

Aplikacje muszą skonfigurować Wiązanie z parametrami specyficznymi dla wybranego typu kanału komunikacji. Powiązania zapewniają obsługę różnych rodzajów transportu sieciowego, w tym TCP, UDP, UDP z weave Reliable Messaging i Weave over BLE (WoBLE). Aplikacje mogą również prosić o zastosowanie określonych mechanizmów zabezpieczeń do ochrony wiadomości przesyłanych między stronami. Obejmują one sesje CASE i PASE oraz klucze grup aplikacji. Interfejs do konfigurowania Wiązania używa deklaratywnego stylu interfejsu API, który umożliwia aplikacjom określanie wymagań dotyczących komunikacji w prosty sposób.

Więcej informacji znajdziesz w dokumentacji raportu Binding::Configuration (Wiązanie::Konfiguracja).

Przygotowanie

Przed rozpoczęciem komunikacji Wiązanie należy przygotować. Czynności związane z przygotowaniem Wiązania obejmują ustalenie stanu niezbędnego do przeprowadzenia komunikacji. Może to obejmować na przykład rozpoznawanie adresu sieciowego peera, nawiązanie połączenia sieciowego i negocjowanie kluczy bezpieczeństwa. Po skonfigurowaniu go przez aplikację funkcja Wiązanie wykonuje wszystkie czynności niezbędne do przygotowania komunikacji, a po jej zakończeniu wywołuje aplikację. W ten sposób powiązania ukrywają mechanikę komunikacji, dzięki czemu aplikacje mogą skoncentrować się na interakcjach wysokiego poziomu.

Komunikacja

Po przygotowaniu wiązania jest ono gotowe do użycia. W takim stanie aplikacje (lub częściej kod warstwy protokołu działający w imieniu aplikacji) żądają ustawienia Wiązanie, aby przydzielić kontekst giełdy Weave. Wynikowy kontekst wymiany jest wstępnie skonfigurowany pod kątem komunikacji, dzięki czemu aplikacja może natychmiast zainicjować wymianę Weave z peerem. Aplikacja może nadal żądać kontekstów wymiany z poziomu Wiązania do momentu zamknięcia Wiązania lub do chwili zamknięcia podstawowego kanału komunikacyjnego, np. awarii sieci.

Zmiany stanu wiązania

W trakcie użytkowania Wiązanie będzie dostarczać do aplikacji zdarzenia interfejsu API informujące ją o zmianach stanu Wiązania. Jeśli na przykład przygotowanie się powiedzie, aplikacja otrzyma zdarzenie informujące, że Wiązanie jest gotowe do użycia. I podobnie, jeśli podstawowy kanał komunikacji ulegnie awarii, do aplikacji zostanie przesłane zdarzenie z informacją, że Wiązanie nie jest już w stanie gotowości.

Zdarzenia interfejsu API są dostarczane do aplikacji za pomocą funkcji wywołania zwrotnego zdarzenia, która jest dostarczana po przydzieleniu wartości Wiązanie.

Czas trwania wiązania

Wiązania są liczone jako pliki referencyjne, co umożliwia wspólne korzystanie z wielu komponentów oprogramowania. Po przydzieleniu powiązania Wiązanie jest tworzone pojedyncze odwołanie do powiązania. Aplikacja będzie zobowiązana do opublikowania tego pliku referencyjnego w przyszłości, tak aby Wiązanie było bezpłatne do późniejszego wykorzystania.

Gdy aplikacja obsługuje Wiązanie, może wywołać metodę Close() w przypadku powiązania. Spowoduje to zwolnienie odniesienia aplikacji do wartości Wiązanie i zablokowanie dalszego przesyłania zdarzeń interfejsu API. Zamknięcie ostatniego odwołania do Wiązania powoduje jego automatyczne zamknięcie.

Typy publiczne

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