透過集合功能整理內容 你可以依據偏好儲存及分類內容。

nl::編織::設定檔::BDX_Devment::SendInit

#include <src/lib/profiles/bulk-data-transfer/Development/BDXMessages.h>

「寄件者」訊息會在寄件者是發起者時啟動。

總結

繼承

直接已知子類別: nl::Weave::Profiles::BDX_Devment::ReceiveInit

建構函式和解構程式

SendInit(void)

公開類型

MetaDataTLVWriteCallback)(uint8_t *aBuffer, uint16_t aBufferLength, uint16_t &aNumBytesWritten, void *aAppState) typedef
MetaDataTLVWriteCallback 可讓用戶端為 SendInit 提供所有所需中繼資料的方法。

公開屬性

mAsynchronousModeSupported
bool
如果我們支援非同步模式,則為 True。
mDefiniteLength
bool
如果有長欄位,則傳回 True。
mFileDesignator
包含預先協議資訊的字串。
mLength
uint64_t
建議移轉的資料長度,無上限為 0。
mMaxBlockSize
uint16_t
要在傳輸中使用的建議區塊大小上限。
mMetaData
選填的 TLV 中繼資料。
mMetaDataAppState
void *
TLV 中繼資料的選用應用程式狀態。
mMetaDataWriteCallback
可寫入 TLV 中繼資料的選用函式。
mReceiverDriveSupported
bool
如果我們支援接收功能,則傳回 true。
mSenderDriveSupported
bool
假如我們支援寄件者導向,則傳回 True。
mStartOffset
uint64_t
資料的起始偏移。
mStartOffsetPresent
bool
如果有開始位移欄位,則傳回 true。
mVersion
uint8_t
我們決定採用的 BDX 通訊協定版本。
mWideRange
bool
偏移值與長度為 64 位元時為 True。

公開函式

init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
初始化「寬版」SendInit
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint32_t aStartOffset, uint32_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
初始化「非寬度」SendInit (32 位元起始偏移,32 位元長度)
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, MetaDataTLVWriteCallback aMetaDataWriteCallback, void *aMetaDataAppState)
初始化「寬版」SendInit
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint32_t aStartOffset, uint32_t aLength, ReferencedString & aFileDesignator, MetaDataTLVWriteCallback aMetaDataWriteCallback, void *aMetaDataAppState)
初始化「非寬度」SendInit (32 位元起始偏移,32 位元長度)
operator==(const SendInit &) const
bool
SendInit 訊息之間的平等比較。
pack(PacketBuffer *aBuffer)
將傳送初始化訊息封裝到 PacketBuffer。
packedLength(void)
uint16_t
傳回這個 Send init 訊息的封裝長度。

公開的靜態函式

parse(PacketBuffer *aBuffer, SendInit & aRequest)
將 PacketBuffer 中的資料剖析為 SendInit 訊息格式。

公開類型

中繼資料 LVWriteCallback

WEAVE_ERROR(* MetaDataTLVWriteCallback)(uint8_t *aBuffer, uint16_t aBufferLength, uint16_t &aNumBytesWritten, void *aAppState)

MetaDataTLVWriteCallback 可讓用戶端為 SendInit 提供所有所需中繼資料的方法。

用戶端可以自由提供預先編碼的 TLV (較快)、即時編碼 (減少記憶體使用量)、延遲編碼 (啟動時速度較快) 等。

在所有情況下,系統會假設某個 SendInit 針對回呼產生的資料是固定的,也就是在呼叫該呼叫時不會改變。這是因為回呼也會用於計算任何此類的書面 TLV 長度,且可能會隨時要求。

詳細資料
參數
[in] aBuffer
可以寫入部分 TLV 的目的地緩衝區
[in] aBufferLength
目標緩衝區的長度 (以位元組為單位)
[in,out] aNumBytesWritten
寫入目的地緩衝區的位元組數
[in] aAppState
使用者提供的應用程式狀態
傳回值
WEAVE_ERROR
發生任何錯誤。

公開屬性

mAsyncMode 支援

bool mAsynchronousModeSupported

如果我們支援非同步模式,則為 True。

mDefiniteLength

bool mDefiniteLength

如果有長欄位,則傳回 True。

mFileDesignator

ReferencedString mFileDesignator

包含預先協議資訊的字串。

毫秒長度

uint64_t mLength

建議移轉的資料長度,無上限為 0。

廣告大小上限上限

uint16_t mMaxBlockSize

要在傳輸中使用的建議區塊大小上限。

mMetaData

ReferencedTLVData mMetaData

選填的 TLV 中繼資料。

行動應用程式中繼資料狀態

void * mMetaDataAppState

TLV 中繼資料的選用應用程式狀態。

mMetaDataWrite 回呼

MetaDataTLVWriteCallback mMetaDataWriteCallback

可寫入 TLV 中繼資料的選用函式。

支援 mReceiverDrive

bool mReceiverDriveSupported

如果我們支援接收功能,則傳回 true。

支援寄件者雲端硬碟

bool mSenderDriveSupported

假如我們支援寄件者導向,則傳回 True。

mStart 偏移

uint64_t mStartOffset

資料的起始偏移。

mStartOffset 現在

bool mStartOffsetPresent

如果有開始位移欄位,則傳回 true。

行動版

uint8_t mVersion

我們決定採用的 BDX 通訊協定版本。

最大寬度

bool mWideRange

偏移值與長度為 64 位元時為 True。

公開函式

傳送

 SendInit(
  void
)

init

WEAVE_ERROR init(
  uint8_t aVersion,
  bool aSenderDrive,
  bool aReceiverDrive,
  bool aAsynchMode,
  uint16_t aMaxBlockSize,
  uint64_t aStartOffset,
  uint64_t aLength,
  ReferencedString & aFileDesignator,
  ReferencedTLVData *aMetaData
)

初始化「寬版」SendInit

詳細資料
參數
[in] aVersion
我們使用的 BDX 版本
[in] aSenderDrive
如果傳送者正在開車,則傳回 True
[in] aReceiverDrive
如果接收者正在開車,則傳回 true
[in] aAsynchMode
如果裝置支援非同步模式,則為 True
[in] aMaxBlockSize
針對這個轉移作業封鎖區塊大小上限的提案
[in] aStartOffset
檔案的起始處開始偏移
[in] aLength
待轉移檔案長度 - 0 表示不受長度限制
[in] aFileDesignator
可識別待轉移資料的字串
[in] aMetaData
(選用) TLV 格式的額外資料
傳回
如果成功,WEAVE_NO_ERROR

init

WEAVE_ERROR init(
  uint8_t aVersion,
  bool aSenderDrive,
  bool aReceiverDrive,
  bool aAsynchMode,
  uint16_t aMaxBlockSize,
  uint32_t aStartOffset,
  uint32_t aLength,
  ReferencedString & aFileDesignator,
  ReferencedTLVData *aMetaData
)

初始化「非寬度」SendInit (32 位元起始偏移,32 位元長度)

詳細資料
參數
[in] aVersion
我們使用的 BDX 版本
[in] aSenderDrive
如果傳送者正在開車,則傳回 True
[in] aReceiverDrive
如果接收者正在開車,則傳回 true
[in] aAsynchMode
如果裝置支援非同步模式,則為 True
[in] aMaxBlockSize
針對這個轉移作業封鎖區塊大小上限的提案
[in] aStartOffset
檔案的起始處開始偏移
[in] aLength
待轉移檔案長度 - 0 表示不受長度限制
[in] aFileDesignator
可識別待轉移資料的字串
[in] aMetaData
(選用) TLV 格式的額外資料
傳回
如果成功,WEAVE_NO_ERROR

init

WEAVE_ERROR init(
  uint8_t aVersion,
  bool aSenderDrive,
  bool aReceiverDrive,
  bool aAsynchMode,
  uint16_t aMaxBlockSize,
  uint64_t aStartOffset,
  uint64_t aLength,
  ReferencedString & aFileDesignator,
  MetaDataTLVWriteCallback aMetaDataWriteCallback,
  void *aMetaDataAppState
)

初始化「寬版」SendInit

詳細資料
參數
[in] aVersion
我們使用的 BDX 版本
[in] aSenderDrive
如果傳送者正在開車,則傳回 True
[in] aReceiverDrive
如果接收者正在開車,則傳回 true
[in] aAsynchMode
如果裝置支援非同步模式,則為 True
[in] aMaxBlockSize
針對這個轉移作業封鎖區塊大小上限的提案
[in] aStartOffset
檔案的起始處開始偏移
[in] aLength
待轉移檔案長度 - 0 表示不受長度限制
[in] aFileDesignator
可識別待轉移資料的字串
[in] aMetaDataWriteCallback
(選用) 用來寫入額外資料的 TLV 函式
[in] aMetaDataAppState
要傳遞給 aMetaDataWriteCallback 的選用內容
傳回
如果成功,WEAVE_NO_ERROR

init

WEAVE_ERROR init(
  uint8_t aVersion,
  bool aSenderDrive,
  bool aReceiverDrive,
  bool aAsynchMode,
  uint16_t aMaxBlockSize,
  uint32_t aStartOffset,
  uint32_t aLength,
  ReferencedString & aFileDesignator,
  MetaDataTLVWriteCallback aMetaDataWriteCallback,
  void *aMetaDataAppState
)

初始化「非寬度」SendInit (32 位元起始偏移,32 位元長度)

詳細資料
參數
[in] aVersion
我們使用的 BDX 版本
[in] aSenderDrive
如果傳送者正在開車,則傳回 True
[in] aReceiverDrive
如果接收者正在開車,則傳回 true
[in] aAsynchMode
如果裝置支援非同步模式,則為 True
[in] aMaxBlockSize
針對這個轉移作業封鎖區塊大小上限的提案
[in] aStartOffset
檔案的起始處開始偏移
[in] aLength
待轉移檔案長度 - 0 表示不受長度限制
[in] aFileDesignator
可識別待轉移資料的字串
[in] aMetaDataWriteCallback
(選用) 用來寫入額外資料的 TLV 函式
[in] aMetaDataAppState
(選用) 要回傳至回呼函式的內容
傳回
如果成功,WEAVE_NO_ERROR

運算子 =

bool operator==(
  const SendInit &
) const 

SendInit 訊息之間的平等比較。

詳細資料
參數
[in] another
另一個 SendInit 訊息,將該則與
傳回
因為它們都具有相同的欄位

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

將傳送初始化訊息封裝到 PacketBuffer。

詳細資料
參數
[out] aBuffer
SendInit 訊息封裝的 PacketBuffer
傳回值
WEAVE_NO_ERROR
如果成功
WEAVE_ERROR_BUFFER_TOO_SMALL
如果緩衝區太小

封包長度

uint16_t packedLength(
  void
)

傳回這個 Send init 訊息的封裝長度。

詳細資料
傳回
打包後

公開的靜態函式

parse

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  SendInit & aRequest
)

將 PacketBuffer 中的資料剖析為 SendInit 訊息格式。

詳細資料
參數
[in] aBuffer
指向擁有我們剖析資料的 PacketBuffer 指標
[out] aRequest
指向 SendInit 物件的指標,其應儲存結果
傳回值
WEAVE_NO_ERROR
如果成功
WEAVE_ERROR_BUFFER_TOO_SMALL
如果緩衝區太小