nl::Weave::WeaveConnection

[読み取り専用] ピアノードの IP アドレス。

[読み取り専用] ピアのノード ID。

[読み取り専用] ピアノードのポート番号。

[読み取り専用] 受信が有効な場合は true、そうでない場合は false です。

この接続を介して送信されるすべてのメッセージに明示的にエンコードされた宛先ノード識別子を含める必要がある場合は true、そうでない場合は false です。

この接続を介して送信されるすべてのメッセージに、明示的にエンコードされた送信元ノード識別子を含める必要がある場合は true、そうでない場合は false です。

[読み取り専用] WeaveConnection オブジェクトの状態。

TCP ベースまたは BLE ベースの WeaveConnection の正常でない終了を実行し、ピアとの間で送受信されている可能性のあるデータをすべて破棄します。

Abort() を呼び出すと、基盤となる接続が直ちに終了します。この時点以降、WeaveConnection オブジェクトは通信に使用できなくなります。

Abort() を呼び出すと、WeaveConnection オブジェクトに関連付けられた参照数が減ります。このカウントは、メソッドが呼び出された時点で接続がオープン状態またはアクティブになっていたかどうかに関係なく減ります。その結果、参照数がゼロに達すると、接続オブジェクトに関連付けられているリソースが解放されます。この場合、アプリはそれ以上オブジェクトとやり取りできないようにする必要があります。

WeaveConnection オブジェクトへの参照を予約します。

AddRef() メソッドは、WeaveConnection オブジェクトに関連付けられた参照カウントを増分します。AddRef() を呼び出すたびに、対応する Release()、Close()、Abort() のいずれかの呼び出しがアプリケーションによって行われます。

TCP ベースまたは BLE ベースの WeaveConnection の非ブロッキング グレースフル クローズを実行します。残りの送信データをすべて配信してから、接続をリセットしたことをリモートホストに通知します。

この方法では、アプリケーション プロトコル レベルで確認応答されていない送信メッセージがリモートピアで受信されたことを保証できません。TCP と BLE のどちらも、基盤となるプロトコル スタックは、接続をリセットする前に保留中の送信データを可能な限り配信します。TCP の場合、接続を閉じる前にトランスポート レイヤのメッセージ受信の確認が必要な場合は、Close() の前に Shutdown() を使用する必要があります。BLE 接続には Shutdown() 同等のものはありません。

BLE ベースの接続の場合、Close() は WeaveConnection を閉じてすぐに戻りますが、すべての送信データが送信されるまで、基盤となる BLEEndPoint オブジェクトが残る可能性があります。これは Weave BleLayer 内に存在する Weave over BLE トランスポート プロトコル実装の副作用です。

Close() が呼び出されると、その後の通信に WeaveConnection オブジェクトを使用することはできません。

Close() を呼び出すと、WeaveConnection オブジェクトに関連付けられた参照数が減ります。このカウントは、メソッドが呼び出された時点で接続がオープン状態またはアクティブになっていたかどうかにかかわりません。その結果、参照数がゼロに達すると、接続オブジェクトに関連付けられているリソースが解放されます。この場合、アプリはそれ以上オブジェクトとやり取りできないようにする必要があります。

TCP ベースまたは BLE ベースの WeaveConnection の非ブロッキング グレースフル クローズを実行します。残りの送信データをすべて配信してから、接続をリセットしたことをリモートホストに通知します。

この方法では、アプリケーション プロトコル レベルで確認応答されていない送信メッセージがリモートピアで受信されたことを保証できません。TCP と BLE のどちらも、基盤となるプロトコル スタックは、接続をリセットする前に保留中の送信データを可能な限り配信します。TCP の場合、接続を閉じる前にトランスポート レイヤのメッセージ受信の確認が必要な場合は、Close() の前に Shutdown() を使用する必要があります。BLE 接続には Shutdown() 同等のものはありません。

BLE ベースの接続の場合、Close() は WeaveConnection を閉じてすぐに戻りますが、すべての送信データが送信されるまで、基盤となる BLEEndPoint オブジェクトが残る可能性があります。これは Weave BleLayer 内に存在する Weave over BLE トランスポート プロトコル実装の副作用です。

Close() が呼び出されると、その後の通信に WeaveConnection オブジェクトを使用することはできません。

Close() を呼び出すと、WeaveConnection オブジェクトに関連付けられた参照数が減ります。このカウントは、メソッドが呼び出された時点で接続がオープン状態またはアクティブになっていたかどうかにかかわりません。その結果、参照数がゼロに達すると、接続オブジェクトに関連付けられているリソースが解放されます。この場合、アプリはそれ以上オブジェクトとやり取りできないようにする必要があります。

指定したノード ID から派生したファブリック IP アドレスを使用して、Weave ノードに接続します。

ノード ID や IP アドレスを使用して Weave ノードに接続します。

特定のインターフェースでノード ID や IP アドレスを使用して、Weave ノードに接続します。

ノード ID や文字列のホスト名を使用して、Weave ノードに接続します。

指定する場合、PeerAddr は次のいずれかになります。

:

:

[]:

ノード ID や文字列のピアアドレスを使用して、Weave ノードに接続します。

指定する場合、PeerAddr は次のいずれかになります。

:

:

[]:

ノード ID や文字列のピアアドレスを使用して、Weave ノードに接続します。

指定する場合、PeerAddr は次のいずれかになります。

:

:

[]:

ノード識別子やホスト名とポートのリストを使用して、Weave ノードに接続します。

ノード識別子やホスト名とポートのリストを使用して、Weave ノードに接続します。

WeaveConnection::DisableKeepAlive

基盤となる TCP 接続で TCP キープアライブ プローブを無効にします。

注: このメソッドは、TCP 接続を基盤とする Weave 接続でのみ呼び出すことができます。このメソッドは、接続が送信を許可する状態の場合にのみ呼び出すことができます。

接続でキープアライブが有効になっていない場合、このメソッドは何も行いません。

この WeaveConnection 経由の受信を無効にします。

このメソッドは、TCP 接続で到着したデータを受信する準備ができていないことを示すために、アプリケーションによって使用されます。受信機能を再度有効にするには、アプリで EnableReceive() を呼び出し、適切なコールバックを呼び出して、WeaveConnection が受信データを引き渡せるようにする必要があります。

WeaveConnection::EnableKeepAlive

基盤となる TCP 接続で TCP キープアライブ プローブを有効にします。

注: - このメソッドは、TCP 接続を基盤とする Weave 接続でのみ呼び出すことができます。- このメソッドは、接続が送信を許可されている状態にある場合にのみ呼び出すことができます。

- キープアライブ間隔またはタイムアウト数を調整するために、このメソッドを複数回呼び出すことができます。

この WeaveConnection 経由の受信を有効にします。

このメソッドは、TCP 接続で受信したデータを受信する準備ができたことを WeaveConnection オブジェクトに伝えるために、アプリケーションによって使用されます。

ピアの IP アドレス情報を取得します。

接続に関連付けられているピアノードを記述する文字列を作成します。

IsIncoming

bool IsIncoming(
  void
) const 

uint16_t LogId(
  void
) const 

void Release(
  void
)

WEAVE_ERROR ResetUserTimeout(
  void
)

WEAVE_ERROR SendMessage(
  WeaveMessageInfo *msgInfo,
  PacketBuffer *msgBuf
)

WEAVE_ERROR SendTunneledMessage(
  WeaveMessageInfo *msgInfo,
  PacketBuffer *msgBuf
)

void SetConnectTimeout(
  const uint32_t connTimeoutMsecs
)

WEAVE_ERROR SetIdleTimeout(
  uint32_t timeoutMS
)

void SetIncoming(
  bool val
)

WEAVE_ERROR SetUserTimeout(
  uint32_t userTimeoutMillis
)

WEAVE_ERROR Shutdown(
  void
)