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

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

Các BlockSend thông điệp được sử dụng để chuyển một khối dữ liệu từ người gửi đến người nhận.

Tóm lược

Di sản

Inherits từ: nl :: Weave :: Profiles :: RetainedPacketBuffer
Chỉ đạo lớp con biết: nl :: Weave :: Profiles :: BDX_Development :: BlockEOF

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

BlockSend (void)
Hàm tạo không đối số với các giá trị mặc định cho thông điệp gửi khối.

Thuộc tính công khai

mBlockCounter
uint8_t
Counter của khối này đang được gửi.
mData
uint8_t *
Con trỏ đến dữ liệu được nhận hoặc chuyển.
mLength
uint64_t
Độ dài của dữ liệu có trong khối này.

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

init (uint8_t aCounter, uint64_t aLength, uint8_t *aData)
Khởi tạo một BlockSend nhắn.
operator== (const BlockSend &) const
bool
Bình đẳng so sánh giữa BlockSend tin nhắn.
packedLength (void)
uint16_t
Trả về độ dài đóng gói của thông điệp gửi khối này.

Các chức năng tĩnh công khai

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

Thuộc tính công khai

mBlockCounter

uint8_t mBlockCounter

Counter của khối này đang được gửi.

mData

uint8_t * mData

Con trỏ đến dữ liệu được nhận hoặc chuyển.

mLength

uint64_t mLength

Độ dài của dữ liệu có trong khối này.

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

BlockSend

 BlockSend(
  void
)

Hàm tạo không đối số với các giá trị mặc định cho thông điệp gửi khối.

trong đó

WEAVE_ERROR init(
  uint8_t aCounter,
  uint64_t aLength,
  uint8_t *aData
)

Khởi tạo một BlockSend nhắn.

Chi tiết
Thông số
[in] aCounter
Giá trị bộ đếm khối cho khối này
[in] aLength
Chiều dài của khối
[in] aData
Trỏ đến dữ liệu được chuyển
Lợi nhuận
WEAVE_NO_ERROR nếu thành công

toán tử ==

bool operator==(
  const BlockSend &
) const

Bình đẳng so sánh giữa BlockSend tin nhắn.

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

đóng gói

uint16_t packedLength(
  void
)

Trả về độ dài đóng gói của thông điệp gửi khối này.

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

Các chức năng tĩnh công khai

phân tích cú pháp

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  BlockSend & aResponse
)

Dữ liệu phân tích cú pháp từ một PacketBuffer thành một BlockSend định dạng tin nhắn.

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] aResponse
Con trỏ đến một BlockSend đối tượng mà chúng ta nên lưu trữ các 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ỏ