nl:: Weave:: Profiles:: DataManagement_Current
تشمل مساحة الاسم هذه جميع الواجهات الموجودة داخل Weave لملف تعريف إدارة بيانات Weave (WDM) المدعومة حاليًا للاستخدام الإنتاجي.
ملخّص
تعريف الأنواع |
|
---|---|
CommandFlags
|
تعريف الكتابة |
DataVersion
|
تعريف الكتابةuint64_t
|
EventProcessor
|
تعريف الكتابةvoid *
|
EventWriterFunct)(nl::Weave::TLV::TLVWriter &ioWriter, uint8_t inDataTag, void *appData)
|
تعريف الكتابة يشير ذلك المصطلح إلى دالة توفّر عنصر eventData للنظام الفرعي لتسجيل الأحداث. |
FetchExternalEventsFunct)(EventLoadOutContext *aContext)
|
تعريف الكتابة نموذج أولي لدالة لاستدعاءات النظام الأساسي التي تجلب بيانات الأحداث. |
GenericTraitSinkCatalog
|
تعريف الكتابة |
GenericTraitSourceCatalog
|
تعريف الكتابة |
ImportanceType
|
تعريف الكتابة أهمية إدخال السجل. |
IteratorCallback)(void *aTraitInstance, TraitDataHandle aHandle, void *aContext)
|
تعريف الكتابةvoid(*
مكرر التعامل مع السمة. |
LoggingBufferHandler)(void *inAppState, PacketBuffer *inBuffer)
|
تعريف الكتابة |
NotifyExternalEventsDeliveredFunct)(ExternalEvents *inEv, event_id_t inLastDeliveredEventID, uint64_t inRecipientNodeID)
|
تعريف الكتابةvoid(*
هو نموذج أولي لدالة لمعاودة الاتصال التي تم استدعاءها عند تسليم أحداث خارجية إلى المشترك البعيد. |
NotifyExternalEventsEvictedFunct)(ExternalEvents *inEv)
|
تعريف الكتابةvoid(*
يشير ذلك المصطلح إلى نموذج أوّلي لدالة لمعاودة الاتصال يتم استدعاءها عند إخراج الأحداث الخارجية من الموارد الاحتياطية. |
PropertyDictionaryKey
|
تعريف الكتابةuint16_t
|
PropertyPathHandle
|
تعريف الكتابةuint32_t
PropertyPathHandle هو تجزئة رقمية فريدة 32 بت لمسار WDM مرتبط بجذر مثيل السمة. |
PropertySchemaHandle
|
تعريف الكتابةuint16_t
|
SchemaVersion
|
تعريف الكتابةuint16_t
|
SingleResourceSinkTraitCatalog
|
تعريف الكتابة |
SingleResourceSourceTraitCatalog
|
تعريف الكتابة |
TimestampType
|
تعريف الكتابة يعرض هذا الحقل صلاحية الطابع الزمني ونوعه في EventOptions. |
TraitDataHandle
|
تعريف الكتابةuint16_t
|
duration_t
|
nl::Weave::Profiles::DataManagement_Current::duration_tuint32_t
النوع المستخدم لوصف المدة بالمللي ثانية. |
event_id_t
|
nl::Weave::Profiles::DataManagement_Current::event_id_tuint32_t
نوع رقم تعريف الحدث. |
timestamp_t
|
nl::Weave::Profiles::DataManagement_Current::timestamp_tuint32_t
النوع المستخدم لوصف الطابع الزمني بالمللي ثانية. |
utc_timestamp_t
|
nl::Weave::Profiles::DataManagement_Current::utc_timestamp_tuint64_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:: |
يشير ذلك المصطلح إلى الاتحاد الذي يوفّر نظامًا لضبط التطبيقات أو الطابع الزمني للتوقيت العالمي المتفق عليه. |
عمليات التعداد
@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
|
مصفوفة اختيارية تربط الملفات الشخصية المختارة بشكل انتقائي بمستويات التسجيل الأعلى. يأخذ كل عنصر في المصفوفة شكلاً (الملف الشخصي، مسار، تسجيل الدخول) لتحسين التسجيل بشكل انتقائي من مجموعة فرعية من النظام. لا تكون أولوية تسجيل الملف الشخصي المرتفع ذات الأهمية إلا عندما تتجاوز أولوية التسجيل تلك الخاصة بالأهمية الحالية وتكون خاضعة لوقت انتهاء الصلاحية نفسه الخاص بالأهمية الحالية. |
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 بت يساوي معرّف الملف الشخصي للسمة. |
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
|
يمكنك ضبط الوقت الذي يكون فيه وقت البدء صالحًا. |
kCommandFlag_IsOneWay
|
يمكنك ضبط هذا الإعداد عندما يكون الأمر أحادي الاتجاه. |
kCommandFlag_MustBeVersionValid
|
يمكنك ضبط هذا الخيار عندما يكون حقل الإصدار صالحًا. |
ImportanceType
ImportanceType
أهمية إدخال السجل.
تُستخدم الأهمية كطريقة لفلترة الأحداث قبل إطلاقها فعليًا في السجلّ. وبعد أن يكون الحدث في السجلّ، لا نطبّق أي أحكام أخرى لمحوه من السجلّ. يعمل مستوى الأهمية على منح الأولوية لتخزين الأحداث. إذا تمت إضافة حدث ذي أهمية عالية إلى المخزن الاحتياطي الكامل، يتم إسقاط الأحداث حسب الأهمية (والعمر) لاستيعابه. ولذلك، يكون لمستويات الأهمية قيمة نسبية فقط. إذا كان النظام يستخدم مستوى أهمية واحد فقط، سيتم تجاهل الأحداث حسب العمر فقط، مثل المخزن المؤقت للحلقة.
أماكن إقامة | |
---|---|
Debug
|
تشير أهمية تصحيح الأخطاء إلى إدخالات السجل التي تهم مطوري النظام ويتم استخدامها بشكل أساسي في مرحلة التطوير. لا يتم مراعاة سجلات أهمية تصحيح الأخطاء في معدل نقل البيانات أو ميزانيات الطاقة للأجهزة المحدودة ونتيجة لذلك، لا يجب استخدامها إلا لفترة زمنية محدودة في أنظمة الإنتاج. |
Info
|
تشير أهمية المعلومات إلى إدخالات السجل التي توفر إحصاءات وبيانات تشخيص إضافية في النظام الجاري. يمكن استخدام مستوى تسجيل المعلومات على مدار فترة زمنية طويلة في نظام الإنتاج، أو يمكن استخدامه كمستوى السجل الافتراضي في التجربة الميدانية. على الأجهزة الخاضعة لقيود، يجب احتساب الإدخالات التي تم تسجيلها باستخدام مستوى المعلومات في معدل نقل البيانات وميزانية الذاكرة، ولكن ليس في ميزانية الطاقة. |
Production
|
وتشير أهمية الإنتاج إلى الإدخالات في السجلّ المستخدمة في المراقبة المستمرة لمنظومة Nest المتكاملة وصيانتها. على الأجهزة الخاضعة لقيود، يجب مراعاة الإدخالات المسجَّلة مع مقياس "أهمية الإنتاج" في ميزانية الطاقة والذاكرة، حيث يُتوقع أن يتم دائمًا تسجيلها وإزالتها من الجهاز. |
ProductionCritical
|
تشير الأهمية الحاسمة للإنتاج إلى الأحداث التي تؤثر خسارتها بشكل مباشر في الميزات المخصصة للعملاء. قد تستخدم التطبيقات فقدان أحداث الإنتاج المهمة للإشارة إلى تعطُّل النظام. في الأجهزة الخاضعة لقيود، يجب احتساب الإدخالات التي تم تسجيلها باستخدام "الأهمية البالغة الأهمية" للإنتاج في ميزانية الطاقة والذاكرة، حيث يُتوقع أن يتم دائمًا تسجيلها وإزالتها من الجهاز. |
LoggingManagementStates
LoggingManagementStates
أماكن إقامة | |
---|---|
kLoggingManagementState_Holdoff
|
اكتمل نقل بيانات السجلّ. ولن نعيد تشغيل السجلّ حتى تنتهي فترة الانتظار. |
kLoggingManagementState_Idle
|
ما مِن عمليات نقل بيانات السجلّ قيد التقدم، ويمكن أن تبدأ عملية نقل السجلّ بدون أي قيود. |
kLoggingManagementState_InProgress
|
جارٍ نقل تحميل السجلّ. |
kLoggingManagementState_Shutdown
|
غير قادر على إجراء أي عملية تسجيل. |
تعريف الأنواع
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 عليه. أن تكون قيمة هذا العنصر عبارة عن بنية تحتوي على بيانات الحدث. ويجب تنظيم بيانات الحدث نفسها باستخدام علامات السياق.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلمات |
|
||||||
قيم الإرجاع |
|
PlainTextWriter
EventWriterTLVCopy
FetchExternalEventsFunct
WEAVE_ERROR(* FetchExternalEventsFunct)(EventLoadOutContext *aContext)
نموذج أولي لدالة لاستدعاءات النظام الأساسي التي تجلب بيانات الأحداث.
كما هو الحال في Fetch EventMonth، تعرض دالة الجلب هذه جميع الأحداث من EventLoadOutContext.mجذبEventID إلى ExternalEvents.mLastEventID.
مؤشر السياق من النوع FetchExternalEventsContext. ويشمل ذلك EventLoadOutContext، مع بعض المتغيّرات المساعدة لتنسيق TLV. ويتضمن أيضًا مؤشرًا إلى البنية ExternalEvents التي تم إنشاؤها عند تسجيل معاودة الاتصال. يحدد هذا نطاق معرّف الحدث لمعاودة الاتصال.
عند الرجوع من الدالة، يجب أن يعكس EventLoadOutContext.mCurrentEventID معرّف الحدث الأول الذي لم تتم كتابته بنجاح في المخزن المؤقت TLV. يجب أن تكتب المنصة عناوين الأحداث وبياناتها إلى كاتب TLV بالتنسيق الصحيح المحدّد بواسطة بروتوكول EventLogging. يجب أن تحافظ المنصة أيضًا على فرادة الأحداث والطوابع الزمنية.
يجب نشر كل أخطاء 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)
هو نموذج أولي لدالة لمعاودة الاتصال التي تم استدعاءها عند تسليم أحداث خارجية إلى المشترك البعيد.
عندما يتم تسليم الأحداث الخارجية إلى مشترك بعيد، سيرسل المحرّك إشعارًا إلى موفّر الأحداث الخارجي. تحتوي عملية معاودة الاتصال على حدث آخر رقم تعريف تم إرساله ورقم تعريف المشترك الذي استلم الحدث.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلمات |
|
NotifyExternalEventsEvictedFunct
void(* NotifyExternalEventsEvictedFunct)(ExternalEvents *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 )
يشير ذلك المصطلح إلى دالة مساعد تترجم عنصر بيانات حدث متسلسلة إلى المخزن المؤقت للحدث.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلمات |
|
||||||
قيم الإرجاع |
|
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.
التفاصيل | |||||
---|---|---|---|---|---|
المعلمات |
|
||||
المرتجعات |
مؤشر يؤدي إلى 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
كرقم تعريف الحدث الناتج.
يحدّد صيغة الاستدعاء هذه ضمنيًا جميع خيارات الحدث التلقائية:
- طابعًا زمنيًا للوقت الحالي عند إجراء الاتصال،
- يتم وضع علامة على الحدث مرتبط بالجهاز الذي يجري الاتصال،
- أن يكون الحدث مستقلاً لا يرتبط بأي أحداث أخرى
- يتم وضع علامة على الحدث على أنه غير عاجل،
التفاصيل | |||||
---|---|---|---|---|---|
المعلمات |
|
||||
المرتجعات |
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 الافتراضي 0 على الوقت الحالي عند نقطة الاتصال،
- "الجذر" قسم من مصدر الحدث (مصدر الحدث ورقم تعريف السمة) إذا كانت فارغة، سيتم الضبط تلقائيًا على الجهاز الحالي. يتم وضع علامة على الحدث مرتبط بالجهاز الذي يجري الاتصال،
- معرّف حدث ذي صلة لتجميع أرقام تعريف الأحداث عندما يكون رقم تعريف الحدث ذي الصلة 0، يتم وضع علامة على الحدث للإشارة إلى أنّه غير مرتبط بأيّ أحداث أخرى.
- الإلحاح بشكل افتراضي غير عاجل.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلمات |
|
||||||
المرتجعات |
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
كرقم تعريف الحدث الناتج.
يحدّد صيغة الاستدعاء هذه ضمنيًا جميع خيارات الحدث التلقائية:
- طابعًا زمنيًا للوقت الحالي عند إجراء الاتصال،
- يتم وضع علامة على الحدث مرتبط بالجهاز الذي يجري الاتصال،
- أن يكون الحدث مستقلاً لا يرتبط بأي أحداث أخرى
- يتم وضع علامة على الحدث على أنه غير عاجل،
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلمات |
|
||||||
المرتجعات |
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 الافتراضي 0 على الوقت الحالي عند نقطة الاتصال،
- "الجذر" قسم من مصدر الحدث (مصدر الحدث ورقم تعريف السمة) إذا كانت فارغة، سيتم الضبط تلقائيًا على الجهاز الحالي. يتم وضع علامة على الحدث مرتبط بالجهاز الذي يجري الاتصال،
- معرّف حدث ذي صلة لتجميع أرقام تعريف الأحداث عندما يكون رقم تعريف الحدث ذي الصلة 0، يتم وضع علامة على الحدث للإشارة إلى أنّه غير مرتبط بأيّ أحداث أخرى.
- الإلحاح بشكل افتراضي غير عاجل.
التفاصيل | |||||||||
---|---|---|---|---|---|---|---|---|---|
المعلمات |
|
||||||||
المرتجعات |
event_id_t معرّف الحدث إذا كان مكتوبًا في السجل، في الحالات 0.
|
LogFreeform
event_id_t LogFreeform( ImportanceType inImportance, const char *inFormat, ... )
يرسل LogFreeform سلسلة ذات تصميم حر إلى تدفق الأحداث التلقائي.
سيتم تغليف السلسلة في بنية حدث تصحيح أخطاء، وتكون مطابقة بنيته للسلاسل المسجَّلة الأخرى. سيكون رقم تعريف الملف الشخصي للحدث هو رقم تعريف حدث "تصحيح الأخطاء في Nest"، وسيكون نوع الحدث هو kNestDebug_StringLogEntryEvent
.
التفاصيل | |||||
---|---|---|---|---|---|
المعلمات |
|
||||
المرتجعات |
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 )
يشير ذلك المصطلح إلى دالة مساعدة لإرسال نص حر كحدث تصحيح أخطاء.
حدث تصحيح الأخطاء عبارة عن بنية تحتوي على لوغاريتم ونص حر الشكل.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلمات |
|
||||||
قيم الإرجاع |
|
PlainTextWriter
WEAVE_ERROR PlainTextWriter( ::nl::Weave::TLV::TLVWriter & ioWriter, uint8_t inDataTag, void *appData )
يشير ذلك المصطلح إلى دالة مساعدة لإرسال نص حر كحدث تصحيح أخطاء.
حدث تصحيح الأخطاء عبارة عن بنية تحتوي على لوغاريتم ونص حر الشكل.
التفاصيل | |||||||
---|---|---|---|---|---|---|---|
المعلمات |
|
||||||
قيم الإرجاع |
|