nl::Weave::Profiles::BDX_Development::SendInit

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

הודעת SendInit משמשת להתחלת החלפה כשהשולח הוא שיוזם ההזמנה.

סיכום

ירושה

מחלקות משנה מוכרות ישירות: nl::Weave::Profiles::BDX_Development::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
True אם ההיסט והאורך הם 64 ביט.

פונקציות ציבוריות
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.

סוגים ציבוריים

MetaDataTLVWriteCallback

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
אירעה שגיאה כלשהי.

מאפיינים ציבוריים

mAsynchronousModeSupported

bool mAsynchronousModeSupported

True אם יש תמיכה במצב אסינכרוני.

mDefiniteLength

bool mDefiniteLength

הערך הוא True אם שדה האורך קיים.

mFileDesignator

ReferencedString mFileDesignator

מחרוזת שמכילה מידע שנקבע מראש.

mLength

uint64_t mLength

אורך מוצע של נתונים בהעברה, 0 למשך מספר בלתי מוגבל.

mMaxBlockSize

uint16_t mMaxBlockSize

גודל הבלוק המקסימלי שהוצע לשימוש בהעברה.

mMetaData

ReferencedTLVData mMetaData

מטא-נתונים אופציונליים של TLV.

mMetaDataAppState

void * mMetaDataAppState

מצב אופציונלי של האפליקציה למטא-נתונים של TLV.

mMetaDataWriteCallback

MetaDataTLVWriteCallback mMetaDataWriteCallback

פונקציה אופציונלית לכתיבה של מטא-נתונים TLV.

mReceiverDriveSupported

bool mReceiverDriveSupported

True אם יש תמיכה בנהיגה של המקבל.

mSenderDriveSupported

bool mSenderDriveSupported

True אם יש תמיכה בנהיגה של שולחים.

mStartOffset

uint64_t mStartOffset

קיזוז ההתחלה המוצע של הנתונים.

mStartOffsetPresent

bool mStartOffsetPresent

הערך יהיה True אם שדה היסט ההתחלה קיים.

mVersion

uint8_t mVersion

הגרסה של פרוטוקול BDX שעליו החלטנו.

mWideRange

bool mWideRange

True אם ההיסט והאורך הם 64 ביט.

פונקציות ציבוריות

SendInit

 SendInit(
  void
)

להתחיל

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 אם הפעולה בוצעה בהצלחה

להתחיל

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 אם הפעולה בוצעה בהצלחה

להתחיל

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 אם הפעולה בוצעה בהצלחה

להתחיל

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 נוספת שאפשר להשוות אליה את ההודעה הזו
החזרות
true אם יש להם את כל השדות האלה.

חבילה

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

אורזים הודעת שליחה התחלתית לתוך PacketBuffer.

פרטים
פרמטרים
[out] aBuffer
PacketBuffer כדי לדחוס את הודעת SendInit בתוכה
מוחזר ערכים
WEAVE_NO_ERROR
אם הפעולה בוצעה בהצלחה
WEAVE_ERROR_BUFFER_TOO_SMALL
אם מאגר הנתונים הזמני קטן מדי

packedLength

uint16_t packedLength(
  void
)

הפונקציה מחזירה את אורך האריזה של הודעת send init זו.

פרטים
החזרות
אורך ההודעה כשהיא ארוזה

פונקציות סטטיות ציבוריות

לנתח

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  SendInit & aRequest
)

ניתוח נתונים מ-PacketBuffer לפורמט של הודעת SendInit.

פרטים
פרמטרים
[in] aBuffer
להצביע אל PacketBuffer שמכיל את הנתונים שאנחנו רוצים לנתח
[out] aRequest
מצביעים על אובייקט SendInit שבו נאחסן את התוצאות
מוחזר ערכים
WEAVE_NO_ERROR
אם הפעולה בוצעה בהצלחה
WEAVE_ERROR_BUFFER_TOO_SMALL
אם מאגר הנתונים הזמני קטן מדי