nl::Weave::バインディング

Weave 通信の意図されたターゲットと関連する構成情報をキャプチャします。

まとめ

Binding オブジェクトは、Weave 通信（または「ピア」とも呼ばれます）の意図されるターゲットと、ピアとの通信方法を示す一連の構成パラメータを識別します。バインディングは、両者間で行われるアプリケーション プロトコルとは無関係です。つまり、「コミュニケーション」の「人物」と「方法」は測定されますが、「何を」は取得されません。

構成

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

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

準備

コミュニケーションを行う前に、バインディングを「準備」する必要があります。バインディングの準備とは、通信を行うために必要な状態を確立することです。たとえば、ピアのネットワーク アドレスの解決、ネットワーク接続の確立、セキュリティ キーの交渉などです。アプリによって構成されると、バインディングによって通信の準備に必要なすべてのステップが処理され、プロセスが完了するとアプリケーションにコールバックします。このように、バインディングは通信の仕組みを隠すため、アプリケーションは大まかなやり取りに集中できます。

コミュニケーション

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

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

使用している間、Binding は API イベントをアプリケーションに送信し、Binding の状態の変化を知らせます。たとえば、準備が成功すると、アプリは、バインディングの準備ができたことを通知するイベントを受け取ります。同様に、基盤となる通信チャネルで障害が発生すると、バインディングが準備完了状態ではなくなったことをアプリケーションが通知します。

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

Binding ライフタイム

バインディングは、複数のソフトウェア コンポーネント間で共有可能な参照としてカウントします。Binding が割り当てられると、バインディングへの単一の参照が作成されます。後で再利用できるように Binding が無料になるように、ある時点でこの参照をリリースする責任はアプリケーションにあります。

バインディングを使用してアプリケーションが完了すると、バインディングで Close() を呼び出すことができます。これにより、アプリケーションのバインディングへの参照が解放され、それ以降は 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
)