Google cam kết thúc đẩy công bằng chủng tộc cho Cộng đồng người da đen. Xem cách thực hiện.
Trang này được dịch bởi Cloud Translation API.
Switch to English

nl :: Dệt :: Hồ sơ :: BDX_Development :: SendInit

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

Thông điệp SendInit được sử dụng để bắt đầu trao đổi khi người gửi là người khởi tạo.

Tóm lược

Di sản

Các lớp con đã biết trực tiếp: nl :: Weave :: Profiles :: BDX_Development :: ReceiveInit

Người xây dựng và Người phá hủy

SendInit (void)

Các loại công khai

MetaDataTLVWriteCallback )(uint8_t *aBuffer, uint16_t aBufferLength, uint16_t &aNumBytesWritten, void *aAppState) typedef
MetaDataTLVWriteCallback cung cấp một phương tiện mà khách hàng có thể cung cấp cho SendInit bất kỳ siêu dữ liệu nào họ muốn.

Thuộc tính công cộng

mAsynchronousModeSupported
bool
Đúng nếu chúng tôi có thể hỗ trợ chế độ không đồng bộ.
mDefiniteLength
bool
Đúng nếu có trường độ dài.
mFileDesignator
Chuỗi chứa thông tin thương lượng trước.
mLength
uint64_t
Độ dài đề xuất của dữ liệu khi truyền, 0 cho thời gian không xác định.
mMaxBlockSize
uint16_t
Kích thước khối tối đa được đề xuất để sử dụng trong quá trình chuyển.
mMetaData
Siêu dữ liệu TLV tùy chọn.
mMetaDataAppState
void *
Trạng thái ứng dụng tùy chọn cho Siêu dữ liệu TLV .
mMetaDataWriteCallback
Chức năng tùy chọn để ghi Siêu dữ liệu TLV .
mReceiverDriveSupported
bool
Đúng nếu chúng tôi có thể hỗ trợ ổ đĩa nhận.
mSenderDriveSupported
bool
Đúng nếu chúng tôi có thể hỗ trợ ổ người gửi.
mStartOffset
uint64_t
Khoảng bù bắt đầu được đề xuất của dữ liệu.
mStartOffsetPresent
bool
Đúng nếu có trường độ lệch đầu.
mVersion
uint8_t
Phiên bản của giao thức BDX mà chúng tôi đã quyết định.
mWideRange
bool
Đúng nếu độ lệch và độ dài là 64 bit.

Chức năng công cộng

init (uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
Khởi tạo một SendInit "rộng".
init (uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint32_t aStartOffset, uint32_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
Khởi tạo SendInit "không rộng" (độ lệch bắt đầu 32 bit, độ dài 32 bit)
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)
Khởi tạo một SendInit "rộng".
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)
Khởi tạo SendInit "không rộng" (độ lệch bắt đầu 32 bit, độ dài 32 bit)
operator== (const SendInit &) const
bool
So sánh bình đẳng giữa các tin nhắn SendInit .
pack (PacketBuffer *aBuffer)
Đóng gói một tin nhắn gửi init vào một PacketBuffer.
packedLength (void)
uint16_t
Trả về độ dài đóng gói của tin nhắn init gửi này.

Chức năng tĩnh công khai

parse (PacketBuffer *aBuffer, SendInit & aRequest)
Phân tích cú pháp dữ liệu từ PacketBuffer thành định dạng tin nhắn SendInit .

Các loại công khai

MetaDataTLVWriteCallback

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

MetaDataTLVWriteCallback cung cấp một phương tiện mà khách hàng có thể cung cấp cho SendInit bất kỳ siêu dữ liệu nào họ muốn.

Khách hàng có thể tự do cung cấp TLV được mã hóa trước (nhanh hơn), mã hóa nhanh (sử dụng ít bộ nhớ hơn), mã hóa lười (nhanh hơn một lít khi khởi động), v.v. khi họ thấy phù hợp.

Trong mọi trường hợp, người ta giả định rằng dữ liệu được tạo ra bởi lệnh gọi lại là không đổi đối với một SendInit nhất định, tức là không thay đổi bất kể khi nào nó được gọi. Điều này là do lệnh gọi lại cũng được sử dụng để tính độ dài của bất kỳ TLV viết ra nào như vậy, có thể được yêu cầu bất kỳ lúc nào.

Chi tiết
Thông số
[in] aBuffer
Bộ đệm đích, trong đó một số TLV có thể được viết
[in] aBufferLength
Độ dài (tính bằng byte) của bộ đệm đích
[in,out] aNumBytesWritten
Số byte được ghi vào bộ đệm đích
[in] aAppState
Trạng thái ứng dụng do người dùng cung cấp
Giá trị trả lại
WEAVE_ERROR
Bất kỳ lỗi nào gặp phải.

Thuộc tính công cộng

mAsynchronousModeSupported

bool mAsynchronousModeSupported

Đúng nếu chúng tôi có thể hỗ trợ chế độ không đồng bộ.

mDefiniteLength

bool mDefiniteLength

Đúng nếu có trường độ dài.

mFileDesignator

ReferencedString mFileDesignator

Chuỗi chứa thông tin thương lượng trước.

mLength

uint64_t mLength

Độ dài đề xuất của dữ liệu khi truyền, 0 cho thời gian không xác định.

mMaxBlockSize

uint16_t mMaxBlockSize

Kích thước khối tối đa được đề xuất để sử dụng trong quá trình chuyển.

mMetaData

ReferencedTLVData mMetaData

Siêu dữ liệu TLV tùy chọn.

mMetaDataAppState

void * mMetaDataAppState

Trạng thái ứng dụng tùy chọn cho Siêu dữ liệu TLV .

mMetaDataWriteCallback

MetaDataTLVWriteCallback mMetaDataWriteCallback

Chức năng tùy chọn để ghi Siêu dữ liệu TLV .

mReceiverDriveSupported

bool mReceiverDriveSupported

Đúng nếu chúng tôi có thể hỗ trợ ổ đĩa nhận.

mSenderDriveSupported

bool mSenderDriveSupported

Đúng nếu chúng tôi có thể hỗ trợ ổ đĩa người gửi.

mStartOffset

uint64_t mStartOffset

Khoảng bù bắt đầu được đề xuất của dữ liệu.

mStartOffsetPresent

bool mStartOffsetPresent

Đúng nếu trường offset bắt đầu có.

mVersion

uint8_t mVersion

Phiên bản của giao thức BDX mà chúng tôi đã quyết định.

mWideRange

bool mWideRange

Đúng nếu độ lệch và độ dài là 64 bit.

Chức năng công cộng

SendInit

 SendInit(
  void
)

trong đó

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
)

Khởi tạo một SendInit "rộng".

Chi tiết
Thông số
[in] aVersion
Phiên bản BDX mà chúng tôi đang sử dụng
[in] aSenderDrive
Đúng nếu người gửi đang lái xe
[in] aReceiverDrive
Đúng nếu người nhận đang lái xe
[in] aAsynchMode
Đúng nếu thiết bị hỗ trợ chế độ không đồng bộ
[in] aMaxBlockSize
Đề xuất kích thước khối tối đa cho lần chuyển này
[in] aStartOffset
Bắt đầu bù đắp trong tệp mà chúng ta nên bắt đầu ở
[in] aLength
Độ dài của tệp sẽ được chuyển - 0 có nghĩa là tệp có độ dài không xác định
[in] aFileDesignator
Một chuỗi xác định dữ liệu sẽ được chuyển
[in] aMetaData
(tùy chọn) Dữ liệu bổ sung ở định dạng TLV
Lợi nhuận
WEAVE_NO_ERROR nếu thành công

trong đó

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
)

Khởi tạo SendInit "không rộng" (độ lệch bắt đầu 32 bit, độ dài 32 bit)

Chi tiết
Thông số
[in] aVersion
Phiên bản BDX mà chúng tôi đang sử dụng
[in] aSenderDrive
Đúng nếu người gửi đang lái xe
[in] aReceiverDrive
Đúng nếu người nhận đang lái xe
[in] aAsynchMode
Đúng nếu thiết bị hỗ trợ chế độ không đồng bộ
[in] aMaxBlockSize
Đề xuất kích thước khối tối đa cho lần chuyển này
[in] aStartOffset
Bắt đầu bù đắp trong tệp mà chúng ta nên bắt đầu tại
[in] aLength
Độ dài của tệp sẽ được chuyển - 0 có nghĩa là tệp có độ dài không xác định
[in] aFileDesignator
Một chuỗi xác định dữ liệu sẽ được chuyển
[in] aMetaData
(tùy chọn) Dữ liệu bổ sung ở định dạng TLV
Lợi nhuận
WEAVE_NO_ERROR nếu thành công

trong đó

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
)

Khởi tạo một SendInit "rộng".

Chi tiết
Thông số
[in] aVersion
Phiên bản BDX mà chúng tôi đang sử dụng
[in] aSenderDrive
Đúng nếu người gửi đang lái xe
[in] aReceiverDrive
Đúng nếu người nhận đang lái xe
[in] aAsynchMode
Đúng nếu thiết bị hỗ trợ chế độ không đồng bộ
[in] aMaxBlockSize
Đề xuất kích thước khối tối đa cho lần chuyển này
[in] aStartOffset
Bắt đầu bù đắp trong tệp mà chúng ta nên bắt đầu ở
[in] aLength
Độ dài của tệp sẽ được chuyển - 0 có nghĩa là tệp có độ dài không xác định
[in] aFileDesignator
Một chuỗi xác định dữ liệu sẽ được chuyển
[in] aMetaDataWriteCallback
(tùy chọn) Một chức năng để ghi ra dữ liệu bổ sung ở định dạng TLV
[in] aMetaDataAppState
Một ngữ cảnh tùy chọn được chuyển vào aMetaDataWriteCallback
Lợi nhuận
WEAVE_NO_ERROR nếu thành công

trong đó

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
)

Khởi tạo SendInit "không rộng" (độ lệch bắt đầu 32 bit, độ dài 32 bit)

Chi tiết
Thông số
[in] aVersion
Phiên bản BDX mà chúng tôi đang sử dụng
[in] aSenderDrive
Đúng nếu người gửi đang lái xe
[in] aReceiverDrive
Đúng nếu người nhận đang lái xe
[in] aAsynchMode
Đúng nếu thiết bị hỗ trợ chế độ không đồng bộ
[in] aMaxBlockSize
Đề xuất kích thước khối tối đa cho lần chuyển này
[in] aStartOffset
Bắt đầu bù đắp trong tệp mà chúng ta nên bắt đầu ở
[in] aLength
Độ dài của tệp sẽ được chuyển - 0 có nghĩa là tệp có độ dài không xác định
[in] aFileDesignator
Một chuỗi xác định dữ liệu sẽ được chuyển
[in] aMetaDataWriteCallback
(tùy chọn) Một chức năng để ghi ra dữ liệu bổ sung ở định dạng TLV
[in] aMetaDataAppState
(tùy chọn) Một ngữ cảnh được chuyển lại vào hàm gọi lại
Lợi nhuận
WEAVE_NO_ERROR nếu thành công

toán tử ==

bool operator==(
  const SendInit &
) const 

So sánh bình đẳng giữa các tin nhắn SendInit .

Chi tiết
Thông số
[in] another
Một tin nhắn SendInit khác để so sánh tin nhắn này với
Lợi nhuận
true iff họ có tất cả các trường giống nhau.

đóng gói

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

Đóng gói một tin nhắn gửi init vào một PacketBuffer.

Chi tiết
Thông số
[out] aBuffer
Một PacketBuffer để đóng gói thông điệp SendInit trong
Giá trị trả lại
WEAVE_NO_ERROR
Nếu thành công
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu bộ đệm quá nhỏ

đóng gói

uint16_t packedLength(
  void
)

Trả về độ dài đóng gói của tin nhắn init gửi này.

Chi tiết
Lợi nhuận
độ dài của tin nhắn khi đóng gói

Chức năng tĩnh công khai

phân tích cú pháp

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  SendInit & aRequest
)

Phân tích dữ liệu từ PacketBuffer thành định dạng tin nhắn SendInit .

Chi tiết
Thông số
[in] aBuffer
Trỏ tới một PacketBuffer có dữ liệu mà chúng tôi muốn phân tích cú pháp
[out] aRequest
Trỏ tới một đối tượng SendInit nơi chúng ta sẽ lưu trữ kết quả
Giá trị trả lại
WEAVE_NO_ERROR
Nếu thành công
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu bộ đệm quá nhỏ