nl:: بافت:: پروفایل ها:: DataManagement_Current

این فضای نام شامل تمام رابط‌های موجود در پروفایل Weave Data Management (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 Debug.
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
نمونه اولیه تابع برای تماس های پلت فرم که داده های رویداد را واکشی می کند.
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(*
یک نمونه اولیه تابع برای یک فراخوانی که هنگام خروج رویدادهای خارجی از بافرها فراخوانی می شود.
PropertyDictionaryKey typedef
uint16_t
PropertyPathHandle typedef
uint32_t
PropertyPathHandle یک هش عددی 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)
یک تابع کمکی که یک عنصر eventdata از قبل سریال شده را به بافر رویداد ترجمه می کند.
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:: بافت:: پروفایل ها:: DataManagement_Current:: AlwaysAcceptDataElementAccessControlDelegate
nl:: بافت:: پروفایل ها:: DataManagement_Current:: BuilderBase

کلاس پایه برای رمزگذارهای پیام WDM.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: CircularEventReader

یک TLVReader با پشتیبانی CircularEventBuffer .

nl:: بافت:: پروفایل ها:: DataManagement_Current:: فرمان
nl:: بافت:: پروفایل ها:: DataManagement_Current:: CommandSender
nl:: بافت:: پروفایل ها:: DataManagement_Current:: GenericTraitCatalogImpl

یک Weave رابط TraitCatalogBase را برای مجموعه‌ای از نمونه‌های داده صفت که همگی به یک منبع ارجاع می‌دهند، ارائه کرد.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: IDataElementAccessControlDelegate

رابطی که قرار است توسط پردازشگر عناصر داده در یک NotifyRequest پیاده سازی شود.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: IDirtyPathCut
nl:: بافت:: پروفایل ها:: DataManagement_Current:: IPathFilter
nl:: Weave:: پروفایل ها:: DataManagement_Current:: IWeavePublisherLock

رابطی که قرار است توسط برنامه برای سریال سازی دسترسی به ساختارهای داده کلیدی WDM پیاده سازی شود.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: IWeaveWDMMutex

رابط یک شی mutex.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: ListBuilderBase

کلاس پایه برای رمزگذارهای پیام WDM، متخصص در عناصر آرایه TLV مانند فهرست‌های داده و فهرست‌های نسخه.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: ListParserBase

کلاس پایه برای تجزیه‌کننده‌های پیام WDM، متخصص در عناصر آرایه TLV مانند فهرست‌های داده و فهرست‌های نسخه.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: LogBDXUpload
nl:: بافت:: پروفایل ها:: DataManagement_Current:: LoggingConfiguration

LoggingConfiguration جزء قابل تنظیم زیرسیستم Weave Event Logging را در بر می گیرد.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: LoggingManagement

کلاسی برای مدیریت گزارش رویدادهای حافظه.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: NotificationEngine
nl:: بافت:: پروفایل ها:: DataManagement_Current:: ParserBase

کلاس پایه برای تجزیه کننده های پیام WDM.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: ResourceIdentifier

ساختاری که شناسه یک منبع را در بر می گیرد.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: SingleResourceTraitCatalog
nl:: بافت:: پروفایل ها:: DataManagement_Current:: SubscriptionClient
nl:: بافت:: پروفایل ها:: DataManagement_Current:: SubscriptionEngine

این یک تک‌تنه میزبان همه اشتراک‌های WDM Next است، هم در سمت مشتری و هم ناشر.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: SubscriptionHandler
nl:: بافت:: پروفایل ها:: DataManagement_Current:: TraitCatalogBase
nl:: بافت:: پروفایل ها:: DataManagement_Current:: TraitDataSink
nl:: بافت:: پروفایل ها:: DataManagement_Current:: TraitDataSource
nl:: بافت:: پروفایل ها:: DataManagement_Current:: TraitSchemaEngine

موتور طرحواره اطلاعات طرحواره مرتبط با یک ویژگی خاص را می گیرد و امکاناتی را برای تجزیه و ترجمه آن به شکلی قابل استفاده توسط ماشین های WDM فراهم می کند.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: TraitUpdatableDataSink
nl:: بافت:: پروفایل ها:: DataManagement_Current:: UpdateClient
nl:: Weave:: پروفایل ها:: DataManagement_Current:: UpdateDictionaryDirtyPathCut

کلاس Utility برای برگرداندن فرهنگ لغت به صف در انتظار هنگام پردازش مسیر ویژگی که دارای فرزند دیکشنری است.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: UpdateDirtyPathFilter

کلاس ابزار برای فیلتر کردن مسیر هنگام مدیریت اعلان.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: UpdateEncoder

این شیء بارهای WDM UpdateRequest و PartialUpdateRequest را رمزگذاری می کند.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: ViewClient

سازه ها

nl:: بافت:: پروفایل ها:: DataManagement_Current:: CircularEventBuffer

بافر رویداد داخلی، ساخته شده در اطراف nl::Weave::TLV::WeaveCircularTLVBuffer .

nl:: بافت:: پروفایل ها:: DataManagement_Current:: ConstSchemaVersionRange
nl:: بافت:: پروفایل ها:: DataManagement_Current:: CopyAndAdjustDeltaTimeContext

ساختار داخلی برای پیمایش لیست رویدادها.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: DebugLogContext
nl:: بافت:: پروفایل ها:: DataManagement_Current:: DetailedRootSection

ساختاری که وضوح کامل نمونه صفت را ارائه می دهد.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: EventEnvelopeContext

ساختار داخلی برای عبور از رویدادها.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: EventLoadOutContext

ساختار برای کپی کردن لیست رویدادها در خروجی.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: گزینه های رویداد

ساختاری که گزینه هایی را برای فیلدهای رویداد مختلف ارائه می دهد.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: EventSchema

ساختاری که یک طرح واره را برای ابرداده رویداد تعریف می کند.

nl:: Weave:: پروفایل ها:: DataManagement_Current:: ExternalEvents

ساختاری برای ردیابی رویدادهای ذخیره شده در پلتفرم.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: LogStorageResources

یک کلاس کمکی که در راه اندازی مدیریت ورود به سیستم استفاده می شود.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: ReclaimEventCtx
nl:: بافت:: پروفایل ها:: DataManagement_Current:: SchemaVersionRange
nl:: بافت:: پروفایل ها:: DataManagement_Current:: TraitPath
nl:: بافت:: پروفایل ها:: DataManagement_Current:: TraitPathStore
nl:: بافت:: پروفایل ها:: DataManagement_Current:: VersionedTraitPath

اتحادیه ها

nl:: بافت:: پروفایل ها:: DataManagement_Current:: مهر زمانی

اتحادیه ای که یک سیستم مجموعه برنامه یا مهر زمانی UTC را ارائه می دهد.

فضاهای نام

nl:: بافت:: پروفایل ها:: DataManagement_Current:: BaseMessageWithSubscribeId
nl:: بافت:: پروفایل ها:: DataManagement_Current:: CustomCommand

تعریف دستور سفارشی WDM.

nl:: Weave:: پروفایل ها:: DataManagement_Current:: CustomCommandResponse

تعریف پاسخ فرمان سفارشی WDM.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: DataElement

تعریف عنصر داده WDM.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: DataList
nl:: بافت:: پروفایل ها:: DataManagement_Current:: رویداد
nl:: بافت:: پروفایل ها:: DataManagement_Current:: لیست رویدادها
nl:: بافت:: پروفایل ها:: DataManagement_Current:: درخواست اطلاع رسانی
nl:: بافت:: پروفایل ها:: DataManagement_Current:: مسیر

تعریف مسیر WDM

nl:: بافت:: پروفایل ها:: DataManagement_Current:: PathList

تعریف لیست مسیر WDM.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: پلتفرم
nl:: بافت:: پروفایل ها:: DataManagement_Current:: RejectionRecord
nl:: بافت:: پروفایل ها:: DataManagement_Current:: RejectionRecordList
nl:: بافت:: پروفایل ها:: DataManagement_Current:: StatusElement

تعریف عنصر وضعیت WDM.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: StatusList
nl:: بافت:: پروفایل ها:: DataManagement_Current:: Subscribe CancelRequest
nl:: بافت:: پروفایل ها:: DataManagement_Current:: SubscribeConfirmRequest
nl:: بافت:: پروفایل ها:: DataManagement_Current:: Subscribe Request
nl:: بافت:: پروفایل ها:: DataManagement_Current:: SubscribeResponse
nl:: بافت:: پروفایل ها:: DataManagement_Current:: UpdateRequest

تعریف درخواست به‌روزرسانی WDM.

nl:: بافت:: پروفایل ها:: DataManagement_Current:: UpdateResponse
nl:: بافت:: پروفایل ها:: DataManagement_Current:: لیست نسخه ها
nl:: بافت:: پروفایل ها:: DataManagement_Current:: ViewRequest
nl:: بافت:: پروفایل ها:: 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

نشانی اینترنتی که مقصد بارگذاری گزارش را نشان می‌دهد.

kTag_MaximumLogUploadInterval

حداکثر مدت زمان، بر حسب ثانیه، بین تلاش‌های آپلود گزارش به‌طور خودکار آغاز می‌شود.

kTag_MinimumLogUploadInterval

حداقل مدت زمان، بر حسب ثانیه، بین تلاش‌های آپلود گزارش به‌طور خودکار آغاز می‌شود.

kTag_TraitLoggingImportance

یک آرایه اختیاری به طور انتخابی پروفایل های انتخاب شده را در سطوح بالاتر ثبت نقشه نقشه برداری می کند.

هر عنصر در آرایه یک شکل (پروفایل، مسیر، اهمیت ورود به سیستم) دارد تا به طور انتخابی ثبت را از زیر مجموعه ای از سیستم بالا ببرد. اولویت ثبت نمایه بالا تنها زمانی اهمیت دارد که اولویت ثبت از اولویت فعلی بیشتر باشد و مشمول همان زمان انقضا با اهمیت فعلی باشد.

@96

 @96

برچسب ها برای قابلیت های ورود به سیستم.

خواص
kTag_LogBufferingCapacity

یک عدد صحیح بدون علامت 32 بیتی که ظرفیت بافر log را در کیلوبایت توصیف می کند.

kTag_LoggingVolume

یک عدد صحیح بدون علامت 32 بیتی که حجم گزارش مورد انتظار را بر حسب کیلوبایت در روز توصیف می کند.

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 Debug.

خواص
kNestDebug_StringLogEntryEvent

رویدادی برای پیام اشکال زدایی رشته آزاد.

kNestDebug_TokenizedHeaderEntryEvent

رویدادی برای انتقال اطلاعات هدر نشانه گذاری شده.

kNestDebug_TokenizedLogEntryEvent

رویدادی برای پیام اشکال زدایی توکن شده.

CommandFlags

 CommandFlags
خواص
kCommandFlag_ActionTimeValid

زمان معتبر بودن زمان اقدام را تنظیم کنید.

kCommandFlag_ExpiryTimeValid

زمانی را تنظیم کنید که زمان انقضا معتبر است.

kCommandFlag_InitiationTimeValid

زمانی را تنظیم کنید که زمان شروع معتبر باشد.

kCommandFlag_IsOneWay

زمانی را تنظیم کنید که دستور یک طرفه باشد.

kCommandFlag_MustBeVersionValid

زمانی را تنظیم کنید که فیلد نسخه معتبر باشد.

نوع اهمیت

 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

پردازشگر رویداد

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
EventWriterTLVCopy

FetchExternalEventsFunct

WEAVE_ERROR(* FetchExternalEventsFunct)(EventLoadOutContext *aContext)

نمونه اولیه تابع برای تماس های پلت فرم که داده های رویداد را واکشی می کند.

مشابه FetchEventsSince، این تابع واکشی همه رویدادها را از EventLoadOutContext.mStartingEventID از طریق ExternalEvents.mLastEventID برمی‌گرداند.

اشاره گر زمینه از نوع FetchExternalEventsContext است. این شامل EventLoadOutContext با برخی از متغیرهای کمکی برای قالب TLV است. همچنین شامل یک اشاره گر به ساختار ExternalEvents است که در ثبت تماس برگشتی ایجاد شده است. این محدوده شناسه رویداد برای پاسخ به تماس را مشخص می کند.

در بازگشت از تابع، EventLoadOutContext.mCurrentEventID باید اولین شناسه رویداد را که با موفقیت در بافر TLV نوشته نشده است، منعکس کند. پلتفرم باید هدر رویدادها و داده ها را با فرمت صحیحی که توسط پروتکل EventLogging مشخص شده است، در نویسنده TLV بنویسد. پلتفرم باید منحصر به فرد بودن رویدادها و مُهرهای زمانی را نیز حفظ کند.

تمام خطاهای TLV باید به سطوح بالاتر منتشر شوند. به عنوان مثال، خالی شدن فضا در بافر یک پیام ارسال شده را راه اندازی می کند و به دنبال آن یک تماس دیگر با هر شناسه رویداد باقی می ماند.

جزئیات
ارزش های بازگشتی
WEAVE_ERROR_NO_MEMORY
اگر فضایی برای نوشتن رویدادها وجود ندارد.
WEAVE_ERROR_BUFFER_TOO_SMALL
اگر فضایی برای نوشتن رویدادها وجود ندارد.
WEAVE_NO_ERROR
در مورد موفقیت
WEAVE_END_OF_TLV
در مورد موفقیت

GenericTraitSinkCatalog

GenericTraitCatalogImpl< TraitDataSink > GenericTraitSinkCatalog

GenericTraitSourceCatalog

GenericTraitCatalogImpl< TraitDataSource > GenericTraitSourceCatalog

نوع اهمیت

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)

یک نمونه اولیه تابع برای یک فراخوانی که هنگام خروج رویدادهای خارجی از بافرها فراخوانی می شود.

هنگامی که شی رویدادهای خارجی از بافر پیام خروجی خارج می شود، موتور یک اعلان به ارائه دهنده رویداد خارجی ارائه می دهد. تماس پاسخ حاوی رویداد خارجی است که باید خارج شود.

جزئیات
پارامترها
[in] inEv
رویدادهای بیرونی اعتراض دارند که اخراج شوند

PropertyDictionaryKey

uint16_t PropertyDictionaryKey

PropertyPathHandle

uint32_t PropertyPathHandle

PropertyPathHandle یک هش عددی 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"

توابع

BdxError Handler

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
)

BdxXferError Handler

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
)

یک تابع کمکی که یک عنصر eventdata از قبل سریال شده را به بافر رویداد ترجمه می کند.

جزئیات
پارامترها
[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
دسته سینک برای جستجو.
[in] aDataSinkCatalog
کاتالوگ برای جستجو
برمی گرداند
اشاره گر به TraitUpdatableDataSink . اگر دسته وجود نداشته باشد یا به یک TraitDataSink غیرقابل به روز رسانی اشاره کند، NULL.

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 به طور پیش‌فرض روی زمان فعلی در نقطه تماس قرار می‌گیرد،
  • بخش "ریشه" منبع رویداد (منبع رویداد و شناسه صفت)؛ اگر 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
تماس برگشتی برای فراخوانی برای سریال سازی واقعی داده های رویداد
[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 به طور پیش‌فرض روی زمان فعلی در نقطه تماس قرار می‌گیرد،
  • بخش "ریشه" منبع رویداد (منبع رویداد و شناسه صفت)؛ اگر NULL باشد، به طور پیش فرض روی دستگاه فعلی است. رویداد مربوط به دستگاهی است که تماس را برقرار می کند،
  • شناسه رویداد مرتبط برای گروه‌بندی شناسه‌های رویداد؛ هنگامی که شناسه رویداد مربوطه 0 باشد، رویداد به‌عنوان غیرمرتبط با هیچ رویداد دیگری علامت‌گذاری می‌شود،
  • فوریت؛ به طور پیش فرض غیر فوری

جزئیات
پارامترها
[in] inSchema
طرحواره تعیین کننده اهمیت، شناسه نمایه و نوع ساختار این رویداد.
[in] inEventWriter
تماس برگشتی برای فراخوانی برای سریال سازی واقعی داده های رویداد
[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
)

یک تابع کمکی برای انتشار یک متن آزاد به عنوان یک رویداد اشکال زدایی.

رویداد اشکال زدایی یک ساختار با یک logregion و یک متن آزاد است.

جزئیات
پارامترها
[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
)

یک تابع کمکی برای انتشار یک متن آزاد به عنوان یک رویداد اشکال زدایی.

رویداد اشکال زدایی یک ساختار با یک logregion و یک متن آزاد است.

جزئیات
پارامترها
[in,out] ioWriter
نویسنده برای نوشتن رویداد استفاده کنید
[in] inDataTag
برچسب برای انتشار
[in] appData
یک اشاره گر به DebugLogContext ، ساختاری که یک قالب رشته، آرگومان ها و یک منطقه گزارش را در خود نگه می دارد.
ارزش های بازگشتی
WEAVE_NO_ERROR
در مورد موفقیت
other
سایر خطاهایی که ممکن است از ioWriter برگردانده شوند.

اپراتور!=

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

اپراتور==

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