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 אם אנחנו יכולים לתמוך ב-Drive של השולח.
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)
אורזים הודעת send init לתוך PacketBuffer.
packedLength(void)
uint16_t
הפונקציה מחזירה את האורך הארוז של הודעת השליחה הפנימית.

פונקציות סטטיות ציבוריות
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 אם אנחנו יכולים לתמוך ב-Drive של השולח.

mStartOffset

uint64_t mStartOffset

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

mStartOffsetPresent

bool mStartOffsetPresent

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

mVersion

uint8_t mVersion

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

mWideRange

bool mWideRange

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

תפקידים ציבוריים

SendInit

 SendInit(
  void
)

init

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

init

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

init

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

init

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

חבילה

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

אורזים הודעת send init לתוך PacketBuffer.

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

packedLength

uint16_t packedLength(
  void
)

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

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

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

parse

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  SendInit & aRequest
)

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

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