nl::Weave::Profiles::DataManagement_Current

تشمل مساحة الاسم هذه جميع الواجهات ضمن Weave للملف الشخصي لإدارة بيانات Weave Data Management (WDM) المتاحة حاليًا لاستخدام الإنتاج.

ملخّص

عمليات التعداد
@100{
  kTag_Region = 1,
  kTag_Message = 2
} 		تعداد
علامات kNestDebug_StringLogEntryEvent.
@101{
  kTag_Token = 1,
  kTag_Args = 2
} 		تعداد
علامات kNestDebug_TokenizedLogEntryEvent.
@102 تعداد
علامات للأحداث المستمرة
@104 تعداد
أنواع رسائل الملف الشخصي عبر WDM.
@105 تعداد
رموز الحالة الخاصة بـ WDM.
@147 تعداد
@95{
  kTag_CurrentImportance = 1,
  kTag_ImportanceExpiration,
  kTag_MinimumLogUploadInterval,
  kTag_MaximumLogUploadInterval,
  kTag_LoggingDestination,
  kTag_TraitLoggingImportance
} 		تعداد
علامات إعدادات التسجيل
@96{
  kTag_SupportedLogTransports = 1,
  kTag_SupportsStreaming = 2,
  kTag_SupportsNonVolatileStorage = 3,
  kTag_SupportsPerTraitVerbosity = 4,
  kTag_LoggingVolume = 5,
  kTag_LogBufferingCapacity = 6
} 		تعداد
علامات لإمكانيات التسجيل
@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
} 		تعداد
علامات للبيانات الوصفية للحدث
@98 تعداد
تعريفات الملف الشخصي لسمة تصحيح الأخطاء.
@99{
  kNestDebug_StringLogEntryEvent = 1,
  kNestDebug_TokenizedLogEntryEvent = 2,
  kNestDebug_TokenizedHeaderEntryEvent = 3
} 		تعداد
أنواع الأحداث لسمة تصحيح أخطاء Nest
CommandFlags{
  kCommandFlag_MustBeVersionValid = 0x0001,
  kCommandFlag_InitiationTimeValid = 0x0002,
  kCommandFlag_ActionTimeValid = 0x0004,
  kCommandFlag_ExpiryTimeValid = 0x0008,
  kCommandFlag_IsOneWay = 0x0010
} 		تعداد
ImportanceType{
  ProductionCritical = 1,
  Production,
  Info,
  Debug
} 		تعداد
أهمية إدخال السجل.
LoggingManagementStates{
  kLoggingManagementState_Idle = 1,
  kLoggingManagementState_InProgress = 2,
  kLoggingManagementState_Holdoff = 3,
  kLoggingManagementState_Shutdown = 4
} 		تعداد
TimestampType تعداد
صلاحية ونوع الطابع الزمني المضمن في EventOptions.

تحديدات النوع
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
النوع المستخدَم لوصف الطابع الزمني للتوقيت العالمي المتفق عليه بالمللي ثانية.

المتغيرات
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 لمجموعة من مثيلات بيانات السمات التي تشير جميعها إلى المورد نفسه.

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

الواجهة التي ينفّذها معالج عناصر البيانات في RequestRequest.

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

واجهة لكائن دالة الاستبعاد المتبادل.

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

يشفّر هذا الكائن حمولات البيانات الأساسية في WDM UpdateRequest وPartialUpdateRequest.

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

تمثّل هذه السمة الاتحاد الذي يوفّر نظام ضبط التطبيقات أو الطابع الزمني للتوقيت العالمي المتفق عليه.

مساحات الاسم
nl::Weave::Profiles::DataManagement_Current::BaseMessageWithSubscribeId
nl::Weave::Profiles::DataManagement_Current::CustomCommand

تعريف أمر 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

تعريف مسار 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

الوقت، بالثواني التوقيت العالمي المنسَّق، عندما تعود إعدادات التسجيل المرتفع الحالية إلى القيم التلقائية.

kTag_LoggingDestination

عنوان URL يشير إلى وجهة تحميل السجلّ.

kTag_MaximumLogUploadInterval

الحدّ الأقصى للمدة، بالثواني، بين محاولات تحميل السجلّ التي يتم تشغيلها تلقائيًا.

kTag_MinimumLogUploadInterval

الحد الأدنى من المدة، بالثواني، بين محاولات تحميل السجلّ التي يتم تشغيلها تلقائيًا.

kTag_TraitLoggingImportance

مصفوفة اختيارية تربط الملفات الشخصية المختارة بشكل انتقائي بمستويات التسجيل الأعلى.

يأخذ كل عنصر في الصفيف شكلاً (profile,path,loggingimportance) لتحسين التسجيل بشكل انتقائي من مجموعة فرعية من النظام. لا يكون لأولوية تسجيل الملف الشخصي الأعلى أهمية إلا عندما تتجاوز أولوية التسجيل للأهمية الحالية وتكون لها نفس مدة انتهاء الصلاحية للأهمية الحالية.

@96

 @96

علامات لإمكانيات التسجيل

أماكن إقامة
kTag_LogBufferingCapacity

عدد صحيح غير موقَّع 32 بت يصف سعة التخزين المؤقت للسجلات بالكيلوبايت.

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

اختياريّ. الطابع الزمني بالتوقيت العالمي المنسَّق للحدث بالمللي ثانية

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

يتم ضبطه عندما يكون وقت init صالحًا.

kCommandFlag_IsOneWay

يمكنك ضبطه عندما يكون الأمر في اتجاه واحد.

kCommandFlag_MustBeVersionValid

يتم ضبط السياسة عندما يكون حقل الإصدار صالحًا.

ImportanceType

 ImportanceType

أهمية إدخال السجل.

ويتم استخدام الأهمية كطريقة لفلترة الأحداث قبل إطلاقها فعليًا في السجلّ. بعد إدخال الحدث في السجلّ، لا نقدّم أي إجراءات أخرى لمحوه من السجلّ. يعمل مستوى الأهمية على منح الأولوية لتخزين الحدث. إذا تمت إضافة حدث مهم للغاية إلى مورد احتياطي كامل، يتم تجاهل الأحداث بترتيب الأهمية (والعمر) لاستيعابه. وبناءً على ذلك، يكون لمستويات الأهمية قيمة نسبية فقط. في حال كان النظام يستخدم مستوى أهمية واحدًا فقط، يتم تجاهل الأحداث فقط حسب العمر، مثل المخزن المؤقت للرنين.

أماكن إقامة
Debug

تشير أهمية تصحيح الأخطاء إلى إدخالات السجل التي تهم مطوري النظام وتستخدم بشكل أساسي في مرحلة التطوير.

ولا يتم احتساب سجلات أهمية تصحيح الأخطاء في معدل نقل البيانات أو ميزانيات الطاقة للأجهزة المقيَّدة، ونتيجةً لذلك، يجب استخدامها فقط على مدار فترة زمنية محدودة في أنظمة الإنتاج.

Info

تشير أهمية المعلومات إلى إدخالات السجل التي توفر إحصاءات وبيانات تشخيص إضافية في نظام التشغيل.

يمكن استخدام مستوى تسجيل المعلومات خلال فترة زمنية طويلة في نظام إنتاج، أو يمكن استخدامه كمستوى السجل التلقائي في تجربة ميدانية. على الأجهزة المقيدة، يجب مراعاة الإدخالات التي يتم تسجيلها باستخدام "مستوى المعلومات" في معدل نقل البيانات وميزانية الذاكرة، ولكن ليس في ميزانية الطاقة.

Production

تشير أهمية الإنتاج إلى إدخالات السجلّات التي يتم استخدامها في المراقبة والصيانة المستمرة لمنظومة Nest المتكاملة.

على الأجهزة المحدودة، يجب مراعاة الإدخالات المُسجَّلة بأهمية الإنتاج في ميزانية الطاقة والذاكرة، حيث يُتوقَّع أن يتم دائمًا تسجيلها وإخراجها من الجهاز.

ProductionCritical

تشير الأهمية الحيوية للإنتاج إلى الأحداث التي ستؤثر خسارتها بشكل مباشر على الميزات المواجهة للعملاء.

قد تستخدم التطبيقات حالات فقدان الأحداث الحاسمة في مرحلة الإنتاج للإشارة إلى تعطُّل النظام. على الأجهزة المقيدة، يجب مراعاة الإدخالات المُسجَّلة ذات الأهمية البالغة للإنتاج في ميزانية الطاقة والذاكرة، حيث يُتوقَّع أن يتم دائمًا تسجيلها وتفريغها من الجهاز.

LoggingManagementStates

 LoggingManagementStates
أماكن إقامة
kLoggingManagementState_Holdoff

اكتمل نقل بيانات التسجيل، ولن تتم إعادة تشغيل السجلّ حتى تنتهي فترة التعليق.

kLoggingManagementState_Idle

لا يتم تفريغ أي سجل قيد التقدم، ويمكن بدء تفريغ السجل بدون أي قيود.

kLoggingManagementState_InProgress

جارٍ تفريغ التسجيل.

kLoggingManagementState_Shutdown

غير قادر على تنفيذ أي عملية تسجيل.

TimestampType

 TimestampType

صلاحية ونوع الطابع الزمني المضمن في EventOptions.

تحديدات النوع

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
EventWriterTLVCopy

FetchExternalEventsFunct

WEAVE_ERROR(* FetchExternalEventsFunct)(EventLoadOutContext *aContext)

نموذج أولي لدالة استدعاء النظام الأساسي الذي تجلب بيانات الأحداث.

على غرار FetchEventsDay، تعرض دالة الجلب هذه جميع الأحداث من EventLoadOutContext.mStartEventID حتى ExternalEvents.mLastEventID.

مؤشر السياق من النوع FetchExternalEventsContext. ويشمل ذلك EventLoadOutContext، مع بعض المتغيرات المساعدة لتنسيق TLV. ويتضمّن أيضًا مؤشرًا إلى بنية ExternalEvents التي تم إنشاؤها عند تسجيل معاودة الاتصال. يحدِّد هذا الإعداد نطاق رقم تعريف الحدث لمعاودة الاتصال.

عند الرجوع من الدالة، يجب أن يعكس EventLoadOutContext.mCurrentEventID رقم تعريف الحدث الأول الذي لم تتم كتابته بنجاح في المخزن المؤقت TLV. يجب أن تكتب المنصة عناوين الأحداث وبياناتها إلى كاتب TLV بالتنسيق الصحيح الذي يحدّده بروتوكول EventLogging. يجب أن تحافظ المنصة أيضًا على الطابع الفريد للأحداث والطوابع الزمنية.

يجب نشر جميع أخطاء 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

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)

نموذج أولي لدالة تم استدعاءه عند طرد الأحداث الخارجية من المخازن المؤقتة.

عند إخراج كائن الأحداث الخارجية من المخزن المؤقت للرسائل الصادرة، سيقدّم المحرّك إشعارًا إلى موفِّر الحدث الخارجي. يحتوي معاودة الاتصال على الحدث الخارجي المطلوب التخلص منه.

التفاصيل
المَعلمات
[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

النوع المستخدَم لوصف الطابع الزمني للتوقيت العالمي المتفق عليه بالمللي ثانية.

المتغيرات

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
مقبض الحوض للبحث فيه
[in] aDataSinkCatalog
كتالوج للبحث.
المرتجعات
يشير إلى TraitUpdatableDataSink، القيمة فارغة إذا لم يكن الاسم المعرِّف متوفرًا أو يشير إلى 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 القيمة التلقائية للوقت الحالي عند نقطة المكالمة،
  • قسم "الجذر" من مصدر الحدث (مصدر الحدث ومعرّف السمة)؛ إذا كانت قيمة فارغة (NULL)، يتم تعيينها تلقائيًا على الجهاز الحالي. ويتم وضع علامة على الحدث باعتباره مرتبطًا بالجهاز الذي يجري المكالمة،
  • رقم تعريف حدث ذي صلة لتجميع أرقام تعريف الأحداث. عندما يكون رقم تعريف الحدث ذي الصلة 0، يتم وضع علامة على الحدث على أنّه غير مرتبط بأي أحداث أخرى.
  • إلحاحًا؛ أي أنه غير عاجل بشكل تلقائي

التفاصيل
المَعلمات
[in] inSchema
المخطط يحدد الأهمية ورقم تعريف الملف الشخصي ونوع البنية لهذا الحدث.
[in] inData
قارئ TLV الذي يحتوي على بيانات الحدث باعتباره العنصر الأول. يجب ألا يكون فارغًا
[in] inOptions
خيارات البيانات الوصفية للحدث قد تكون فارغة.
المرتجعات
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
خيارات البيانات الوصفية للحدث قد تكون فارغة.
المرتجعات
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

!=

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

==

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