nl::Weave::Profiles::BDX_Development::ReceiveAccept

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

ข้อความ ReceiveAccept จะใช้เพื่อยอมรับการแลกเปลี่ยนที่เสนอเมื่อผู้รับเป็นผู้เริ่ม

สรุป

การสืบทอด

รับค่าจาก: nl::Weave::Profiles::BDX_Development::SendAccept

ผู้ผลิตและผู้ทำลาย

ReceiveAccept(void)
ตัวสร้าง No-Ar ที่มีค่าเริ่มต้นสำหรับข้อความยอมรับ

แอตทริบิวต์สาธารณะ

mDefiniteLength
bool
เป็นจริงหากเลือกความยาวที่แน่นอน
mLength
uint64_t
ระยะเวลาการโอนที่เราตัดสินใจ
mMetaData
ข้อมูลเมตา TLV (ไม่บังคับ)
mWideRange
bool
เป็นจริงถ้าฟิลด์ช่วงและออฟเซ็ตของเราเป็น 64 บิต

ฟังก์ชันสาธารณะ

init(uint8_t aVersion, uint8_t aTransferMode, uint16_t aMaxBlockSize, uint64_t aLength, ReferencedTLVData *aMetaData)
เริ่มต้น "wide" ได้รับเฟรมที่ได้รับการยอมรับ
init(uint8_t aVersion, uint8_t aTransferMode, uint16_t aMaxBlockSize, uint32_t aLength, ReferencedTLVData *aMetaData)
เริ่มต้น "ไม่ใช่แบบกว้าง" รับเฟรมที่ยอมรับ (ความยาว 32 บิต)
operator==(const ReceiveAccept &) const
bool
การเปรียบเทียบความเท่าเทียมกันระหว่างข้อความ ReceiveAccept
pack(PacketBuffer *aBuffer)
บรรจุข้อความที่ยอมรับลงใน PacketBuffer
packedLength(void)
uint16_t
แสดงความยาวที่บรรจุของข้อความการยอมรับนี้

ฟังก์ชันสาธารณะแบบคงที่

parse(PacketBuffer *aBuffer, ReceiveAccept & aResponse)
แยกวิเคราะห์ข้อมูลจาก PacketBuffer เป็นรูปแบบข้อความ ReceiveAccept

แอตทริบิวต์สาธารณะ

mDefiniteLength

bool mDefiniteLength

เป็นจริงหากเลือกความยาวที่แน่นอน

mLength

uint64_t mLength

ระยะเวลาการโอนที่เราตัดสินใจ

mMetaData

ReferencedTLVData mMetaData

ข้อมูลเมตา TLV (ไม่บังคับ)

mWideRange

bool mWideRange

เป็นจริงถ้าฟิลด์ช่วงและออฟเซ็ตของเราเป็น 64 บิต

ฟังก์ชันสาธารณะ

ReceiveAccept

 ReceiveAccept(
  void
)

ตัวสร้าง No-Ar ที่มีค่าเริ่มต้นสำหรับข้อความยอมรับ

Init

WEAVE_ERROR init(
  uint8_t aVersion,
  uint8_t aTransferMode,
  uint16_t aMaxBlockSize,
  uint64_t aLength,
  ReferencedTLVData *aMetaData
)

เริ่มต้น "wide" ได้รับเฟรมที่ได้รับการยอมรับ

รายละเอียด
พารามิเตอร์
[in] aVersion
เวอร์ชันของ BDX ที่เราใช้
[in] aTransferMode
โหมดการโอนที่จะใช้ในการโอน
[in] aMaxBlockSize
ขนาดการบล็อกสูงสุดที่อนุญาตสำหรับการโอนนี้
[in] aLength
ความยาวของไฟล์ที่จะโอน เป็น 0 หากไม่มีกำหนด
[in] aMetaData
(ไม่บังคับ) ข้อมูลเมตา TLV
การคืนสินค้า
WEAVE_NO_ERROR หากสำเร็จ

Init

WEAVE_ERROR init(
  uint8_t aVersion,
  uint8_t aTransferMode,
  uint16_t aMaxBlockSize,
  uint32_t aLength,
  ReferencedTLVData *aMetaData
)

เริ่มต้น "ไม่ใช่แบบกว้าง" รับเฟรมที่ยอมรับ (ความยาว 32 บิต)

รายละเอียด
พารามิเตอร์
[in] aVersion
เวอร์ชันของ BDX ที่เราใช้
[in] aTransferMode
โหมดการโอนที่จะใช้ในการโอน
[in] aMaxBlockSize
ขนาดการบล็อกสูงสุดที่อนุญาตสำหรับการโอนนี้
[in] aLength
ความยาวของไฟล์ที่จะโอน เป็น 0 หากไม่มีกำหนด
[in] aMetaData
(ไม่บังคับ) ข้อมูลเมตา TLV
การคืนสินค้า
WEAVE_NO_ERROR หากสำเร็จ

โอเปอเรเตอร์==

bool operator==(
  const ReceiveAccept &
) const 

การเปรียบเทียบความเท่าเทียมกันระหว่างข้อความ ReceiveAccept

รายละเอียด
พารามิเตอร์
[in] another
ข้อความ ReceiveAccept อีกข้อความหนึ่งที่จะใช้เปรียบเทียบกับข้อความนี้
การคืนสินค้า
จริง หากมีฟิลด์เหมือนกันทั้งหมด

แพ็ก

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

บรรจุข้อความที่ยอมรับลงใน PacketBuffer

รายละเอียด
พารามิเตอร์
[out] aBuffer
PacketBuffer เพื่อแพ็คข้อความ ReceiveAccept ในแพ็กเก็ต
ผลลัพธ์
WEAVE_NO_ERROR
หากสำเร็จ
WEAVE_ERROR_BUFFER_TOO_SMALL
หากบัฟเฟอร์มีขนาดเล็กเกินไป

packedLength

uint16_t packedLength(
  void
)

แสดงความยาวที่บรรจุของข้อความการยอมรับนี้

รายละเอียด
การคืนสินค้า
ความยาวของข้อความเมื่อแพ็ค

ฟังก์ชันสาธารณะแบบคงที่

แยกวิเคราะห์

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  ReceiveAccept & aResponse
)

แยกวิเคราะห์ข้อมูลจาก PacketBuffer เป็นรูปแบบข้อความ ReceiveAccept

รายละเอียด
พารามิเตอร์
[in] aBuffer
ชี้ไปที่ PacketBuffer ซึ่งมีข้อมูลที่เราต้องการแยกวิเคราะห์ออก
[out] aResponse
ชี้ไปที่ออบเจ็กต์ ReceiveAccept ที่เราควรจัดเก็บผลลัพธ์ไว้
ผลลัพธ์
WEAVE_NO_ERROR
หากสำเร็จ
WEAVE_ERROR_BUFFER_TOO_SMALL
หากบัฟเฟอร์มีขนาดเล็กเกินไป