ไม่มี:: สาน:: โปรไฟล์:: DataManagement_Current

เนมสเปซนี้รวมอินเทอร์เฟซทั้งหมดภายใน Weave สำหรับโปรไฟล์ 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::สาน::โปรไฟล์::DataManagement_Current::duration_t
uint32_t
ประเภทที่ใช้อธิบายระยะเวลา หน่วยเป็นมิลลิวินาที
event_id_t nl::สาน::โปรไฟล์::DataManagement_Current::event_id_t
uint32_t
ประเภทของรหัสเหตุการณ์
timestamp_t nl::สาน::โปรไฟล์::DataManagement_Current::timestamp_t
uint32_t
ประเภทที่ใช้อธิบายการประทับเวลา หน่วยเป็นมิลลิวินาที
utc_timestamp_t nl::สาน::โปรไฟล์::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)
บันทึกเหตุการณ์จากแบบฟอร์ม pre-serialized
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 (constnl::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

สานจัดให้มีการดำเนินงานของ TraitCatalogBase อินเตอร์เฟซสำหรับการเก็บรวบรวมข้อมูลกรณีลักษณะที่ทุกคนหมายถึงทรัพยากรเดียวกัน

NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: IDataElementAccessControlDelegate

อินเทอร์เฟซที่จะใช้โดยตัวประมวลผลขององค์ประกอบข้อมูลใน NotifyRequest

NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: IDirtyPathCut
NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: IPathFilter
NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: IWeavePublisherLock

อินเทอร์เฟซที่จะใช้โดยแอปเพื่อจัดลำดับการเข้าถึงโครงสร้างข้อมูล WDM ที่สำคัญ

NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: IWeaveWDMMutex

อินเทอร์เฟซของวัตถุ mutex

NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: ListBuilderBase

ระดับฐานสำหรับการเข้ารหัสข้อความ WDM เฉพาะใน TLV องค์ประกอบมากมายเช่นรายการข้อมูลและรายชื่อรุ่น

NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: ListParserBase

ชั้นฐานสำหรับ parsers ข้อความ WDM เฉพาะใน TLV องค์ประกอบมากมายเช่นรายการข้อมูลและรายชื่อรุ่น

NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: LogBDXUpload
NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: LoggingConfiguration

LoggingConfiguration สุนทรีย์ที่กำหนดองค์ประกอบของการสานเหตุการณ์ การบันทึกข้อมูล ระบบย่อย

NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: LoggingManagement

คลาสสำหรับจัดการบันทึกเหตุการณ์ในหน่วยความจำ

NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: NotificationEngine
NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: ParserBase

คลาสพื้นฐานสำหรับตัวแยกวิเคราะห์ข้อความ WDM

NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: ResourceIdentifier

โครงสร้างที่ห่อหุ้ม ID ของทรัพยากร

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 :: สาน :: โปรไฟล์ :: DataManagement_Current :: UpdateDictionaryDirtyPathCut

คลาสยูทิลิตี้เพื่อนำพจนานุกรมกลับไปที่คิวที่รอดำเนินการ เมื่อประมวลผลพาธคุณสมบัติที่มีพจนานุกรมลูก

NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: UpdateDirtyPathFilter

คลาสยูทิลิตี้เพื่อกรองเส้นทางเมื่อจัดการการแจ้งเตือน

NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: UpdateEncoder

วัตถุนี้ถอดรหัส WDM UpdateRequest และ PartialUpdateRequest payloads

NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: ViewClient

โครงสร้าง

NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: CircularEventBuffer

บัฟเฟอร์เหตุการณ์ภายในสร้างขึ้นรอบ ๆ NL :: สาน :: 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 :: EventOptions

โครงสร้างที่มีตัวเลือกสำหรับฟิลด์เหตุการณ์ต่างๆ

NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: EventSchema

โครงสร้างที่กำหนดสคีมาสำหรับข้อมูลเมตาของเหตุการณ์

NL :: สาน :: โปรไฟล์ :: 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 :: สาน :: โปรไฟล์ :: DataManagement_Current :: CustomCommandResponse

WDM กำหนดเอง สั่ง นิยามการตอบสนอง

NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: DataElement

คำจำกัดความขององค์ประกอบข้อมูล WDM

NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: DataList
NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: เหตุการณ์
NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: EventList
NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: NotificationRequest
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 :: SubscribeCancelRequest
NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: SubscribeConfirmRequest
NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: SubscribeRequest
NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: SubscribeResponse
NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: UpdateRequest

คำนิยามคำขอคำขออัปเดต WDM

NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: UpdateResponse
NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: VersionList
NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: ViewRequest
NL :: สาน :: โปรไฟล์ :: DataManagement_Current :: ViewResponse

การแจงนับ

@100

 @100

แท็กสำหรับ kNestDebug_StringLogEntryEvent

คุณสมบัติ
kTag_Message

สตริงที่มีข้อความแก้ไขข้อบกพร่องจริง

kTag_Region

unsigned 32 บิตเพื่อระบุพื้นที่บันทึก เช่น โมดูลที่เกี่ยวข้องกับข้อความบันทึก

@101

 @101

แท็กสำหรับ kNestDebug_TokenizedLogEntryEvent

คุณสมบัติ
kTag_Args

อาร์เรย์ของอาร์กิวเมนต์ที่จะส่งไปพร้อมกับข้อความโทเค็น

kTag_Token

ค่า unsigned 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 บิตที่ไม่ได้ลงนามซึ่งอธิบายความจุบัฟเฟอร์บันทึกในหน่วย kB

kTag_LoggingVolume

จำนวนเต็ม 32 บิตที่ไม่ได้ลงนามซึ่งอธิบายปริมาณการบันทึกที่คาดไว้เป็น kB/วัน

kTag_SupportedLogTransports

อาร์เรย์ของกลไกการส่งบันทึกที่รองรับ

kTag_SupportsNonVolatileStorage

บูลีนที่ระบุว่าอุปกรณ์รองรับการจัดเก็บบันทึกที่ไม่ลบเลือนหรือไม่

kTag_SupportsPerTraitVerbosity

บูลีนที่ระบุว่าอุปกรณ์รองรับการตั้งค่ารายละเอียดต่อคุณลักษณะหรือไม่

kTag_SupportsStreaming

บูลีนที่ระบุว่าอุปกรณ์รองรับบันทึกการสตรีมหรือไม่

@97

 @97

แท็กสำหรับข้อมูลเมตาของเหตุการณ์

สำหรับความหมายทั้งหมดของค่าแท็ก โปรดดูที่ข้อกำหนดการออกแบบเหตุการณ์

คุณสมบัติ
kTag_EventData

ไม่จำเป็น. ข้อมูลเหตุการณ์เอง หากว่างเปล่า จะมีค่าเริ่มต้นเป็นโครงสร้างว่าง

kTag_EventDeltaSystemTime

แท็กภายใน WDM ความแตกต่างของเวลาจากเหตุการณ์ก่อนหน้าในการเข้ารหัส

kTag_EventDeltaUTCTime

แท็กภายใน WDM ความแตกต่างของเวลาจากเหตุการณ์ก่อนหน้าในการเข้ารหัส

kTag_EventID

หมายเลขลำดับของเหตุการณ์ แสดงเป็นปริมาณที่ไม่ได้ลงชื่อ 64 บิต

จะต้องเป็นลำดับ การกระโดดตามลำดับแสดงถึงช่องว่างของเหตุการณ์

kTag_EventImportance

ความสำคัญของเหตุการณ์

kTag_EventResourceID

ไม่จำเป็น.

ค่าคือ ID ของทรัพยากรที่เกี่ยวข้องกับเหตุการณ์ เมื่อละเว้น ค่าจะเหมือนกับค่าของ 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

ไม่จำเป็น.

ID ของกิจกรรมที่เกี่ยวข้องกับกิจกรรมนี้ หากไม่ระบุ ค่าจะเท่ากับค่าของ kTag_EventID

kTag_RelatedEventImportance

ไม่จำเป็น.

ความสำคัญของเหตุการณ์ที่เกี่ยวข้อง หากไม่ระบุ ค่าจะเท่ากับค่าของ kTag_EventImportance

@98

 @98

คำจำกัดความของโปรไฟล์สำหรับลักษณะการดีบัก

@99

 @99

ประเภทเหตุการณ์สำหรับคุณลักษณะ Nest Debug

คุณสมบัติ
kNestDebug_StringLogEntryEvent

เหตุการณ์สำหรับข้อความดีบักสตริงรูปแบบอิสระ

kNestDebug_TokenizedHeaderEntryEvent

เหตุการณ์สำหรับการถ่ายทอดข้อมูลส่วนหัว tokenized

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

ความถูกต้องและชนิดของการประทับเวลารวมอยู่ใน 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 :: สาน :: TLV :: TLVWriter วัตถุในที่จะปล่อยซิงเกิ้ล TLV องค์ประกอบแท็ก kTag_EventData; ค่าขององค์ประกอบนั้นจะต้องเป็นโครงสร้างที่มีข้อมูลเหตุการณ์ ข้อมูลเหตุการณ์ต้องได้รับการจัดโครงสร้างโดยใช้แท็กบริบท

รายละเอียด
พารามิเตอร์
[in,out] ioWriter
การอ้างอิงไปยังNL :: สาน :: TLV :: TLVWriter วัตถุที่จะใช้สำหรับการแข่งขันเป็นอันดับข้อมูล
[in] inDataTag
แท็กบริบทสำหรับ TLV เรากำลังเขียนออก
[in] appData
ตัวชี้ไปยังบริบทเฉพาะของแอปพลิเคชัน
ส่งกลับค่า
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ
other
ข้อผิดพลาดที่เหมาะสมส่งสัญญาณไปยังผู้โทรว่าไม่สามารถทำให้ข้อมูลเหตุการณ์เป็นอนุกรม ข้อผิดพลาดจากการเรียกไปยัง ioWriter ควรเผยแพร่โดยไม่ต้องทำการแมปใหม่ ถ้าฟังก์ชันส่งคืนข้อผิดพลาดชนิดใดๆ การสร้างเหตุการณ์จะถูกยกเลิก และเหตุการณ์จะไม่ถูกเขียนลงในบันทึก
ดูสิ่งนี้ด้วย:
นักเขียนข้อความธรรมดา
EventWriterTLVCopy

FetchExternalEventsFunct

WEAVE_ERROR(* FetchExternalEventsFunct)(EventLoadOutContext *aContext)

ต้นแบบฟังก์ชันสำหรับการเรียกกลับของแพลตฟอร์มที่ดึงข้อมูลเหตุการณ์

คล้ายกับ FetchEventsSince นี้สามารถดึงข้อมูลกลับมาทำงานเหตุการณ์ทั้งหมดจาก EventLoadOutContext.mStartingEventID ผ่าน ExternalEvents.mLastEventID

ตัวชี้บริบทเป็นประเภท FetchExternalEventsContext ซึ่งรวมถึงการ EventLoadOutContext กับตัวแปรผู้ช่วยบางอย่างสำหรับรูปแบบของ TLV นอกจากนี้ยังมีตัวชี้ไปยัง ExternalEvents โครงสร้างที่สร้างขึ้นบนลงทะเบียนของการเรียกกลับ ระบุช่วงรหัสเหตุการณ์สำหรับการเรียกกลับ

กลับจากฟังก์ชั่น EventLoadOutContext.mCurrentEventID ควรจะสะท้อนถึงเหตุการณ์ ID แรกที่ยังไม่ได้รับการเขียนที่ประสบความสำเร็จกับ TLV บัฟเฟอร์ แพลตฟอร์มต้องเขียนส่วนหัวของเหตุการณ์และข้อมูลไปยัง TLV นักเขียนในรูปแบบที่ถูกต้องตามที่ระบุโดยโปรโตคอล EventLogging แพลตฟอร์มยังต้องรักษาเอกลักษณ์ของเหตุการณ์และการประทับเวลา

ทั้งหมด TLV ข้อผิดพลาดควรจะแพร่กระจายไปยังระดับที่สูงขึ้น ตัวอย่างเช่น พื้นที่ว่างในบัฟเฟอร์ไม่เพียงพอจะทริกเกอร์ข้อความที่ส่ง ตามด้วยการเรียกอีกครั้งเพื่อโทรกลับด้วย ID เหตุการณ์ใดก็ตามที่เหลืออยู่

รายละเอียด
ส่งกลับค่า
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)

ฟังก์ชันต้นแบบสำหรับการเรียกกลับเมื่อเหตุการณ์ภายนอกถูกส่งไปยังสมาชิกระยะไกล

เมื่อเหตุการณ์ภายนอกถูกส่งไปยังผู้สมัครสมาชิกระยะไกล เอ็นจิ้นจะส่งการแจ้งเตือนไปยังผู้ให้บริการเหตุการณ์ภายนอก การเรียกกลับประกอบด้วยเหตุการณ์ของ ID ล่าสุดที่ถูกส่ง และ ID ของสมาชิกที่ได้รับเหตุการณ์

รายละเอียด
พารามิเตอร์
[in] inEv
วัตถุเหตุการณ์ภายนอกที่สอดคล้องกับเหตุการณ์ที่จัดส่ง
[in] inLastDeliveredEventID
ID ของเหตุการณ์ล่าสุดที่ส่งไปยังสมาชิก
[in] inRecipientNodeID
สาน ID โหนดของผู้รับ

แจ้งเหตุการณ์ภายนอกEvictedFunct

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 ระบุหมายเลขอ้างอิงที่ชี้ไปที่รูทของอินสแตนซ์ของลักษณะ

คุณสมบัติสคีมาHandle

uint16_t PropertySchemaHandle

สคีมาเวอร์ชัน

uint16_t SchemaVersion

SingleResourceSinkTraitCatalog

SingleResourceTraitCatalog< TraitDataSink > SingleResourceSinkTraitCatalog

SingleResourceSourceTraitCatalog

SingleResourceTraitCatalog< TraitDataSource > SingleResourceSourceTraitCatalog

ประเภทประทับเวลา

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

ความถูกต้องและชนิดของการประทับเวลารวมอยู่ใน EventOptions

TraitDataHandle

uint16_t TraitDataHandle

ระยะเวลา_t

uint32_t duration_t

ประเภทที่ใช้อธิบายระยะเวลา หน่วยเป็นมิลลิวินาที

event_id_t

uint32_t event_id_t

ประเภทของรหัสเหตุการณ์

เวลาประทับ_t

uint32_t timestamp_t

ประเภทที่ใช้อธิบายการประทับเวลา หน่วยเป็นมิลลิวินาที

utc_timestamp_t

uint64_t utc_timestamp_t

ประเภทที่ใช้อธิบายเวลา UTC หน่วยเป็นมิลลิวินาที

ตัวแปร

อินสแตนซ์

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
)

ฟังก์ชันตัวช่วยที่แปลอิลิเมนต์ eventdata ที่เป็นอนุกรมอยู่แล้วลงในบัฟเฟอร์เหตุการณ์

รายละเอียด
พารามิเตอร์
[in,out] ioWriter
นักเขียนที่จะใช้ในการเขียนเหตุการณ์
[in] inDataTag
แท็กบริบทสำหรับ TLV เรากำลังคัดลอกออก ไม่ได้ใช้ที่นี่ แต่ต้องการโดย typedef สำหรับ EventWriterFunct
[in] appData
ตัวชี้ไปยัง TLVReader ที่เก็บข้อมูลเหตุการณ์ต่อเนื่อง
ส่งกลับค่า
WEAVE_NO_ERROR
เมื่อประสบความสำเร็จ
other
ข้อผิดพลาดอื่น ๆ ที่ mey ส่งคืนจาก ioWriter

GetPropertyDictionaryKey

PropertyDictionaryKey GetPropertyDictionaryKey(
  PropertyPathHandle aHandle
)

GetPropertySchemaHandle

PropertySchemaHandle GetPropertySchemaHandle(
  PropertyPathHandle aHandle
)

IsNullPropertyPathHandle

bool IsNullPropertyPathHandle(
  PropertyPathHandle aHandle
)

IsRootPropertyPathHandle

bool IsRootPropertyPathHandle(
  PropertyPathHandle aHandle
)

IsVersionใหม่กว่า

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

นี่คือการปรับใช้อัลกอริทึมให้เหมาะสมที่สุดเพื่อเปรียบเทียบเวอร์ชันต่างๆ

ในฝั่งไคลเอ็นต์ เวอร์ชันที่ได้รับจากบริการจะเป็นเวอร์ชันล่าสุดเสมอ

IsVersionNewerOrEqual

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

ค้นหา

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

ฟังก์ชั่นยูทิลิตี้ที่พบ TraitUpdatableDataSink ใน TraitDataSink แคตตาล็อก

รายละเอียด
พารามิเตอร์
[in] aTraitDataHandle
ที่จับของ Sink เพื่อค้นหา
[in] aDataSinkCatalog
แคตตาล็อกเพื่อค้นหา
คืนสินค้า
ตัวชี้ไปยัง TraitUpdatableDataSink ; NULL ถ้าจับไม่ได้อยู่หรือชี้ไปยังสามารถปรับปรุงไม่ใช่ TraitDataSink

LogEvent

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

บันทึกเหตุการณ์จากแบบฟอร์ม pre-serialized

ฟังก์ชั่นบันทึกเหตุการณ์ที่แสดงเป็นNL :: สาน :: TLV :: TLVReader ซึ่งหมายความว่าการแสดงข้อมูลเหตุการณ์ต่อเนื่องอยู่แล้วในการจัดเก็บข้อมูลพื้นฐานNL :: สาน :: TLV :: TLVReaderNL :: สาน :: TLV :: TLVReader คาดว่าจะมีอย่างน้อยองค์ประกอบข้อมูลเดียวองค์ประกอบที่จะต้องเป็นโครงสร้าง องค์ประกอบแรกที่อ่านออกจากเครื่องอ่านจะถือเป็นข้อมูลเหตุการณ์และจัดเก็บไว้ในบันทึกเหตุการณ์ ข้อมูลเหตุการณ์ต้องมีแท็กบริบทที่จะตีความภายในสคีมาที่ระบุโดย inProfileID และ inEventType แท็กขององค์ประกอบแรกจะถูกละเว้น ระบบบันทึกเหตุการณ์จะแทนที่ด้วยแท็ก eventData

กรณีที่มีการบันทึกไว้ถ้า inImportance สูงกว่าเกณฑ์การเข้าสู่ระบบที่ระบุไว้ใน LoggingConfiguration หากความสำคัญของเหตุการณ์ไม่เป็นไปตามเกณฑ์ปัจจุบันก็จะลดลงและฟังก์ชั่นส่งกลับ 0 เป็น ID เหตุการณ์ที่เกิด

ตัวแปรของการเรียกใช้นี้ระบุตัวเลือกเหตุการณ์เริ่มต้นทั้งหมดโดยปริยาย:

  • เหตุการณ์ถูกประทับเวลาด้วยเวลาปัจจุบัน ณ จุดที่โทร
  • เหตุการณ์ถูกทำเครื่องหมายว่าเกี่ยวข้องกับอุปกรณ์ที่ทำการโทร
  • เหตุการณ์เป็นแบบสแตนด์อโลน ไม่เกี่ยวข้องกับเหตุการณ์อื่นใด
  • เหตุการณ์ถูกทำเครื่องหมายว่าไม่เร่งด่วน

รายละเอียด
พารามิเตอร์
[in] inSchema
Schema กำหนดความสำคัญ ID รายละเอียดและประเภทโครงสร้างของเหตุการณ์นี้
[in] inData
TLV ผู้อ่านที่มีข้อมูลกิจกรรมเป็นองค์ประกอบแรก
คืนสินค้า
event_id_t ID เหตุการณ์ถ้าเหตุการณ์ถูกเขียนลงในบันทึก มิฉะนั้น 0

LogEvent

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

บันทึกเหตุการณ์จากฟอร์มที่จัดลำดับล่วงหน้าพร้อมตัวเลือกเพิ่มเติม

ฟังก์ชั่นบันทึกเหตุการณ์ที่แสดงเป็นNL :: สาน :: TLV :: TLVReader ซึ่งหมายความว่าการแสดงข้อมูลเหตุการณ์ต่อเนื่องอยู่แล้วในการจัดเก็บข้อมูลพื้นฐานNL :: สาน :: TLV :: TLVReaderNL :: สาน :: TLV :: TLVReader คาดว่าจะมีอย่างน้อยองค์ประกอบข้อมูลเดียวองค์ประกอบที่จะต้องเป็นโครงสร้าง องค์ประกอบแรกที่อ่านออกจากเครื่องอ่านจะถือเป็นข้อมูลเหตุการณ์และจัดเก็บไว้ในบันทึกเหตุการณ์ ข้อมูลเหตุการณ์ต้องมีแท็กบริบทที่จะตีความภายในสคีมาที่ระบุโดย inProfileID และ inEventType แท็กขององค์ประกอบแรกจะถูกละเว้น ระบบบันทึกเหตุการณ์จะแทนที่ด้วยแท็ก eventData

กรณีที่มีการบันทึกไว้ถ้า inImportance สูงกว่าเกณฑ์การเข้าสู่ระบบที่ระบุไว้ใน LoggingConfiguration หากความสำคัญของเหตุการณ์ไม่เป็นไปตามเกณฑ์ปัจจุบันก็จะลดลงและฟังก์ชั่นส่งกลับ 0 เป็น ID เหตุการณ์ที่เกิด

แตกต่างจากการภาวนานี้อนุญาตให้โทรไปตั้งรวมกันของใด ๆ EventOptions :

  • การประทับเวลา เมื่อ 0 ตั้งค่าเริ่มต้นเป็นเวลาปัจจุบัน ณ จุดที่โทร
  • ส่วน "รูท" ของแหล่งที่มาของเหตุการณ์ (ที่มาของเหตุการณ์และ ID ลักษณะ) หากเป็น NULL ค่าเริ่มต้นจะเป็นอุปกรณ์ปัจจุบัน เหตุการณ์ถูกทำเครื่องหมายว่าเกี่ยวข้องกับอุปกรณ์ที่ทำการโทร
  • ID เหตุการณ์ที่เกี่ยวข้องสำหรับการจัดกลุ่ม ID เหตุการณ์ เมื่อ ID เหตุการณ์ที่เกี่ยวข้องเป็น 0 เหตุการณ์จะถูกทำเครื่องหมายว่าไม่เกี่ยวข้องกับเหตุการณ์อื่นใด
  • ความเร่งด่วน; โดยปริยายไม่เร่งด่วน

รายละเอียด
พารามิเตอร์
[in] inSchema
Schema กำหนดความสำคัญ ID รายละเอียดและประเภทโครงสร้างของเหตุการณ์นี้
[in] inData
TLV ผู้อ่านที่มีข้อมูลกิจกรรมเป็นองค์ประกอบแรก ต้องไม่เป็น NULL
[in] inOptions
ตัวเลือกสำหรับข้อมูลเมตาของเหตุการณ์ อาจเป็นโมฆะ
คืนสินค้า
event_id_t ID เหตุการณ์ถ้าเหตุการณ์ถูกเขียนลงในบันทึก มิฉะนั้น 0

LogEvent

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

บันทึกเหตุการณ์ผ่านการโทรกลับ

ฟังก์ชั่นบันทึกเหตุการณ์ที่แสดงเป็น EventWriterFunct และเฉพาะแอป appData บริบท ฟังก์ชั่นการเขียนข้อมูลเมตาของเหตุการณ์และเรียก inEventWriter กับNL :: สาน :: TLV :: TLVWriter อ้างอิงและ inAppData บริบทเพื่อให้รหัสผู้ใช้สามารถปล่อยข้อมูลเหตุการณ์โดยตรงลงในแฟ้มบันทึกเหตุการณ์ การบันทึกเหตุการณ์รูปแบบนี้ช่วยลดการใช้หน่วยความจำ เนื่องจากข้อมูลเหตุการณ์ถูกทำให้เป็นอนุกรมโดยตรงในบัฟเฟอร์เป้าหมาย ข้อมูลเหตุการณ์ต้องมีแท็กบริบทจะตีความภายในคีระบุ inProfileID และ inEventType แท็กขององค์ประกอบแรกจะถูกละเว้น ระบบบันทึกเหตุการณ์จะแทนที่ด้วยแท็ก eventData

กรณีที่มีการบันทึกไว้ถ้า inImportance สูงกว่าเกณฑ์การเข้าสู่ระบบที่ระบุไว้ใน LoggingConfiguration หากความสำคัญของเหตุการณ์ไม่เป็นไปตามเกณฑ์ปัจจุบันก็จะลดลงและฟังก์ชั่นส่งกลับ 0 เป็น ID เหตุการณ์ที่เกิด

ตัวแปรของการเรียกใช้นี้ระบุตัวเลือกเหตุการณ์เริ่มต้นทั้งหมดโดยปริยาย:

  • เหตุการณ์ถูกประทับเวลาด้วยเวลาปัจจุบัน ณ จุดที่โทร
  • เหตุการณ์ถูกทำเครื่องหมายว่าเกี่ยวข้องกับอุปกรณ์ที่ทำการโทร
  • เหตุการณ์เป็นแบบสแตนด์อโลน ไม่เกี่ยวข้องกับเหตุการณ์อื่นใด
  • เหตุการณ์ถูกทำเครื่องหมายว่าไม่เร่งด่วน

รายละเอียด
พารามิเตอร์
[in] inSchema
Schema กำหนดความสำคัญ ID รายละเอียดและประเภทโครงสร้างของเหตุการณ์นี้
[in] inEventWriter
การโทรกลับเพื่อเรียกใช้เพื่อให้เป็นอนุกรมของข้อมูลเหตุการณ์จริง ๆ
[in] inAppData
บริบทแอปพลิเคชันสำหรับการโทรกลับ
คืนสินค้า
event_id_t ID เหตุการณ์ถ้าเหตุการณ์ถูกเขียนลงในบันทึก มิฉะนั้น 0

LogEvent

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

บันทึกเหตุการณ์ผ่านการโทรกลับพร้อมตัวเลือก

ฟังก์ชั่นบันทึกเหตุการณ์ที่แสดงเป็น EventWriterFunct และเฉพาะแอป appData บริบท ฟังก์ชั่นการเขียนข้อมูลเมตาของเหตุการณ์และเรียก inEventWriter กับNL :: สาน :: TLV :: TLVWriter อ้างอิงและ inAppData บริบทเพื่อให้รหัสผู้ใช้สามารถปล่อยข้อมูลเหตุการณ์โดยตรงลงในแฟ้มบันทึกเหตุการณ์ รูปแบบการบันทึกเหตุการณ์นี้ช่วยลดการใช้หน่วยความจำ เนื่องจากข้อมูลเหตุการณ์ถูกทำให้เป็นอนุกรมโดยตรงในบัฟเฟอร์เป้าหมาย ข้อมูลเหตุการณ์ต้องมีแท็กบริบทจะตีความภายในคีระบุ inProfileID และ inEventType แท็กขององค์ประกอบแรกจะถูกละเว้น ระบบบันทึกเหตุการณ์จะแทนที่ด้วยแท็ก eventData

กรณีที่มีการบันทึกไว้ถ้า inImportance สูงกว่าเกณฑ์การเข้าสู่ระบบที่ระบุไว้ใน LoggingConfiguration หากความสำคัญของเหตุการณ์ไม่เป็นไปตามเกณฑ์ปัจจุบันก็จะลดลงและฟังก์ชั่นส่งกลับ 0 เป็น ID เหตุการณ์ที่เกิด

แตกต่างจากการภาวนานี้อนุญาตให้โทรไปตั้งรวมกันของใด ๆ EventOptions :

  • การประทับเวลา เมื่อ 0 ตั้งค่าเริ่มต้นเป็นเวลาปัจจุบัน ณ จุดที่โทร
  • ส่วน "รูท" ของแหล่งที่มาของเหตุการณ์ (ที่มาของเหตุการณ์และ ID ลักษณะ) หากเป็น NULL ค่าเริ่มต้นจะเป็นอุปกรณ์ปัจจุบัน เหตุการณ์ถูกทำเครื่องหมายว่าเกี่ยวข้องกับอุปกรณ์ที่ทำการโทร
  • ID เหตุการณ์ที่เกี่ยวข้องสำหรับการจัดกลุ่ม ID เหตุการณ์ เมื่อ ID เหตุการณ์ที่เกี่ยวข้องเป็น 0 เหตุการณ์จะถูกทำเครื่องหมายว่าไม่เกี่ยวข้องกับเหตุการณ์อื่นใด
  • ความเร่งด่วน; โดยค่าเริ่มต้นไม่เร่งด่วน

รายละเอียด
พารามิเตอร์
[in] inSchema
Schema กำหนดความสำคัญ ID รายละเอียดและประเภทโครงสร้างของเหตุการณ์นี้
[in] inEventWriter
การโทรกลับเพื่อเรียกใช้เพื่อให้เป็นอนุกรมของข้อมูลเหตุการณ์จริง ๆ
[in] inAppData
บริบทแอปพลิเคชันสำหรับการโทรกลับ
[in] inOptions
ตัวเลือกสำหรับข้อมูลเมตาของเหตุการณ์ อาจเป็นโมฆะ
คืนสินค้า
event_id_t ID เหตุการณ์ถ้าเหตุการณ์ถูกเขียนลงในบันทึก มิฉะนั้น 0

LogFreeform

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

LogFreeform ปล่อยสตริงรูปแบบอิสระไปยังสตรีมเหตุการณ์เริ่มต้น

สตริงจะถูกห่อหุ้มในโครงสร้างเหตุการณ์การดีบัก ซึ่งมีโครงสร้างเหมือนกับสตริงที่บันทึกไว้อื่นๆ รหัสรายละเอียดเหตุการณ์จะเป็นที่ของเหตุการณ์ Nest ตรวจแก้จุดบกพร่องและชนิดเหตุการณ์จะ kNestDebug_StringLogEntryEvent

รายละเอียด
พารามิเตอร์
[in] inImportance
ความสำคัญของรายการบันทึก หากความสำคัญต่ำกว่าความสำคัญในปัจจุบัน เหตุการณ์จะไม่ถูกบันทึกจริง
[in] inFormat
printf สตริงรูปแบบที่เข้ากันตามด้วยข้อโต้แย้งการจัดรูปแบบ
คืนสินค้า
event_id_t ID เหตุการณ์ถ้าเหตุการณ์ถูกเขียนลงในบันทึก มิฉะนั้น 0

LookForElementWithTag

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

นักเขียนข้อความธรรมดา

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
ข้อผิดพลาดอื่น ๆ ที่ mey ส่งคืนจาก ioWriter

นักเขียนข้อความธรรมดา

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
)