nl::Weave::Profiles::BDX_Development::BdxProtocol

概要

関数
HandleConnectionClosed(ExchangeContext *anEc, WeaveConnection *aCon, WEAVE_ERROR aConErr)
void
接続自体が終了したときのハンドラ。
HandleKeyError(ExchangeContext *anEc, WEAVE_ERROR aKeyErr)
void
Weave メッセージの暗号化と認証に使用する鍵が使用できなくなったときのハンドラ。
HandleResponse(ExchangeContext *anEc, const IPPacketInfo *aPktInfo, const WeaveMessageInfo *aWeaveMsgInfo, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer *aPacketBuffer)
void
BDX 交換に到着するメッセージのメインハンドラ。
HandleResponseNotAccepted(BDXTransfer & aXfer, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer *aPacketBuffer)
HandleResponseReceive(BDXTransfer & aXfer, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer *aPacketBuffer)
HandleResponseTimeout(ExchangeContext *anEc)
void
レスポンスの待機をタイムアウトしたときのハンドラ。
HandleResponseTransmit(BDXTransfer & aXfer, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer *aPacketBuffer)
HandleSendError(ExchangeContext *anEc, WEAVE_ERROR aSendErr, void *aMsgCtxt)
void
Google が送信した WRMP メッセージが確認応答されなかったときのハンドラ。
InitBdxReceive(BDXTransfer & aXfer, bool aICanDrive, bool aUCanDrive, bool aAsyncOk, ReferencedTLVData *aMetaData)
InitBdxSend(BDXTransfer & aXfer, bool aICanDrive, bool aUCanDrive, bool aAsyncOk, ReferencedTLVData *aMetaData)
InitBdxSend(BDXTransfer & aXfer, bool aICanDrive, bool aUCanDrive, bool aAsyncOk, SendInit::MetaDataTLVWriteCallback aMetaDataWriteCallback, void *aMetaDataAppState)
SendBadBlockCounterStatusReport(BDXTransfer & aXfer)
SendBlockAckV1(BDXTransfer & aXfer)
この関数は、指定された BDXTransfer に対して BlockAckV1 メッセージを送信します。
SendBlockEOFAckV1(BDXTransfer & aXfer)
この関数は、指定された BDXTransfer に対して BlockEOFAckV1 メッセージを送信します。
SendBlockQuery(BDXTransfer & aXfer)
SendBlockQueryV1(BDXTransfer & aXfer)
この関数は、指定された BDXTransfer に対して BlockQueryV1 メッセージを送信します。
SendNextBlock(BDXTransfer & aXfer)
SendNextBlockV1(BDXTransfer & aXfer)
この関数は、BDXTransfer の GetBlockHandler を呼び出して取得した次の BlockSendV1 を送信します。
SendStatusReport(ExchangeContext *anEc, uint32_t aProfileId, uint16_t aStatusCode)
void
関連付けられたプロフィール ID、ステータス コード、エクスチェンジのコンテキストを含むステータス レポートのメッセージを送信します。
SendTransferError(ExchangeContext *anEc, uint32_t aProfileId, uint16_t aStatusCode)
void

関数

HandleConnectionClosed

void HandleConnectionClosed(
  ExchangeContext *anEc,
  WeaveConnection *aCon,
  WEAVE_ERROR aConErr
)

接続自体が終了したときのハンドラ。

関連する転送のエラーハンドラを呼び出し、転送をシャットダウンします。

詳細
パラメータ
[in] anEc
Exchange コンテキストが閉じた接続を検出しました。関連する BDXTransfer は、
[in] aCon
実際の関数では使用されない Weave 接続
[in] aConErr
接続の終了に関連するエラー

HandleKeyError

void HandleKeyError(
  ExchangeContext *anEc,
  WEAVE_ERROR aKeyErr
)

Weave メッセージの暗号化と認証に使用する鍵が使用できなくなったときのハンドラ。

詳細
パラメータ
[in] anEc
主なエラーを検出したエクスチェンジ コンテキスト。関連する BDXTransfer はここから確認できます。
[in] aKeyErr
キーが使用できなくなったことに関連するエラー

HandleResponse

void HandleResponse(
  ExchangeContext *anEc,
  const IPPacketInfo *aPktInfo,
  const WeaveMessageInfo *aWeaveMsgInfo,
  uint32_t aProfileId,
  uint8_t aMessageType,
  PacketBuffer *aPacketBuffer
)

BDX 交換に到着するメッセージのメインハンドラ。

基本的には、適切な BDX ヘッダー情報とデータを抽出するルーターとして機能し、このオブジェクトを操作する適切なハンドラをディスパッチします。

詳細
パラメータ
[in] anEc
必要な場合のエクスチェンジのコンテキスト
[in] aPktInfo
未使用だが、関数のプロトタイプと一致する必要がある
[in] aWeaveMsgInfo
メッセージの Weave メッセージ情報
[in] aProfileId
メッセージが定義されているプロファイルの ID
[in] aMessageType
プロファイルのメッセージタイプ
[in] aPacketBuffer
パックされたメッセージ自体

HandleResponseNotAccepted

WEAVE_ERROR HandleResponseNotAccepted(
  BDXTransfer & aXfer,
  uint32_t aProfileId,
  uint8_t aMessageType,
  PacketBuffer *aPacketBuffer
)

HandleResponseReceive

WEAVE_ERROR HandleResponseReceive(
  BDXTransfer & aXfer,
  uint32_t aProfileId,
  uint8_t aMessageType,
  PacketBuffer *aPacketBuffer
)

HandleResponseTimeout

void HandleResponseTimeout(
  ExchangeContext *anEc
)

レスポンスの待機をタイムアウトしたときのハンドラ。

タイムアウトした転送をシャットダウンし、その転送のエラーハンドラを呼び出します。

詳細
パラメータ
[in] anEc
コンテキストを交換します。ここから、BDXTransfer を確認できます。

HandleResponseTransmit

WEAVE_ERROR HandleResponseTransmit(
  BDXTransfer & aXfer,
  uint32_t aProfileId,
  uint8_t aMessageType,
  PacketBuffer *aPacketBuffer
)

HandleSendError

void HandleSendError(
  ExchangeContext *anEc,
  WEAVE_ERROR aSendErr,
  void *aMsgCtxt
)

Google が送信した WRMP メッセージが確認応答されなかったときのハンドラ。

詳細
パラメータ
[in] anEc
未確認メッセージのある Exchange コンテキスト。関連する BDXTransfer は、
[in] aSendErr
メッセージ送信失敗に関連するエラー
[in] aMsgCtxt
未確認メッセージに関連付けられた任意のメッセージ コンテキスト。

InitBdxReceive

WEAVE_ERROR InitBdxReceive(
  BDXTransfer & aXfer,
  bool aICanDrive,
  bool aUCanDrive,
  bool aAsyncOk,
  ReferencedTLVData *aMetaData
)

InitBdxSend

WEAVE_ERROR InitBdxSend(
  BDXTransfer & aXfer,
  bool aICanDrive,
  bool aUCanDrive,
  bool aAsyncOk,
  ReferencedTLVData *aMetaData
)

InitBdxSend

WEAVE_ERROR InitBdxSend(
  BDXTransfer & aXfer,
  bool aICanDrive,
  bool aUCanDrive,
  bool aAsyncOk,
  SendInit::MetaDataTLVWriteCallback aMetaDataWriteCallback,
  void *aMetaDataAppState
)

SendBadBlockCounterStatusReport

WEAVE_ERROR SendBadBlockCounterStatusReport(
  BDXTransfer & aXfer
)

SendBlockAckV1

WEAVE_ERROR SendBlockAckV1(
  BDXTransfer & aXfer
)

この関数は、指定された BDXTransfer に対して BlockAckV1 メッセージを送信します。

この関数は、転送状態が次のカウンタに進んだ後にのみ呼び出すことができるため、確認応答されたブロック番号は aXfer.mBlockCounter - 1 になります。

詳細
パラメータ
[in] aXfer
BlockAck を送信する対象の BDXTransfer。
戻り値
WEAVE_NO_ERROR
メッセージが正常に送信されたかどうか。
WEAVE_ERROR_NO_MEMORY
利用可能な PacketBuffers がない場合。

SendBlockEOFAckV1

WEAVE_ERROR SendBlockEOFAckV1(
  BDXTransfer & aXfer
)

この関数は、指定された BDXTransfer に対して BlockEOFAckV1 メッセージを送信します。

確認応答されたブロック番号が aXfer.mBlockCounter と等しい。

詳細
パラメータ
[in] aXfer
BlockEOFAck を送信する対象の BDXTransfer。
戻り値
WEAVE_NO_ERROR
メッセージが正常に送信されたかどうか。
WEAVE_ERROR_NO_MEMORY
利用可能な PacketBuffers がない場合。

SendBlockQuery

WEAVE_ERROR SendBlockQuery(
  BDXTransfer & aXfer
)

SendBlockQueryV1

WEAVE_ERROR SendBlockQueryV1(
  BDXTransfer & aXfer
)

この関数は、指定された BDXTransfer に対して BlockQueryV1 メッセージを送信します。

リクエストされたブロック番号が aXfer.mBlockCounter と等しい。

詳細
パラメータ
[in] aXfer
送信する BDXTransfer の BlockQuery エラー。
戻り値
WEAVE_NO_ERROR
メッセージが正常に送信されたかどうか。
WEAVE_ERROR_NO_MEMORY
利用可能な PacketBuffers がない場合。

SendNextBlock

WEAVE_ERROR SendNextBlock(
  BDXTransfer & aXfer
)

SendNextBlockV1

WEAVE_ERROR SendNextBlockV1(
  BDXTransfer & aXfer
)

この関数は、BDXTransfer の GetBlockHandler を呼び出して取得した次の BlockSendV1 を送信します。

詳細
パラメータ
[in] aXfer
関連する ExchangeContext を使用して送信する前に次のブロックを取得するために GetBlockHandler が呼び出される BDXTransfer。
戻り値
WEAVE_ERROR_INCORRECT_STATE
GetBlockHandler が NULL の場合

SendStatusReport

void SendStatusReport(
  ExchangeContext *anEc,
  uint32_t aProfileId,
  uint16_t aStatusCode
)

関連付けられたプロフィール ID、ステータス コード、エクスチェンジのコンテキストを含むステータス レポートのメッセージを送信します。

詳細
パラメータ
[in] anEc
ステータス レポートのメッセージを送信するエクスチェンジのコンテキスト
[in] aProfileId
プロファイル ID
[in] aStatusCode
転送エラーに関連するコード

SendTransferError

void SendTransferError(
  ExchangeContext *anEc,
  uint32_t aProfileId,
  uint16_t aStatusCode
)