nl::Weave::Profiles::DataManagement_Current

מרחב השמות הזה כולל את כל הממשקים ב-Weave של פרופיל ניהול הנתונים ב-Weave (WDM) שנתמכים כרגע לשימוש בסביבת הייצור.

סיכום

ערכים של ספירה
@100{
  kTag_Region = 1,
  kTag_Message = 2
} 		טיפוסים בני מנייה (enum)
תגים של kNestDebug_StringLogEntryEvent.
@101{
  kTag_Token = 1,
  kTag_Args = 2
} 		טיפוסים בני מנייה (enum)
תגים של kNestDebug_TokenizedLogEntryEvent.
@102 טיפוסים בני מנייה (enum)
תגים לאירועים קבועים.
@104 טיפוסים בני מנייה (enum)
סוגי ההודעות בפרופיל WDM.
@105 טיפוסים בני מנייה (enum)
קודי סטטוס ספציפיים ל-WDM.
@147 טיפוסים בני מנייה (enum)
@95{
  kTag_CurrentImportance = 1,
  kTag_ImportanceExpiration,
  kTag_MinimumLogUploadInterval,
  kTag_MaximumLogUploadInterval,
  kTag_LoggingDestination,
  kTag_TraitLoggingImportance
} 		טיפוסים בני מנייה (enum)
תגי הגדרות רישום ביומן.
@96{
  kTag_SupportedLogTransports = 1,
  kTag_SupportsStreaming = 2,
  kTag_SupportsNonVolatileStorage = 3,
  kTag_SupportsPerTraitVerbosity = 4,
  kTag_LoggingVolume = 5,
  kTag_LogBufferingCapacity = 6
} 		טיפוסים בני מנייה (enum)
תגים ליכולות רישום ביומן.
@97{
  kTag_EventSource = 1,
  kTag_EventImportance = 2,
  kTag_EventID = 3,
  kTag_RelatedEventImportance = 10,
  kTag_RelatedEventID = 11,
  kTag_EventUTCTimestamp = 12,
  kTag_EventSystemTimestamp = 13,
  kTag_EventResourceID = 14,
  kTag_EventTraitProfileID = 15,
  kTag_EventTraitInstanceID = 16,
  kTag_EventType = 17,
  kTag_EventDeltaUTCTime = 30,
  kTag_EventDeltaSystemTime = 31,
  kTag_EventData = 50,
  kTag_ExternalEventStructure = 99
} 		טיפוסים בני מנייה (enum)
תגים למטא-נתונים של אירועים.
@98 טיפוסים בני מנייה (enum)
הגדרות הפרופיל לתכונת ניפוי הבאגים.
@99{
  kNestDebug_StringLogEntryEvent = 1,
  kNestDebug_TokenizedLogEntryEvent = 2,
  kNestDebug_TokenizedHeaderEntryEvent = 3
} 		טיפוסים בני מנייה (enum)
סוגי אירועים של תכונת ניפוי הבאגים ב-Nest.
CommandFlags{
  kCommandFlag_MustBeVersionValid = 0x0001,
  kCommandFlag_InitiationTimeValid = 0x0002,
  kCommandFlag_ActionTimeValid = 0x0004,
  kCommandFlag_ExpiryTimeValid = 0x0008,
  kCommandFlag_IsOneWay = 0x0010
} 		טיפוסים בני מנייה (enum)
ImportanceType{
  ProductionCritical = 1,
  Production,
  Info,
  Debug
} 		טיפוסים בני מנייה (enum)
החשיבות של הרשומה ביומן.
LoggingManagementStates{
  kLoggingManagementState_Idle = 1,
  kLoggingManagementState_InProgress = 2,
  kLoggingManagementState_Holdoff = 3,
  kLoggingManagementState_Shutdown = 4
} 		טיפוסים בני מנייה (enum)
TimestampType טיפוסים בני מנייה (enum)
התוקף והסוג של חותמת הזמן הכלולים ב-EventOptions.

Typedefs
CommandFlags typedef
DataVersion typedef
uint64_t
EventProcessor typedef
void *
EventWriterFunct)(nl::Weave::TLV::TLVWriter &ioWriter, uint8_t inDataTag, void *appData) typedef
פונקציה שמספקת רכיב eventData למערכת המשנה לרישום אירועים ביומן.
FetchExternalEventsFunct)(EventLoadOutContext *aContext) typedef
אב טיפוס של פונקציה לאחזור נתוני אירועים באמצעות קריאה חוזרת (callback) בפלטפורמה.
GenericTraitSinkCatalog typedef
GenericTraitSourceCatalog typedef
ImportanceType typedef
החשיבות של הרשומה ביומן.
IteratorCallback)(void *aTraitInstance, TraitDataHandle aHandle, void *aContext) typedef
void(*
איטרטור של נקודת אחיזה של מאפיין.
LoggingBufferHandler)(void *inAppState, PacketBuffer *inBuffer) typedef
NotifyExternalEventsDeliveredFunct)(ExternalEvents *inEv, event_id_t inLastDeliveredEventID, uint64_t inRecipientNodeID) typedef
void(*
אב טיפוס של פונקציה להתקשרות חזרה מופעל כאשר אירועים חיצוניים נשלחים למנוי מרחוק.
NotifyExternalEventsEvictedFunct)(ExternalEvents *inEv) typedef
void(*
אב טיפוס של פונקציה לקריאה חוזרת (callback) שמופעל כאשר אירועים חיצוניים מסולקים ממאגרי הנתונים הזמניים.
PropertyDictionaryKey typedef
uint16_t
PropertyPathHandle typedef
uint32_t
PropertyPathHandle הוא גיבוב (hash) מספרי ייחודי של 32 ביט של נתיב WDM ביחס לשורש של מופע תכונה.
PropertySchemaHandle typedef
uint16_t
SchemaVersion typedef
uint16_t
SingleResourceSinkTraitCatalog typedef
SingleResourceSourceTraitCatalog typedef
TimestampType typedef
התוקף והסוג של חותמת הזמן הכלולים ב-EventOptions.
TraitDataHandle typedef
uint16_t
duration_t nl::Weave::Profiles::DataManagement_Current::duration_t
uint32_t
סוג שמשמש לתיאור משך הזמן, באלפיות השנייה.
event_id_t nl::Weave::Profiles::DataManagement_Current::event_id_t
uint32_t
הסוג של מזהה האירוע.
timestamp_t nl::Weave::Profiles::DataManagement_Current::timestamp_t
uint32_t
סוג שמשמש לתיאור חותמת הזמן באלפיות השנייה.
utc_timestamp_t nl::Weave::Profiles::DataManagement_Current::utc_timestamp_t
uint64_t
סוג שמשמש לתיאור חותמת הזמן לפי שעון UTC באלפיות השנייה.

משתנים
sInstance
sLogFileName = "topazlog"[]
char

פונקציות
BdxErrorHandler(nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer, WEAVE_ERROR aErrorCode)
void
BdxGetBlockHandler(nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer, uint64_t *aLength, uint8_t **aDataBlock, bool *aIsLastBlock)
void
BdxRejectHandler(nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer, nl::Weave::Profiles::StatusReporting::StatusReport *aReport)
void
BdxSendAcceptHandler(nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer, nl::Weave::Profiles::BulkDataTransfer::SendAccept *aSendAcceptMsg)
BdxXferDoneHandler(nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer)
void
BdxXferErrorHandler(nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer, nl::Weave::Profiles::StatusReporting::StatusReport *aXferError)
void
CreatePropertyPathHandle(PropertySchemaHandle aPropertyPathSchemaId, PropertyDictionaryKey aPropertyPathDictionaryKey)
EventWriterTLVCopy(TLVWriter & ioWriter, uint8_t inDataTag, void *appData)
פונקציית עזר שמתרגמת רכיב של נתוני אירועים שכבר עברו סריאליזציה למאגר הנתונים הזמני.
GetPropertyDictionaryKey(PropertyPathHandle aHandle)
PropertyDictionaryKey
GetPropertySchemaHandle(PropertyPathHandle aHandle)
PropertySchemaHandle
IsNullPropertyPathHandle(PropertyPathHandle aHandle)
bool
IsRootPropertyPathHandle(PropertyPathHandle aHandle)
bool
IsVersionNewer(const DataVersion & aVersion, const DataVersion & aReference)
bool
זוהי הטמעה אופטימלית של האלגוריתם להשוואת גרסאות.
IsVersionNewerOrEqual(const DataVersion & aVersion, const DataVersion & aReference)
bool
Locate(TraitDataHandle aTraitDataHandle, const TraitCatalogBase< TraitDataSink > *aDataSinkCatalog)
פונקציית כלי עזר למציאת TraitUpdatableDataSink בקטלוג של TraitDataSink.
LogEvent(const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData)
תיעוד אירוע מטופס שצורף מראש.
LogEvent(const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData, const EventOptions *inOptions)
תיעוד אירוע מטופס סריאלי מראש, עם אפשרויות נוספות.
LogEvent(const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData)
תיעוד אירוע באמצעות התקשרות חזרה.
LogEvent(const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData, const EventOptions *inOptions)
תיעוד אירוע באמצעות התקשרות חזרה, עם אפשרויות שונות.
LogFreeform(ImportanceType inImportance, const char *inFormat, ...)
LogFreeform פולט מחרוזת חופשית לרצף האירועים שמוגדר כברירת מחדל.
LookForElementWithTag(const nl::Weave::TLV::TLVReader & aSrcReader, const uint64_t aTagInApiForm, nl::Weave::TLV::TLVReader *apDstReader)
PlainTextWriter(TLVWriter & ioWriter, uint8_t inDataTag, void *appData)
פונקציית עזר להחרגת טקסט חופשי כאירוע ניפוי באגים.
PlainTextWriter(::nl::Weave::TLV::TLVWriter & ioWriter, uint8_t inDataTag, void *appData)
פונקציית עזר להחרגת טקסט חופשי כאירוע ניפוי באגים.
operator!=(const ResourceIdentifier & lhs, const ResourceIdentifier & rhs)
bool
operator==(const ResourceIdentifier & lhs, const ResourceIdentifier & rhs)
bool

שיעורים
nl::Weave::Profiles::DataManagement_Current::AlwaysAcceptDataElementAccessControlDelegate
nl::Weave::Profiles::DataManagement_Current::BuilderBase

מחלקה בסיסית למקודדים של הודעות WDM.

nl::Weave::Profiles::DataManagement_Current::CircularEventReader

TLVReader מגובה על ידי CircularEventBuffer.

nl::Weave::Profiles::DataManagement_Current::Command
nl::Weave::Profiles::DataManagement_Current::CommandSender
nl::Weave::Profiles::DataManagement_Current::GenericTraitCatalogImpl

אפליקציית Weave מספקת יישום של הממשק TraitCatalogBase לאוסף מופעים של נתוני trait שמפנים לאותו משאב.

nl::Weave::Profiles::DataManagement_Current::IDataElementAccessControlDelegate

ממשק שיוטמע על ידי מעבד מידע של רכיבי נתונים ב-NotifyRequest.

nl::Weave::Profiles::DataManagement_Current::IDirtyPathCut
nl::Weave::Profiles::DataManagement_Current::IPathFilter
nl::Weave::Profiles::DataManagement_Current::IWeavePublisherLock

ממשק שמתוכנן על ידי האפליקציה כדי לבצע סריאליזציה של הגישה למבני נתונים של מפתחות WDM.

nl::Weave::Profiles::DataManagement_Current::IWeaveWDMMutex

ממשק של אובייקט mutex.

nl::Weave::Profiles::DataManagement_Current::ListBuilderBase

מחלקה בסיסית למקודדים של הודעות WDM, שמתמחה ברכיבי מערכים של TLV כמו 'רשימות נתונים' ו'רשימות גרסאות'.

nl::Weave::Profiles::DataManagement_Current::ListParserBase

מחלקת בסיס למנתחי הודעות WDM, שמתמחה ברכיבי מערכים של TLV כמו 'רשימות נתונים' ו'רשימות גרסאות'.

nl::Weave::Profiles::DataManagement_Current::LogBDXUpload
nl::Weave::Profiles::DataManagement_Current::LoggingConfiguration

LoggingConfiguration כולל את הרכיב שניתן להגדרה של מערכת המשנה Logging של אירועים ב-Weave.

nl::Weave::Profiles::DataManagement_Current::LoggingManagement

מחלקה לניהול יומני האירועים בזיכרון.

nl::Weave::Profiles::DataManagement_Current::NotificationEngine
nl::Weave::Profiles::DataManagement_Current::ParserBase

מחלקה בסיסית למנתחי הודעות WDM.

nl::Weave::Profiles::DataManagement_Current::ResourceIdentifier

מבנה שכולל את מזהה המשאב.

nl::Weave::Profiles::DataManagement_Current::SingleResourceTraitCatalog
nl::Weave::Profiles::DataManagement_Current::SubscriptionClient
nl::Weave::Profiles::DataManagement_Current::SubscriptionEngine

זהו סינגלטון שמתארח בכל המינויים ל-WDM Next, גם בצד הלקוח וגם בצד של בעל התוכן הדיגיטלי.

nl::Weave::Profiles::DataManagement_Current::SubscriptionHandler
nl::Weave::Profiles::DataManagement_Current::TraitCatalogBase
nl::Weave::Profiles::DataManagement_Current::TraitDataSink
nl::Weave::Profiles::DataManagement_Current::TraitDataSource
nl::Weave::Profiles::DataManagement_Current::TraitSchemaEngine

מנוע הסכימה לוקח מידע על סכימה שמשויך לתכונה מסוימת, ומספק מתקנים לניתוח ולתרגום שלהם לטופס שאפשר להשתמש בו על ידי מכונות WDM.

nl::Weave::Profiles::DataManagement_Current::TraitUpdatableDataSink
nl::Weave::Profiles::DataManagement_Current::UpdateClient
nl::Weave::Profiles::DataManagement_Current::UpdateDictionaryDirtyPathCut

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

nl::Weave::Profiles::DataManagement_Current::UpdateDirtyPathFilter

סיווג שירות לסינון נתיב בזמן טיפול בהתראה.

nl::Weave::Profiles::DataManagement_Current::UpdateEncoder

האובייקט הזה מקודד מטענים ייעודיים (payloads) מסוג UpdateRequest ו-PartialUpdateRequest מסוג WDM.

nl::Weave::Profiles::DataManagement_Current::ViewClient

מבנים
nl::Weave::Profiles::DataManagement_Current::CircularEventBuffer

מאגר נתונים זמני של אירועים, שנוצר סביב nl::Weave::TLV::WeaveCircularTLVBuffer.

nl::Weave::Profiles::DataManagement_Current::ConstSchemaVersionRange
nl::Weave::Profiles::DataManagement_Current::CopyAndAdjustDeltaTimeContext

מבנה פנימי למעבר של רשימת אירועים.

nl::Weave::Profiles::DataManagement_Current::DebugLogContext
nl::Weave::Profiles::DataManagement_Current::DetailedRootSection

המבנה שמספק רזולוציה מלאה של המכונה של התכונה.

nl::Weave::Profiles::DataManagement_Current::EventEnvelopeContext

מבנה פנימי לאירועי מעבר.

nl::Weave::Profiles::DataManagement_Current::EventLoadOutContext

המבנה להעתקת רשימות של אירועים בפלט.

nl::Weave::Profiles::DataManagement_Current::EventOptions

המבנה שמספק אפשרויות לשדות האירועים השונים.

nl::Weave::Profiles::DataManagement_Current::EventSchema

המבנה שמגדיר סכימה למטא-נתונים של אירוע.

nl::Weave::Profiles::DataManagement_Current::ExternalEvents

המבנה למעקב אחר אירועים שמאוחסנים בפלטפורמה.

nl::Weave::Profiles::DataManagement_Current::LogStorageResources

מחלקה מסייעת שמשמשת לאתחול ניהול הרישום ביומן.

nl::Weave::Profiles::DataManagement_Current::ReclaimEventCtx
nl::Weave::Profiles::DataManagement_Current::SchemaVersionRange
nl::Weave::Profiles::DataManagement_Current::TraitPath
nl::Weave::Profiles::DataManagement_Current::TraitPathStore
nl::Weave::Profiles::DataManagement_Current::VersionedTraitPath

איגודים
nl::Weave::Profiles::DataManagement_Current::Timestamp

האיחוד שמספק מערכת של קבוצות אפליקציות או חותמת זמן לפי שעון UTC.

מרחבי שמות
nl::Weave::Profiles::DataManagement_Current::BaseMessageWithSubscribeId
nl::Weave::Profiles::DataManagement_Current::CustomCommand

הגדרת Command בהתאמה אישית של WDM.

nl::Weave::Profiles::DataManagement_Current::CustomCommandResponse

הגדרת תגובה של Command בהתאמה אישית ב-WDM.

nl::Weave::Profiles::DataManagement_Current::DataElement

הגדרת רכיב הנתונים של WDM.

nl::Weave::Profiles::DataManagement_Current::DataList
nl::Weave::Profiles::DataManagement_Current::Event
nl::Weave::Profiles::DataManagement_Current::EventList
nl::Weave::Profiles::DataManagement_Current::NotificationRequest
nl::Weave::Profiles::DataManagement_Current::Path

הגדרת Path של WDM.

nl::Weave::Profiles::DataManagement_Current::PathList

הגדרת רשימת הנתיב של WDM.

nl::Weave::Profiles::DataManagement_Current::Platform
nl::Weave::Profiles::DataManagement_Current::RejectionRecord
nl::Weave::Profiles::DataManagement_Current::RejectionRecordList
nl::Weave::Profiles::DataManagement_Current::StatusElement

הגדרת רכיב הסטטוס של WDM.

nl::Weave::Profiles::DataManagement_Current::StatusList
nl::Weave::Profiles::DataManagement_Current::SubscribeCancelRequest
nl::Weave::Profiles::DataManagement_Current::SubscribeConfirmRequest
nl::Weave::Profiles::DataManagement_Current::SubscribeRequest
nl::Weave::Profiles::DataManagement_Current::SubscribeResponse
nl::Weave::Profiles::DataManagement_Current::UpdateRequest

הגדרה של בקשת עדכון של WDM.

nl::Weave::Profiles::DataManagement_Current::UpdateResponse
nl::Weave::Profiles::DataManagement_Current::VersionList
nl::Weave::Profiles::DataManagement_Current::ViewRequest
nl::Weave::Profiles::DataManagement_Current::ViewResponse

ערכים של ספירה

@100

 @100

תגים של kNestDebug_StringLogEntryEvent.

מאפיינים
kTag_Message

מחרוזת שמכילה את ההודעה בפועל על תוצאות ניפוי הבאגים.

kTag_Region

קוד לא חתום של 32 סיביות שמציין את האזור ביומן, כלומר המודול שאליו מתייחסת הודעת היומן.

@101

 @101

תגים של kNestDebug_TokenizedLogEntryEvent.

מאפיינים
kTag_Args

מערך של ארגומנטים שיישלחו יחד עם הודעת האסימון.

kTag_Token

ערך לא חתום של 32 ביט שתואם לאסימון.

@102

 @102

תגים לאירועים קבועים.

@104

 @104

סוגי ההודעות בפרופיל WDM.

הערכים האלה מצוינים במפרט ניהול הנתונים.

@105

 @105

קודי סטטוס ספציפיים ל-WDM.

@147

 @147

95@

 @95

תגי הגדרות רישום ביומן.

מאפיינים
kTag_CurrentImportance

החשיבות הנוכחית של הרישום ביומן, היא מסוגImportanceType.

kTag_ImportanceExpiration

שעה, לפי שעון UTC (זמן אוניברסלי מתואם), שבו ההגדרות הנוכחיות לרישום גבוה יותר יחזרו לערכי ברירת המחדל.

kTag_LoggingDestination

כתובת URL שמציינת את היעד של העלאת היומן.

kTag_MaximumLogUploadInterval

משך זמן מקסימלי, בשניות, בין ניסיונות הפעלה אוטומטיים של העלאת יומן.

kTag_MinimumLogUploadInterval

משך זמן מינימלי, בשניות, בין ניסיונות הפעלה אוטומטיים להעלאת יומנים.

kTag_TraitLoggingImportance

מערך אופציונלי שממפה באופן סלקטיבי פרופילים שנבחרו לרמות הרישום הגבוהות יותר ביומן.

כל רכיב במערך מקבל צורה (profile,path,logging importance) שמעלה באופן סלקטיבי את רישום הרישום ביומן מקבוצת המשנה של המערכת. העדיפות הגבוהה לרישום ביומן של הפרופיל יש לה מובהקות רק כשעדיפות הרישום ביומן חורגת מהחשיבות הנוכחית, וכפופה לזמן התפוגה הזהה לחשיבות הנוכחית.

96@

 @96

תגים ליכולות רישום ביומן.

מאפיינים
kTag_LogBufferingCapacity

מספר שלם לא חתום של 32 ביט שמתאר את יכולת אגירת הנתונים ביומן ב-kB.

kTag_LoggingVolume

מספר שלם לא חתום של 32 ביט שמתאר את נפח הרישום הצפוי ביומן ב-kB ליום.

kTag_SupportedLogTransports

מגוון מנגנונים נתמכים להעברת יומנים.

kTag_SupportsNonVolatileStorage

ערך בוליאני שמציין אם המכשיר תומך באחסון יומנים לא נדיפים.

kTag_SupportsPerTraitVerbosity

ערך בוליאני שמציין אם המכשיר תומך בהגדרות דרגת המלל לפי תכונה.

kTag_SupportsStreaming

ערך בוליאני שמציין אם המכשיר תומך ביומני סטרימינג.

97@

 @97

תגים למטא-נתונים של אירועים.

לסמנטיקה המלאה של ערכי התגים אפשר לעיין במפרט של עיצוב אירועים.

מאפיינים
kTag_EventData

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

kTag_EventDeltaSystemTime

תג פנימי של WDM, הפרש הזמן מהאירוע הקודם בקידוד.

kTag_EventDeltaUTCTime

תג פנימי של WDM, הפרש הזמן מהאירוע הקודם בקידוד.

kTag_EventID

מספר הרצף של האירוע, מבוטא ככמות לא חתומה של 64 ביט.

היא חייבת להיות רציפה, קפיצות ברצף מציינות פערים באירועים.

kTag_EventImportance

חשיבות האירוע.

kTag_EventResourceID

זה שינוי אופציונלי.

הערך הוא מזהה המשאב שהאירוע קשור אליו. אם לא כוללים אותו, הערך זהה לערך של kTag_EventSource

kTag_EventSource

NodeID של המכשיר שיצר את האירוע.

kTag_EventSystemTimestamp

זה שינוי אופציונלי. חותמת הזמן של המערכת באלפיות השנייה.

kTag_EventTraitInstanceID

אופציונלי, מופע של התכונה שיצרה את האירוע.

kTag_EventTraitProfileID

חובה. מספר שלם לא חתום של 32 ביט ששווה ל-ProfileID של התכונה.

kTag_EventType

חובה. מספר שלם לא חתום של 16 ביט ששווה ל-wdl.event.id של אירוע מהסוג הזה.

kTag_EventUTCTimestamp

זה שינוי אופציונלי. חותמת זמן לפי שעון UTC של האירוע באלפיות השנייה.

kTag_ExternalEventStructure

תג פנימי לאירועים חיצוניים. לעולם אין להעביר את החוט דרך החוט, לעולם אין להשתמש בו מחוץ לספריית Weave.

kTag_RelatedEventID

זה שינוי אופציונלי.

המזהה של אירוע שהאירוע הזה קשור אליו. אם לא צוין, הערך יהיה שווה לערך של kTag_EventID.

kTag_RelatedEventImportance

זה שינוי אופציונלי.

החשיבות של האירוע הקשור. אם לא צוין, הערך שווה לערך של kTag_EventImportance.

98@

 @98

הגדרות הפרופיל לתכונת ניפוי הבאגים.

99@

 @99

סוגי אירועים של תכונת ניפוי הבאגים ב-Nest.

מאפיינים
kNestDebug_StringLogEntryEvent

אירוע של הודעת ניפוי באגים במחרוזת חופשית.

kNestDebug_TokenizedHeaderEntryEvent

אירוע של העברת פרטי הכותרת שעברו תהליך ליצירת אסימונים.

kNestDebug_TokenizedLogEntryEvent

אירוע של הודעת ניפוי באגים שהומרו לאסימונים.

CommandFlags

 CommandFlags
מאפיינים
kCommandFlag_ActionTimeValid

מגדירים מתי זמן הפעולה תקין.

kCommandFlag_ExpiryTimeValid

מגדירים מתי תפוגה תקפה.

kCommandFlag_InitiationTimeValid

צריך להגדיר מתי שעת ההתחלה תקינה.

kCommandFlag_IsOneWay

מגדירים מתי הפקודה היא חד-כיוונית.

kCommandFlag_MustBeVersionValid

מגדירים מתי השדה 'גרסה' חוקי.

ImportanceType

 ImportanceType

החשיבות של הרשומה ביומן.

החשיבות משמשת כדרך לסינון אירועים לפני שהם נפלטים בפועל ליומן. אחרי שהאירוע מופיע ביומן, לא נדרשים תנאים נוספים להסרת האירוע מהיומן. רמת החשיבות משמשת לתעדוף אחסון האירועים. אם תוסיפו אירוע בעל חשיבות גבוהה למאגר נתונים זמני לחלוטין, האירועים ירדו לפי סדר החשיבות (והגיל) כדי להתאים אותם. לכן, לרמות החשיבות יש ערך יחסי בלבד. אם מערכת משתמשת רק ברמת חשיבות אחת, האירועים מושמטים רק לפי סדר גיל, למשל מאגר נתונים זמני.

מאפיינים
Debug

חשיבות ניפוי הבאגים מציינת רשומות ביומן המעניינות את מפתחי המערכת, ומשמשת בעיקר בשלב הפיתוח.

יומני החשיבות של ניפוי הבאגים לא מביאים בחשבון את תקציבי רוחב הפס או תקציבי החשמל של המכשירים המוגבלים. לכן, צריך להשתמש בהם רק לזמן מוגבל במערכות ייצור.

Info

חשיבות המידע מציינת רשומות ביומן שמספקות תובנות וניתוחים נוספים לגבי המערכת שפועלת.

רמת הרישום ביומן של המידע עשויה לשמש לפרק זמן ארוך במערכת ייצור, או לשמש כרמת ברירת המחדל של היומן בניסוי שטח. במכשירים עם הגבלת גישה, הרשומות שמתועדות ברמת המידע צריכות להיכלל ברוחב הפס ובתקציב הזיכרון, אבל לא בתקציב האנרגיה.

Production

חשיבות הייצור מציינת את הרשומות ביומן שמשמשות למעקב השוטף והתחזוקה של הסביבה העסקית של Nest.

במכשירים מוגבלים, יש להביא בחשבון רשומות שנרשמות ביומן עם חשיבות הפקה בתקציב החשמל והזיכרון, כי אפשר לצפות שהן תמיד יירשמו ביומן ותסיר אותן מהמכשיר.

ProductionCritical

'חשיבות קריטית' לסביבת הייצור מציינת אירועים שהאובדן שלהם ישפיע ישירות על תכונות שמיועדות ללקוחות.

אפליקציות עשויות להשתמש באובדן של אירועים קריטיים לייצור כדי לציין כשל במערכת. במכשירים מוגבלים, יש להביא בחשבון רשומות שנרשמות עם 'חשיבות קריטית' לסביבת הייצור, בתקציב החשמל והזיכרון, כי אפשר לצפות שהן תמיד יירשמו ביומן ותורידו אותן מהמכשיר.

LoggingManagementStates

 LoggingManagementStates
מאפיינים
kLoggingManagementState_Holdoff

סיום העומס ביומן; אנחנו לא מפעילים מחדש את היומן עד שתוקף ההשהיה פג.

kLoggingManagementState_Idle

לא מתבצעת הסרה של עומס ביומן, העומס ביומן יכול להתחיל ללא אילוצים.

kLoggingManagementState_InProgress

מתבצעת הפחתת עומס ההתנתקות.

kLoggingManagementState_Shutdown

אין אפשרות לבצע פעולות רישום ביומן.

TimestampType

 TimestampType

התוקף והסוג של חותמת הזמן הכלולים ב-EventOptions.

Typedefs

CommandFlags

enum nl::Weave::Profiles::DataManagement_Current::CommandFlags CommandFlags

DataVersion

uint64_t DataVersion

EventProcessor

void * EventProcessor

EventWriterFunct

WEAVE_ERROR(* EventWriterFunct)(nl::Weave::TLV::TLVWriter &ioWriter, uint8_t inDataTag, void *appData)

פונקציה שמספקת רכיב eventData למערכת המשנה לרישום אירועים ביומן.

פונקציות מהסוג הזה אמורות לספק את הרכיב eventData עבור מערכת המשנה לרישום אירועים ביומן. הקריאה לפונקציות מהסוג הזה מתבצעת לאחר שמערכת המשנה של האירועים יוצרת את כל המטא-נתונים הנדרשים של האירועים. הפונקציה נקראת עם אובייקט nl::Weave::TLV::TLVWriter שאליו היא תפיק רכיב TLV יחיד שמתויג kTag_EventData; הערך של הרכיב הזה חייב להיות מבנה שמכיל את נתוני האירוע. צריך ליצור את נתוני האירוע עצמו באמצעות תגי הקשר.

פרטים
פרמטרים
[in,out] ioWriter
הפניה לאובייקט nl::Weave::TLV::TLVWriter שמשמש לעריכה טורית של נתוני אירועים.
[in] inDataTag
תג הקשר לTLV שאנחנו כותבים.
[in] appData
מצביע אל הקשר ספציפי לאפליקציה.
מוחזר ערכים
WEAVE_NO_ERROR
הצלחה.
other
שגיאה מתאימה שאותת למתקשר שלא ניתן להשלים את העיבוד הסידורי של נתוני האירוע. צריך להפיץ שגיאות מקריאות ל-ioWriter ללא מיפוי מחדש. אם הפונקציה מחזירה שגיאה מסוג כלשהו, יצירת האירוע מבוטלת והאירוע לא נכתב ביומן.
למידע נוסף:
PlainTextWriter
EventWriterTLV

FetchExternalEventsFunct

WEAVE_ERROR(* FetchExternalEventsFunct)(EventLoadOutContext *aContext)

אב טיפוס של פונקציה לאחזור נתוני אירועים באמצעות קריאה חוזרת (callback) בפלטפורמה.

בדומה ל-FetchEventsמאז, פונקציית האחזור הזו מחזירה את כל האירועים מ-EventLoadOutContext.mOutboundEventID דרך ExternalEvents.mLastEventID.

מצביע ההקשר הוא מסוג FetchExternalEventsContext. הוא כולל את EventLoadOutContext, עם כמה משתני סיוע לפורמט של ה-TLV. היא כוללת גם הפניה אל המבנה ExternalEvents (אירועים חיצוניים) שנוצר במהלך רישום הקריאה החוזרת (callback). מציין את טווח מזהה האירוע של הקריאה החוזרת.

בחזרה מהפונקציה, EventLoadOutContext.mCurrentEventID אמור לשקף את מזהה האירוע הראשון שלא נכתב בהצלחה למאגר הנתונים הזמני של TLV. הפלטפורמה צריכה לכתוב את הכותרת והנתונים של האירועים לכותב ה-TLV בפורמט הנכון, כפי שצוין בפרוטוקול EventLogging. בנוסף, הפלטפורמה צריכה לשמור על הייחודיות של האירועים וחותמות הזמן.

צריך להפיץ את כל השגיאות שקשורות ל-TLV לרמות גבוהות יותר. למשל, אם ייגמר לכם המקום במאגר הנתונים הזמני, ההודעה תישלח ואז קריאה נוספת לקריאה החוזרת (callback) לפי מזהה האירוע שיישאר.

פרטים
מוחזר ערכים
WEAVE_ERROR_NO_MEMORY
אם אין מקום לכתיבת אירועים.
WEAVE_ERROR_BUFFER_TOO_SMALL
אם אין מקום לכתיבת אירועים.
WEAVE_NO_ERROR
הצלחה.
WEAVE_END_OF_TLV
הצלחה.

GenericTraitSinkCatalog

GenericTraitCatalogImpl< TraitDataSink > GenericTraitSinkCatalog

GenericTraitSourceCatalog

GenericTraitCatalogImpl< TraitDataSource > GenericTraitSourceCatalog

ImportanceType

enum nl::Weave::Profiles::DataManagement_Current::ImportanceType ImportanceType

החשיבות של הרשומה ביומן.

החשיבות משמשת כדרך לסינון אירועים לפני שהם נפלטים בפועל ליומן. אחרי שהאירוע מופיע ביומן, לא נדרשים תנאים נוספים להסרת האירוע מהיומן. רמת החשיבות משמשת לתעדוף אחסון האירועים. אם תוסיפו אירוע בעל חשיבות גבוהה למאגר נתונים זמני לחלוטין, האירועים ירדו לפי סדר החשיבות (והגיל) כדי להתאים אותם. לכן, לרמות החשיבות יש ערך יחסי בלבד. אם מערכת משתמשת רק ברמת חשיבות אחת, האירועים מושמטים רק לפי סדר גיל, למשל מאגר נתונים זמני.

IteratorCallback

void(* IteratorCallback)(void *aTraitInstance, TraitDataHandle aHandle, void *aContext)

איטרטור של נקודת אחיזה של מאפיין.

LoggingBufferHandler

WEAVE_ERROR(* LoggingBufferHandler)(void *inAppState, PacketBuffer *inBuffer)

NotifyExternalEventsDeliveredFunct

void(* NotifyExternalEventsDeliveredFunct)(ExternalEvents *inEv, event_id_t inLastDeliveredEventID, uint64_t inRecipientNodeID)

אב טיפוס של פונקציה להתקשרות חזרה מופעל כאשר אירועים חיצוניים נשלחים למנוי מרחוק.

כשהאירועים החיצוניים נשלחים למנוי מרחוק, המנוע יציג התראה לספק האירוע החיצוני. הקריאה החוזרת מכילה את האירוע של המזהה האחרון שנמסר ואת המזהה של המנוי שקיבל את האירוע.

פרטים
פרמטרים
[in] inEv
אובייקט של אירועים חיצוניים שתואם לאירועים שהועברו
[in] inLastDeliveredEventID
המזהה של האירוע האחרון שנמסר למנוי.
[in] inRecipientNodeID
מזהה הצומת של הנמען

NotifyExternalEventsEvictedFunct

void(* NotifyExternalEventsEvictedFunct)(ExternalEvents *inEv)

אב טיפוס של פונקציה לקריאה חוזרת (callback) שמופעל כאשר אירועים חיצוניים מסולקים ממאגרי הנתונים הזמניים.

כשאובייקט האירועים החיצוניים יוסר ממאגר ההודעות היוצאות, המנוע ישלח התראה לספק האירוע החיצוני. הקריאה החוזרת מכילה את האירוע החיצוני שיש להסיר.

פרטים
פרמטרים
[in] inEv
אובייקט של אירועים חיצוניים להסרה

PropertyDictionaryKey

uint16_t PropertyDictionaryKey

PropertyPathHandle

uint32_t PropertyPathHandle

PropertyPathHandle הוא גיבוב (hash) מספרי ייחודי של 32 ביט של נתיב WDM ביחס לשורש של מופע תכונה.

הוא מורכב משני חלקים:

  • מספר נמוך יותר של 16 ביט שממופה לחלק הסטטי של הסכימה.
  • כאשר 16 הביטים הנמוכים יותר מפנים לנתיב בתוך רכיב מילון, מופיע מספר עליון של 16 ביט שמייצג את מפתח המילון המשויך לאלמנט הזה. אם 16 הביטים הנמוכים יותר מפנות לאלמנט שאינו מילון, הערך של 16 הביטים העליונים צריך להיות 0.

כמה מאפיינים:

  • לכל תכונה יש מרחב נקודת אחיזה של נתיב הנכס.
  • לכל נתיב משנה ייחודי של WDM יהיה מאפיין PropertyPathHandle ייחודי דומה.
  • PropertyPathHandles נוצר באופן אוטומטי (נכון לעכשיו באופן ידני) על ידי מהדר של תכונות מ-IDL, ומיוצג כרשימה של ספירה בקובץ הכותרת של התכונה המתאימה.
  • עם המבנה הזה, הלוגיקה של האפליקציה אף פעם לא צריכה לטפל ישירות בנתיבי WDM. במקום זאת, האינטראקציות שלהם עם WDM מנוהלות אך ורק באמצעות הכינויים האלה.
  • יש שני ערכים שמורים לכינויים של נתיבים שיש להם משמעות ספציפית:
    • 0 מציין את הערך NULL כינוי
    • 1 מציין כינוי שמצביע לשורש של מופע התכונה.

PropertySchemaHandle

uint16_t PropertySchemaHandle

SchemaVersion

uint16_t SchemaVersion

SingleResourceSinkTraitCatalog

SingleResourceTraitCatalog< TraitDataSink > SingleResourceSinkTraitCatalog

SingleResourceSourceTraitCatalog

SingleResourceTraitCatalog< TraitDataSource > SingleResourceSourceTraitCatalog

TimestampType

enum nl::Weave::Profiles::DataManagement_Current::TimestampType TimestampType

התוקף והסוג של חותמת הזמן הכלולים ב-EventOptions.

TraitDataHandle

uint16_t TraitDataHandle

duration_t

uint32_t duration_t

סוג שמשמש לתיאור משך הזמן, באלפיות השנייה.

event_id_t

uint32_t event_id_t

הסוג של מזהה האירוע.

timestamp_t

uint32_t timestamp_t

סוג שמשמש לתיאור חותמת הזמן באלפיות השנייה.

utc_timestamp_t

uint64_t utc_timestamp_t

סוג שמשמש לתיאור חותמת הזמן לפי שעון UTC באלפיות השנייה.

משתנים

sInstance

LoggingManagement sInstance

sLogFileName

char sLogFileName[] = "topazlog"

פונקציות

BdxErrorHandler

void BdxErrorHandler(
  nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer,
  WEAVE_ERROR aErrorCode
)

BdxGetBlockHandler

void BdxGetBlockHandler(
  nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer,
  uint64_t *aLength,
  uint8_t **aDataBlock,
  bool *aIsLastBlock
)

BdxRejectHandler

void BdxRejectHandler(
  nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer,
  nl::Weave::Profiles::StatusReporting::StatusReport *aReport
)

BdxSendAcceptHandler

WEAVE_ERROR BdxSendAcceptHandler(
  nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer,
  nl::Weave::Profiles::BulkDataTransfer::SendAccept *aSendAcceptMsg
)

BdxXferDoneHandler

void BdxXferDoneHandler(
  nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer
)

BdxXferErrorHandler

void BdxXferErrorHandler(
  nl::Weave::Profiles::BulkDataTransfer::BDXTransfer *aXfer,
  nl::Weave::Profiles::StatusReporting::StatusReport *aXferError
)

CreatePropertyPathHandle

PropertyPathHandle CreatePropertyPathHandle(
  PropertySchemaHandle aPropertyPathSchemaId,
  PropertyDictionaryKey aPropertyPathDictionaryKey
)

EventWriterTLVCopy

WEAVE_ERROR EventWriterTLVCopy(
  TLVWriter & ioWriter,
  uint8_t inDataTag,
  void *appData
)

פונקציית עזר שמתרגמת רכיב של נתוני אירועים שכבר עברו סריאליזציה למאגר הנתונים הזמני.

פרטים
פרמטרים
[in,out] ioWriter
הכותב/ת שרוצים לכתוב בו את האירוע
[in] inDataTag
תג הקשר ל-TLV שאנחנו מעתיקים. לא בשימוש כאן, אבל נדרש על ידי typedef ל-EventWriterFunct.
[in] appData
מצביע אל ה-TLVReader שבו שמורים נתוני אירועים סידוריים.
מוחזר ערכים
WEAVE_NO_ERROR
הצלחה.
other
שגיאות אחרות שהוחזרו מה-ioWriter.

GetPropertyDictionaryKey

PropertyDictionaryKey GetPropertyDictionaryKey(
  PropertyPathHandle aHandle
)

GetPropertySchemaHandle

PropertySchemaHandle GetPropertySchemaHandle(
  PropertyPathHandle aHandle
)

IsNullPropertyPathHandle

bool IsNullPropertyPathHandle(
  PropertyPathHandle aHandle
)

IsRootPropertyPathHandle

bool IsRootPropertyPathHandle(
  PropertyPathHandle aHandle
)

IsVersionNewer

bool IsVersionNewer(
  const DataVersion & aVersion,
  const DataVersion & aReference
)

זוהי הטמעה אופטימלית של האלגוריתם להשוואת גרסאות.

בצד הלקוח, גרסה שהתקבלה מהשירות היא תמיד הגרסה העדכנית ביותר.

IsVersionNewerOrEqual

bool IsVersionNewerOrEqual(
  const DataVersion & aVersion,
  const DataVersion & aReference
)

איתור

TraitUpdatableDataSink * Locate(
  TraitDataHandle aTraitDataHandle,
  const TraitCatalogBase< TraitDataSink > *aDataSinkCatalog
)

פונקציית כלי עזר למציאת TraitUpdatableDataSink בקטלוג של TraitDataSink.

פרטים
פרמטרים
[in] aTraitDataHandle
נקודת האחיזה של ה-Sink לחיפוש.
[in] aDataSinkCatalog
קטלוג לחיפוש.
החזרות
מצביע אל TraitUpdatableDataSink. הערך NULL אם הכינוי לא קיים או שהוא מפנה ל-TraitDataSink שלא ניתן לעדכון.

LogEvent

event_id_t LogEvent(
  const EventSchema & inSchema,
  nl::Weave::TLV::TLVReader & inData
)

תיעוד אירוע מטופס שצורף מראש.

הפונקציה רושמת אירוע שמיוצג בתור nl::Weave::TLV::TLVReader. הכוונה היא שהייצוג של נתוני האירועים כבר עבר סריאליזציה לנפח האחסון שבבסיס ה-nl::Weave::TLV::TLVReader. הרכיב nl::Weave::TLV::TLVReader אמור להכיל לפחות רכיב נתונים אחד, והרכיב הזה חייב להיות מבנה. הרכיב הראשון שנקרא מהקורא נחשב לנתוני אירוע ומאוחסן ביומן האירועים. נתוני האירועים חייבים לכלול תגי הקשר שיפורשו בתוך הסכימה המזוהה על ידי inProfileID ו-inEventType. המערכת תתעלם מהתג של הרכיב הראשון; מערכת רישום האירועים תחליף אותו בתג eventData.

האירוע נרשם אם החשיבות שלו חורגת מסף הרישום ביומן שצוין ב-LoggingConfiguration. אם חשיבות האירוע לא עומדת בסף הנוכחי, היא תוסר והפונקציה תחזיר 0 כמזהה האירוע שמתקבל.

הווריאנט הזה של ההפעלה מציין במרומז את כל האפשרויות של אירועים שמוגדרות כברירת מחדל:

  • מצוינת חותמת זמן של האירוע עם השעה הנוכחית במועד השיחה.
  • האירוע מסומן כקשור למכשיר שממנו מתבצעת השיחה.
  • האירוע הוא עצמאי, ולא קשור לאירועים אחרים.
  • האירוע מסומן כלא דחוף,

פרטים
פרמטרים
[in] inSchema
סכימה שמגדירה חשיבות, מזהה פרופיל וסוג המבנה של האירוע הזה.
[in] inData
הקורא TLV שמכיל את נתוני האירוע כרכיב הראשון.
החזרות
event_id_t מזהה האירוע אם האירוע נכתב ביומן. אחרת, 0.

LogEvent

event_id_t LogEvent(
  const EventSchema & inSchema,
  nl::Weave::TLV::TLVReader & inData,
  const EventOptions *inOptions
)

תיעוד אירוע מטופס סריאלי מראש, עם אפשרויות נוספות.

הפונקציה רושמת אירוע שמיוצג בתור nl::Weave::TLV::TLVReader. הכוונה היא שהייצוג של נתוני האירועים כבר עבר סריאליזציה לנפח האחסון שבבסיס ה-nl::Weave::TLV::TLVReader. הרכיב nl::Weave::TLV::TLVReader אמור להכיל לפחות רכיב נתונים אחד, והרכיב הזה חייב להיות מבנה. הרכיב הראשון שנקרא מהקורא נחשב לנתוני אירוע ומאוחסן ביומן האירועים. נתוני האירועים חייבים לכלול תגי הקשר שיפורשו בתוך הסכימה המזוהה על ידי inProfileID ו-inEventType. המערכת תתעלם מהתג של הרכיב הראשון; מערכת רישום האירועים תחליף אותו בתג eventData.

האירוע נרשם אם החשיבות שלו חורגת מסף הרישום ביומן שצוין ב-LoggingConfiguration. אם חשיבות האירוע לא עומדת בסף הנוכחי, היא תוסר והפונקציה תחזיר 0 כמזהה האירוע שמתקבל.

הווריאנט הזה של ההפעלה מאפשר לקורא להגדיר כל שילוב של EventOptions:

  • חותמת זמן, כאשר ערך ברירת המחדל של 0 הוא השעה הנוכחית במועד השיחה,
  • 'root' הקטע של מקור האירוע (מקור האירוע ומזהה התכונה) אם הערך הוא NULL, ברירת המחדל תהיה המכשיר הנוכחי. האירוע מסומן כקשור למכשיר שממנו מתבצעת השיחה.
  • מזהה אירוע קשור לקיבוץ מזהי אירועים. כאשר מזהה האירוע הקשור הוא 0, האירוע מסומן כלא קשור לאף אירוע אחר,
  • דחיפות; כברירת מחדל לא דחופות.

פרטים
פרמטרים
[in] inSchema
סכימה שמגדירה חשיבות, מזהה פרופיל וסוג המבנה של האירוע הזה.
[in] inData
הקורא TLV שמכיל את נתוני האירוע כרכיב הראשון. לא יכול להיות NULL
[in] inOptions
האפשרויות למטא-נתונים של האירוע. יכול להיות NULL.
החזרות
event_id_t מזהה האירוע אם האירוע נכתב ביומן. אחרת, 0.

LogEvent

event_id_t LogEvent(
  const EventSchema & inSchema,
  EventWriterFunct inEventWriter,
  void *inAppData
)

תיעוד אירוע באמצעות התקשרות חזרה.

הפונקציה רושמת אירוע שמיוצג כ-EventWriterFunct ובהקשר appData ספציפי לאפליקציה. הפונקציה כותבת את המטא-נתונים של האירוע וקוראת ל-inEventWriter עם הפניה nl::Weave::TLV::TLVWriter והקשר inAppData, כדי שקוד המשתמש יוכל לפלוט את נתוני האירועים ישירות ליומן האירועים. רישום ביומן של אירועים מהסוג הזה מצמצם את צריכת הזיכרון, כי נתוני האירועים עוברים סריאליזציה ישירות למאגר הנתונים הזמני של היעד. נתוני האירועים חייבים להכיל תגי הקשר שיפורשו בתוך הסכימה המזוהה על ידי inProfileID ו-inEventType. המערכת תתעלם מהתג של הרכיב הראשון; מערכת רישום האירועים תחליף אותו בתג eventData.

האירוע נרשם אם החשיבות שלו חורגת מסף הרישום ביומן שצוין ב-LoggingConfiguration. אם חשיבות האירוע לא עומדת בסף הנוכחי, היא תוסר והפונקציה תחזיר 0 כמזהה האירוע שמתקבל.

הווריאנט הזה של ההפעלה מציין במרומז את כל האפשרויות של אירועים שמוגדרות כברירת מחדל:

  • מצוינת חותמת זמן של האירוע עם השעה הנוכחית במועד השיחה.
  • האירוע מסומן כקשור למכשיר שממנו מתבצעת השיחה.
  • האירוע הוא עצמאי, ולא קשור לאירועים אחרים.
  • האירוע מסומן כלא דחוף,

פרטים
פרמטרים
[in] inSchema
סכימה שמגדירה חשיבות, מזהה פרופיל וסוג המבנה של האירוע הזה.
[in] inEventWriter
הקריאה החוזרת (callback) להפעלה כדי לבצע סריאליזציה של נתוני האירוע
[in] inAppData
ההקשר של האפליקציה להתקשרות חזרה.
החזרות
event_id_t מזהה האירוע אם האירוע נכתב ביומן. אחרת, 0.

LogEvent

event_id_t LogEvent(
  const EventSchema & inSchema,
  EventWriterFunct inEventWriter,
  void *inAppData,
  const EventOptions *inOptions
)

תיעוד אירוע באמצעות התקשרות חזרה, עם אפשרויות שונות.

הפונקציה רושמת אירוע שמיוצג כ-EventWriterFunct ובהקשר appData ספציפי לאפליקציה. הפונקציה כותבת את המטא-נתונים של האירוע וקוראת ל-inEventWriter עם הפניה nl::Weave::TLV::TLVWriter והקשר inAppData, כדי שקוד המשתמש יוכל לפלוט את נתוני האירועים ישירות ליומן האירועים. רישום ביומן של אירועים מהסוג הזה מצמצם את צריכת הזיכרון, כי נתוני האירועים עוברים סריאליזציה ישירות למאגר הנתונים הזמני של היעד. נתוני האירועים חייבים להכיל תגי הקשר שיפורשו בתוך הסכימה המזוהה על ידי inProfileID ו-inEventType. המערכת תתעלם מהתג של הרכיב הראשון; מערכת רישום האירועים תחליף אותו בתג eventData.

האירוע נרשם אם החשיבות שלו חורגת מסף הרישום ביומן שצוין ב-LoggingConfiguration. אם חשיבות האירוע לא עומדת בסף הנוכחי, היא תוסר והפונקציה תחזיר 0 כמזהה האירוע שמתקבל.

הווריאנט הזה של ההפעלה מאפשר לקורא להגדיר כל שילוב של EventOptions:

  • חותמת זמן, כאשר ערך ברירת המחדל של 0 הוא השעה הנוכחית במועד השיחה,
  • 'root' הקטע של מקור האירוע (מקור האירוע ומזהה התכונה) אם הערך הוא NULL, ברירת המחדל תהיה המכשיר הנוכחי. האירוע מסומן כקשור למכשיר שממנו מתבצעת השיחה.
  • מזהה אירוע קשור לקיבוץ מזהי אירועים. כאשר מזהה האירוע הקשור הוא 0, האירוע מסומן כלא קשור לאף אירוע אחר,
  • דחיפות; כברירת מחדל לא דחופות.

פרטים
פרמטרים
[in] inSchema
סכימה שמגדירה חשיבות, מזהה פרופיל וסוג המבנה של האירוע הזה.
[in] inEventWriter
הקריאה החוזרת (callback) להפעלה כדי לבצע סריאליזציה של נתוני האירוע
[in] inAppData
ההקשר של האפליקציה להתקשרות חזרה.
[in] inOptions
האפשרויות למטא-נתונים של האירוע. יכול להיות NULL.
החזרות
event_id_t מזהה האירוע אם האירוע נכתב ביומן. אחרת, 0.

LogFreeform

event_id_t LogFreeform(
  ImportanceType inImportance,
  const char *inFormat,
  ...
)

LogFreeform פולט מחרוזת חופשית לרצף האירועים שמוגדר כברירת מחדל.

המחרוזת תוצג במבנה אירוע של ניפוי באגים, זהה מבחינה מבנית למחרוזות אחרות שנרשמו ביומן. מזהה פרופיל האירוע יהיה זהה לזה של אירוע ב-Nest Debug, וסוג האירוע יהיה kNestDebug_StringLogEntryEvent.

פרטים
פרמטרים
[in] inImportance
החשיבות של הרשומה ביומן; אם החשיבות נמוכה מהחשיבות הנוכחית, האירוע לא נרשם בפועל.
[in] inFormat
מחרוזת פורמט תואמת printf, ואחריה ארגומנטים לפורמט
החזרות
event_id_t מזהה האירוע אם האירוע נכתב ביומן. אחרת, 0.

LookForElementWithTag

WEAVE_ERROR LookForElementWithTag(
  const nl::Weave::TLV::TLVReader & aSrcReader,
  const uint64_t aTagInApiForm,
  nl::Weave::TLV::TLVReader *apDstReader
)

PlainTextWriter

WEAVE_ERROR PlainTextWriter(
  TLVWriter & ioWriter,
  uint8_t inDataTag,
  void *appData
)

פונקציית עזר להחרגת טקסט חופשי כאירוע ניפוי באגים.

אירוע ניפוי הבאגים הוא מבנה עם אזור יומן וטקסט חופשי.

פרטים
פרמטרים
[in,out] ioWriter
הכותב/ת שרוצים לכתוב בו את האירוע
[in] appData
מצביע אל DebugLogContext, מבנה שמכיל פורמט מחרוזת, ארגומנטים ואזור ביומן
[in] inDataTag
תג הקשר לTLV שאנחנו כותבים. לא בשימוש כאן, אבל נדרש על ידי typedef ל-EventWriterFunct.
מוחזר ערכים
WEAVE_NO_ERROR
הצלחה.
other
שגיאות אחרות שהוחזרו מה-ioWriter.

PlainTextWriter

WEAVE_ERROR PlainTextWriter(
  ::nl::Weave::TLV::TLVWriter & ioWriter,
  uint8_t inDataTag,
  void *appData
)

פונקציית עזר להחרגת טקסט חופשי כאירוע ניפוי באגים.

אירוע ניפוי הבאגים הוא מבנה עם אזור יומן וטקסט חופשי.

פרטים
פרמטרים
[in,out] ioWriter
הכותב/ת שרוצים לכתוב בו את האירוע
[in] inDataTag
התג שצריך להפיץ
[in] appData
מצביע אל DebugLogContext, מבנה שמכיל פורמט מחרוזת, ארגומנטים ואזור ביומן
מוחזר ערכים
WEAVE_NO_ERROR
הצלחה.
other
שגיאות אחרות שעשויות להיות מוחזרות מ-ioWriter.

operator!=

bool operator!=(
  const ResourceIdentifier & lhs,
  const ResourceIdentifier & rhs
)

אופרטור==

bool operator==(
  const ResourceIdentifier & lhs,
  const ResourceIdentifier & rhs
)