nl::Weave::Binding

Weave 通信の意図するターゲットと、関連する設定情報をキャプチャします。

概要

Binding オブジェクトは、Weave 通信のターゲット（「ピア」とも呼ばれます）を、ピアとの通信方法を記述する一連の構成パラメータとともに指定します。バインディングは、両者間でやり取りされるアプリケーション プロトコルに依存しません。つまり、「どのように」「何を」ではなく「何」というのかです。

構成

アプリケーションでは、目的の通信チャネルのタイプに応じたパラメータを使用してバインディングを構成する必要があります。バインディングは、TCP、UDP、Weave Reliable Messaging を使用した UDP、Weave over BLE（WoBLE）など、さまざまなネットワーク トランスポートをサポートしています。アプリケーションは、当事者間で送信されるメッセージを保護するために、特定のセキュリティ メカニズムの使用をリクエストすることもできます。これには、CASE セッションと PASE セッション、アプリケーション グループ キーが含まれます。Binding を構成するインターフェースは宣言型 API スタイルを使用します。このスタイルでは、アプリケーションが通信の要件を簡単な言葉で記述できます。

詳細については、Binding::Configuration のドキュメントをご覧ください。

準備

通信が行われる前に、Binding を「準備」する必要があります。バインディングを準備する作業には、通信が行われるために必要な状態を確立することが含まれます。これには、ピアのネットワーク アドレスの解決、ネットワーク接続の確立、セキュリティ キーのネゴシエーションなどが含まれます。アプリケーションによって設定されると、Binding は通信の準備に必要なすべてのステップを行い、プロセスが完了するとアプリケーションにコールバックします。このように、バインディングは通信の仕組みを隠し、アプリは高度なインタラクションに集中できます。

コミュニケーション

Binding の準備が整うと、使用できるようになります。この状態では、アプリケーション（より一般的にはアプリケーションに代わって動作するプロトコル レイヤ コード）は、Weave 交換コンテキストを割り当てるように Binding をリクエストします。結果として得られる交換コンテキストは通信用に事前構成されているため、アプリケーションはすぐにピアとの Weave 交換を開始できます。Binding が閉じられるか、なんらかのイベント（ネットワーク障害など）によって基盤となる通信チャネルが終了するまで、アプリケーションは Binding から交換コンテキストを要求し続けることができます。

バインディング状態の変化

Binding は、その使用過程で、アプリケーションに API イベントを配信し、Binding の状態の変化を通知します。たとえば、準備に成功すると、アプリケーションは Binding が使用可能になったことを通知するイベントを受け取ります。同様に、基盤となる通信チャネルに障害が発生した場合、イベントがアプリケーションに配信され、Binding が準備完了状態ではなくなったことが通知されます。

API イベントは、Binding が割り当てられたときに指定されるイベント コールバック関数を介してアプリに配信されます。

バインディングの有効期間

バインディングは、複数のソフトウェア コンポーネント間で共有するためにカウントされる参照です。Binding が割り当てられると、バインディングへの単一の参照が作成されます。Binding が後で再利用できるように、この参照を将来的にリリースする責任はアプリにあります。

Binding を指定して実行したアプリは、バインディングで Close() を呼び出すことができます。これにより、アプリケーションの Binding へのリファレンスが解放され、以降の API イベントの配信はすべてブロックされます。Binding への最後の参照が解放されると、自動的に閉じます。

公開タイプ

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