nl::Weave::Profiles::BDX_Development::BlockQuery

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

تُستخدَم رسالة BlockQuery لطلب نقل مجموعة من البيانات من المُرسِل إلى المستلِم.

ملخّص

الاكتساب

الفئات الفرعية المعروفة مباشرةً:
  nl::Weave::Profiles::BDX_Development::BlockAck
  nl::Weave::Profiles::BDX_Development::BlockEOFAck

وظائف الإنشاء ووظائف التدمير
BlockQuery(void)
الدالة الإنشائية التي لا تتطلّب وسيطة والتي تتضمّن الإعدادات التلقائية لرسالة طلب البحث المحظورة.

الأنواع العامة
@84 تعداد

السمات العامة
mBlockCounter
uint8_t
عكس الحظر الذي نطلبه.

وظائف عامة
init(uint8_t aCounter)
ابدأ بتهيئة رسالة BlockQuery.
operator==(const BlockQuery &) const
bool
مقارنة المساواة بين رسائل BlockQuery
pack(PacketBuffer *aBuffer)
قم بحزم رسالة طلب بحث حظر في PacketBuffer.
packedLength(void)
uint16_t
لعرض الطول المُجمَّع لرسالة طلب البحث المحظورة هذه.

الدوالّ الثابتة العامة
parse(PacketBuffer *aBuffer, BlockQuery & aQuery)
تحليل البيانات من PacketBuffer إلى تنسيق الرسالة BlockQuery.

الأنواع العامة

@84

 @84

السمات العامة

mBlockCounter

uint8_t mBlockCounter

عكس الحظر الذي نطلبه.

الوظائف العامة

BlockQuery

 BlockQuery(
  void
)

أداة الإنشاء بدون وسيطات مع الإعدادات التلقائية لرسالة طلب الحظر

init

WEAVE_ERROR init(
  uint8_t aCounter
)

ابدأ رسالة BlockQuery.

التفاصيل
المعلمات
[in] aCounter
قيمة عداد الحظر المطلوب البحث عنها
المرتجعات
WEAVE_NO_ERROR في حال نجاح الإجراء

operator==

bool operator==(
  const BlockQuery &
) const

مقارنة المساواة بين رسائل BlockQuery

التفاصيل
المعلمات
[in] another
رسالة BlockQuery أخرى لمقارنة هذه الرسالة بها
المرتجعات
صحيح إذا كانت تحتوي على جميع الحقول نفسها

حزمة

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

حِزم رسالة طلب حظر في PacketBuffer

التفاصيل
المعلمات
[out] aBuffer
حزمة PacketBuffer لتجميع الرسالة BlockQuery
عرض القيم
WEAVE_NO_ERROR
في حال نجاح العملية
WEAVE_ERROR_BUFFER_TOO_SMALL
إذا كان المخزن المؤقت صغيرًا جدًا

packedLength

uint16_t packedLength(
  void
)

لعرض الطول المُجمَّع لرسالة طلب الحظر هذه.

التفاصيل
المرتجعات
طول الرسالة عند حزمتها

الدوال الثابتة العامة

تحليل

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  BlockQuery & aQuery
)

تحليل البيانات من PacketBuffer إلى تنسيق الرسالة BlockQuery

التفاصيل
المعلمات
[in] aBuffer
مؤشر إلى PacketBuffer يحتوي على البيانات التي نريد تحليلها
[out] aQuery
مؤشر إلى عنصر BlockQuery الذي يجب تخزين النتائج فيه
عرض القيم
WEAVE_NO_ERROR
في حال نجاح العملية
WEAVE_ERROR_BUFFER_TOO_SMALL
إذا كان المخزن المؤقت صغيرًا جدًا