Google cam kết thúc đẩy công bằng chủng tộc cho Cộng đồng người da đen. Xem cách thực hiện.

nl :: Dệt :: Hồ sơ :: DataManagement_Current

Không gian tên này bao gồm tất cả các giao diện trong Weave cho cấu hình Quản lý dữ liệu Weave (WDM) hiện được hỗ trợ để sử dụng trong sản xuất.

Tóm lược

Bảng kê

@100 {
kTag_Region = 1,
kTag_Message = 2
}
enum
Các thẻ cho kNestDebug_StringLogEntryEvent.
@101 {
kTag_Token = 1,
kTag_Args = 2
}
enum
Các thẻ cho kNestDebug_TokenizedLogEntryEvent.
@102 enum
Thẻ cho các sự kiện liên tục.
@104 enum
Các loại thông báo cấu hình WDM.
@105 enum
Mã trạng thái cụ thể của WDM.
@147 enum
@95 {
kTag_CurrentImportance = 1,
kTag_ImportanceExpiration ,
kTag_MinimumLogUploadInterval ,
kTag_MaximumLogUploadInterval ,
kTag_LoggingDestination ,
kTag_TraitLoggingImportance
}
enum
Logging Cài đặt thẻ.
@96 {
kTag_SupportedLogTransports = 1,
kTag_SupportsStreaming = 2,
kTag_SupportsNonVolatileStorage = 3,
kTag_SupportsPerTraitVerbosity = 4,
kTag_LoggingVolume = 5,
kTag_LogBufferingCapacity = 6
}
enum
Thẻ cho khả năng ghi nhật ký.
@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
Thẻ cho siêu dữ liệu sự kiện.
@98 enum
Định nghĩa hồ sơ cho đặc điểm gỡ lỗi.
@99 {
kNestDebug_StringLogEntryEvent = 1,
kNestDebug_TokenizedLogEntryEvent = 2,
kNestDebug_TokenizedHeaderEntryEvent = 3
}
enum
Các loại sự kiện cho đặc điểm 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
Tầm quan trọng của mục nhập nhật ký.
LoggingManagementStates {
kLoggingManagementState_Idle = 1,
kLoggingManagementState_InProgress = 2,
kLoggingManagementState_Holdoff = 3,
kLoggingManagementState_Shutdown = 4
}
enum
TimestampType enum
Tính hợp lệ và loại timestamp trong EventOptions .

Typedefs

CommandFlags typedef
DataVersion typedef
uint64_t
EventProcessor typedef
void *
EventWriterFunct )(nl::Weave::TLV::TLVWriter &ioWriter, uint8_t inDataTag, void *appData) typedef
Một hàm cung cấp phần tử dữ liệu sự kiện cho hệ thống con ghi nhật ký sự kiện.
FetchExternalEventsFunct )(EventLoadOutContext *aContext) typedef
Một nguyên mẫu hàm cho lệnh gọi lại nền tảng tìm nạp dữ liệu sự kiện.
GenericTraitSinkCatalog typedef
GenericTraitSourceCatalog typedef
ImportanceType typedef
Tầm quan trọng của mục nhập nhật ký.
IteratorCallback )(void *aTraitInstance, TraitDataHandle aHandle, void *aContext) typedef
void(*
Trình lặp xử lý đặc điểm.
LoggingBufferHandler )(void *inAppState, PacketBuffer *inBuffer) typedef
NotifyExternalEventsDeliveredFunct )(ExternalEvents *inEv, event_id_t inLastDeliveredEventID, uint64_t inRecipientNodeID) typedef
void(*
Một nguyên mẫu hàm cho một cuộc gọi lại được gọi khi các sự kiện bên ngoài được gửi đến thuê bao từ xa.
NotifyExternalEventsEvictedFunct )(ExternalEvents *inEv) typedef
void(*
Một nguyên mẫu hàm cho một lệnh gọi lại được gọi khi các sự kiện bên ngoài bị loại bỏ khỏi bộ đệm.
PropertyDictionaryKey typedef
uint16_t
PropertyPathHandle typedef
uint32_t
PropertyPathHandle là một băm số 32 bit duy nhất của đường dẫn WDM liên quan đến gốc của một cá thể đặc điểm.
PropertySchemaHandle typedef
uint16_t
SchemaVersion typedef
uint16_t
SingleResourceSinkTraitCatalog typedef
SingleResourceSourceTraitCatalog typedef
TimestampType typedef
Tính hợp lệ và loại timestamp trong EventOptions .
TraitDataHandle typedef
uint16_t
duration_t nl :: Weave :: Profiles :: DataManagement_Current :: time_t
uint32_t
Loại được sử dụng để mô tả thời lượng, tính bằng mili giây.
event_id_t nl :: Weave :: Profiles :: DataManagement_Current :: event_id_t
uint32_t
Loại ID sự kiện.
timestamp_t nl :: Weave :: Profiles :: DataManagement_Current :: timestamp_t
uint32_t
Loại được sử dụng để mô tả dấu thời gian tính bằng mili giây.
utc_timestamp_t nl :: Weave :: Profiles :: DataManagement_Current :: utc_timestamp_t
uint64_t
Loại được sử dụng để mô tả dấu thời gian UTC tính bằng mili giây.

Biến

sInstance
sLogFileName = "topazlog"[]
char

Chức năng

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)
Một hàm trợ giúp dịch một phần tử dữ liệu sự kiện đã được tuần tự hóa vào bộ đệm sự kiện.
GetPropertyDictionaryKey ( PropertyPathHandle aHandle)
PropertyDictionaryKey
GetPropertySchemaHandle ( PropertyPathHandle aHandle)
PropertySchemaHandle
IsNullPropertyPathHandle ( PropertyPathHandle aHandle)
bool
IsRootPropertyPathHandle ( PropertyPathHandle aHandle)
bool
IsVersionNewer (const DataVersion & aVersion, const DataVersion & aReference)
bool
Đây là một triển khai tối ưu hóa của thuật toán để so sánh các phiên bản.
IsVersionNewerOrEqual (const DataVersion & aVersion, const DataVersion & aReference)
bool
Locate (TraitDataHandle aTraitDataHandle, const TraitCatalogBase < TraitDataSink > *aDataSinkCatalog)
Chức năng tiện ích mà tìm thấy một TraitUpdatableDataSink trong một TraitDataSink danh mục.
LogEvent (const EventSchema & inSchema,nl::Weave::TLV::TLVReader & inData)
Ghi nhật ký một sự kiện từ một biểu mẫu được đăng trước.
LogEvent (const EventSchema & inSchema,nl::Weave::TLV::TLVReader & inData, const EventOptions *inOptions)
Ghi nhật ký một sự kiện từ một biểu mẫu được đăng trước, với các tùy chọn bổ sung.
LogEvent (const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData)
Ghi lại một sự kiện thông qua một cuộc gọi lại.
LogEvent (const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData, const EventOptions *inOptions)
Ghi lại một sự kiện thông qua một cuộc gọi lại, với các tùy chọn
LogFreeform ( ImportanceType inImportance, const char *inFormat, ...)
LogFreeform phát ra một chuỗi dạng tự do cho luồng sự kiện mặc định.
LookForElementWithTag (constnl::Weave::TLV::TLVReader & aSrcReader, const uint64_t aTagInApiForm,nl::Weave::TLV::TLVReader *apDstReader)
PlainTextWriter (TLVWriter & ioWriter, uint8_t inDataTag, void *appData)
Một chức năng trợ giúp để tạo ra một văn bản dạng tự do dưới dạng một sự kiện gỡ lỗi.
PlainTextWriter (::nl::Weave::TLV::TLVWriter & ioWriter, uint8_t inDataTag, void *appData)
Một chức năng trợ giúp để tạo ra một văn bản dạng tự do dưới dạng một sự kiện gỡ lỗi.
operator!= (const ResourceIdentifier & lhs, const ResourceIdentifier & rhs)
bool
operator== (const ResourceIdentifier & lhs, const ResourceIdentifier & rhs)
bool

Các lớp học

nl :: Weave :: Profiles :: DataManagement_Current :: AlwaysAcceptDataElementAccessControlDelegate
nl :: Weave :: Profiles :: DataManagement_Current :: BuilderBase

Lớp cơ sở cho bộ mã hóa thông báo WDM.

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

Một TLVReader được hỗ trợ bởi CircularEventBuffer .

nl :: Weave :: Profiles :: DataManagement_Current :: lệnh
nl :: Weave :: Profiles :: DataManagement_Current :: CommandSender
nl :: Weave :: Profiles :: DataManagement_Current :: GenericTraitCatalogImpl

Một Weave cung cấp thi hành TraitCatalogBase giao diện cho một tập hợp các trường hợp dữ liệu đặc điểm mà tất cả tham khảo các tài nguyên tương tự.

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

Giao diện được thực thi bởi bộ xử lý các phần tử dữ liệu trong NotifyRequest.

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

Giao diện được ứng dụng thực hiện để tuần tự hóa quyền truy cập vào các cấu trúc dữ liệu WDM chính.

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

Giao diện của một đối tượng mutex.

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

Lớp cơ sở cho các bộ mã hóa thông điệp WDM, chuyên TLV phần tử mảng như Lists dữ liệu và Danh sách Version.

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

Lớp cơ sở cho phân tích cú pháp nhắn WDM, chuyên TLV phần tử mảng như Lists dữ liệu và Danh sách Version.

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

LoggingConfiguration đóng gói các thành phần cấu hình của Weave Event Logging hệ thống phụ.

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

Một lớp để quản lý các bản ghi sự kiện trong bộ nhớ.

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

Lớp cơ sở cho trình phân tích cú pháp tin nhắn WDM.

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

Một cấu trúc đóng gói ID của một tài nguyên.

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

Đây là một singleton lưu trữ tất cả các đăng ký WDM Next, cả phía khách hàng và nhà xuất bản.

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

Công cụ lược đồ lấy thông tin lược đồ được liên kết với một đặc điểm cụ thể và cung cấp các phương tiện để phân tích cú pháp và dịch thông tin đó thành một dạng mà máy WDM có thể sử dụng được.

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

Lớp tiện ích để đưa từ điển trở lại hàng đợi chờ xử lý khi xử lý đường dẫn thuộc tính có con từ điển.

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

Lớp tiện ích để lọc đường dẫn khi xử lý thông báo.

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

Đây đối tượng mã hóa WDM UpdateRequest và PartialUpdateRequest trọng tải.

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

Cấu trúc

nl :: Weave :: Profiles :: DataManagement_Current :: CircularEventBuffer

Đệm sự kiện nội bộ, xây dựng xung quanh các nl :: Weave :: TLV :: WeaveCircularTLVBuffer .

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

Cấu trúc bên trong để duyệt qua danh sách sự kiện.

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

Cấu trúc cung cấp độ phân giải đầy đủ của cá thể đặc điểm.

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

Cấu trúc bên trong cho các sự kiện đi ngang.

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

Cấu trúc sao chép danh sách sự kiện trên đầu ra.

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

Cấu trúc cung cấp các tùy chọn cho các trường sự kiện khác nhau.

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

Cấu trúc xác định một lược đồ cho siêu dữ liệu sự kiện.

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

Cấu trúc để theo dõi các sự kiện được lưu trữ trên nền tảng.

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

Một lớp trợ giúp được sử dụng để khởi tạo quản lý ghi nhật ký.

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

Đoàn thể

nl :: Weave :: Profiles :: DataManagement_Current :: Timestamp

Công đoàn cung cấp hệ thống tập hợp ứng dụng hoặc dấu thời gian UTC.

Không gian tên

nl :: Weave :: Profiles :: DataManagement_Current :: BaseMessageWithSubscribeId
nl :: Weave :: Profiles :: DataManagement_Current :: CustomCommand

WDM Tuỳ chỉnh lệnh định nghĩa.

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

WDM Tuỳ chỉnh lệnh đáp ứng định nghĩa.

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

Định nghĩa phần tử dữ liệu WDM.

nl :: Weave :: Profiles :: DataManagement_Current :: DataList
nl :: Weave :: Profiles :: DataManagement_Current :: Sự kiện
nl :: Weave :: Profiles :: DataManagement_Current :: EventList
nl :: Weave :: Profiles :: DataManagement_Current :: NotificationRequest
nl :: Weave :: Profiles :: DataManagement_Current :: Đường dẫn

WDM đường nét.

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

WDM Đường dẫn định nghĩa danh sách.

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

Định nghĩa phần tử trạng thái 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

Định nghĩa Yêu cầu Cập nhật WDM Yêu cầu.

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

Bảng kê

@ 100

 @100

Các thẻ cho kNestDebug_StringLogEntryEvent.

Tính chất
kTag_Message

Một chuỗi chứa thông báo gỡ lỗi thực tế.

kTag_Region

Một 32-bit không được đánh dấu cho biết vùng nhật ký, tức là mô-đun mà thông báo nhật ký gắn liền với nó.

@ 101

 @101

Các thẻ cho kNestDebug_TokenizedLogEntryEvent.

Tính chất
kTag_Args

Một mảng các đối số sẽ được gửi cùng với thông báo mã thông báo.

kTag_Token

Giá trị không dấu 32 bit tương ứng với mã thông báo.

@ 102

 @102

Thẻ cho các sự kiện liên tục.

@ 104

 @104

Các loại thông báo cấu hình WDM.

Các giá trị này được gọi ra trong đặc tả quản lý dữ liệu.

@ 105

 @105

Mã trạng thái cụ thể của WDM.

@ 147

 @147

@ 95

 @95

Logging Cài đặt thẻ.

Tính chất
kTag_CurrentImportance

Mức độ quan trọng của việc ghi nhật ký hiện tại, giá trị thuộc loại ImportanceType.

kTag_ImportanceExpiration

Thời gian, tính bằng giây UTC khi cài đặt ghi nhật ký nâng cao hiện tại hoàn nguyên về giá trị mặc định.

kTag_LoggingDestination

URL biểu thị đích của việc tải lên nhật ký.

kTag_MaximumLogUploadInterval

Thời lượng tối đa, tính bằng giây, giữa các lần tải lên nhật ký được kích hoạt tự động.

kTag_MinimumLogUploadInterval

Thời lượng tối thiểu, tính bằng giây, giữa các lần tải lên nhật ký được kích hoạt tự động.

kTag_TraitLoggingImportance

Một mảng tùy chọn ánh xạ có chọn lọc các cấu hình đã chọn lên các cấp độ ghi nhật ký cao hơn.

Mỗi phần tử trong mảng có một biểu mẫu (hồ sơ, đường dẫn, quan trọng ghi nhật ký) để nâng cấp ghi nhật ký một cách có chọn lọc từ một tập hợp con của hệ thống. Mức độ ưu tiên ghi nhật ký hồ sơ nâng cao chỉ có ý nghĩa khi mức độ ưu tiên ghi nhật ký vượt quá mức độ quan trọng của currentImportance và có cùng thời gian hết hạn với mức độ quan trọng hiện tại.

@ 96

 @96

Thẻ cho khả năng ghi nhật ký.

Tính chất
kTag_LogBufferingCapacity

Một số nguyên không dấu 32 bit mô tả khả năng đệm nhật ký tính bằng kB.

kTag_LoggingVolume

Một số nguyên không dấu 32 bit mô tả khối lượng ghi nhật ký dự kiến ​​tính bằng kB / ngày.

kTag_SupportedLogTransports

Một loạt các cơ chế vận chuyển nhật ký được hỗ trợ.

kTag_SupportsNonVolatileStorage

Một boolean cho biết thiết bị có hỗ trợ lưu trữ nhật ký không biến đổi hay không.

kTag_SupportsPerTraitVerbosity

Một boolean cho biết thiết bị có hỗ trợ cài đặt chi tiết theo từng đặc điểm hay không.

kTag_SupportsStreaming

Một boolean cho biết thiết bị có hỗ trợ nhật ký phát trực tuyến hay không.

@ 97

 @97

Thẻ cho siêu dữ liệu sự kiện.

Để biết ngữ nghĩa đầy đủ của các giá trị thẻ, hãy xem Đặc điểm thiết kế sự kiện.

Tính chất
kTag_EventData

Không bắt buộc. Dữ liệu sự kiện của chính nó. Nếu trống, nó mặc định là một cấu trúc trống.

kTag_EventDeltaSystemTime

Thẻ nội bộ WDM, chênh lệch thời gian so với sự kiện trước đó trong bảng mã.

kTag_EventDeltaUTCTime

Thẻ nội bộ WDM, chênh lệch thời gian so với sự kiện trước đó trong bảng mã.

kTag_EventID

Số thứ tự của sự kiện, được biểu thị dưới dạng số lượng không dấu 64 bit.

Phải tuần tự, các bước nhảy trong chuỗi chỉ ra khoảng trống sự kiện.

kTag_EventImportance

Tầm quan trọng của sự kiện.

kTag_EventResourceID

Không bắt buộc.

Giá trị là ID của tài nguyên mà sự kiện liên quan đến. Khi bị bỏ qua, giá trị giống với giá trị của kTag_EventSource

kTag_EventSource

NodeID của thiết bị đã tạo sự kiện.

kTag_EventSystemTimestamp

Không bắt buộc. Hệ thống Timestamp của sự kiện trong mili giây.

kTag_EventTraitInstanceID

Tùy chọn, bản sao của đặc điểm đã tạo ra sự kiện.

kTag_EventTraitProfileID

Bắt buộc. Số nguyên không dấu 32 bit bằng với ProfileID của đặc điểm.

kTag_EventType

Bắt buộc. Số nguyên không dấu 16 bit bằng với wdl.event.id cho loại sự kiện này.

kTag_EventUTCTimestamp

Không bắt buộc. UTC Timestamp của sự kiện trong mili giây.

kTag_ExternalEventStructure

Thẻ nội bộ cho các sự kiện bên ngoài. Không bao giờ được truyền qua dây, không bao giờ được sử dụng bên ngoài thư viện Weave.

kTag_RelatedEventID

Không bắt buộc.

ID của một sự kiện có liên quan đến sự kiện này. Nếu bỏ qua, giá trị bằng giá trị của kTag_EventID.

kTag_RelatedEventImportance

Không bắt buộc.

Tầm quan trọng của sự kiện liên quan. Nếu bỏ qua, giá trị bằng giá trị của kTag_EventImportance.

@ 98

 @98

Định nghĩa hồ sơ cho đặc điểm gỡ lỗi.

@ 99

 @99

Các loại sự kiện cho đặc điểm Nest Debug.

Tính chất
kNestDebug_StringLogEntryEvent

Sự kiện cho thông báo gỡ lỗi chuỗi dạng tự do.

kNestDebug_TokenizedHeaderEntryEvent

Một sự kiện để truyền tải thông tin tiêu đề được mã hóa.

kNestDebug_TokenizedLogEntryEvent

Một sự kiện cho thông báo gỡ lỗi được mã hóa.

CommandFlags

 CommandFlags
Tính chất
kCommandFlag_ActionTimeValid

Đặt khi thời gian hành động hợp lệ.

kCommandFlag_ExpiryTimeValid

Đặt khi thời gian hết hạn còn hiệu lực.

kCommandFlag_InitiationTimeValid

Đặt khi thời gian init hợp lệ.

kCommandFlag_IsOneWay

Đặt khi lệnh là một chiều.

kCommandFlag_MustBeVersionValid

Đặt khi trường phiên bản hợp lệ.

Tầm quan trọng

 ImportanceType

Tầm quan trọng của mục nhập nhật ký.

Tầm quan trọng được sử dụng như một cách để lọc các sự kiện trước khi chúng thực sự được đưa vào nhật ký. Sau khi sự kiện được ghi vào nhật ký, chúng tôi không đưa ra thêm quy định nào để xóa nó khỏi nhật ký. Mức độ quan trọng dùng để ưu tiên lưu trữ sự kiện. Nếu một sự kiện có tầm quan trọng cao được thêm vào bộ đệm đầy đủ, thì các sự kiện sẽ bị loại bỏ theo thứ tự quan trọng (và độ tuổi) để phù hợp với nó. Như vậy, mức độ quan trọng chỉ có giá trị tương đối. Nếu một hệ thống chỉ sử dụng một mức độ quan trọng, thì các sự kiện sẽ chỉ bị loại bỏ theo thứ tự độ tuổi, giống như một bộ đệm vòng.

Tính chất
Debug

Mức độ quan trọng của gỡ lỗi biểu thị các mục nhật ký mà các nhà phát triển hệ thống quan tâm và được sử dụng chủ yếu trong giai đoạn phát triển.

Nhật ký gỡ lỗi quan trọng không được tính vào ngân sách băng thông hoặc năng lượng của các thiết bị bị ràng buộc; do đó, chúng chỉ được sử dụng trong một khoảng thời gian giới hạn trong các hệ thống sản xuất.

Info

Tầm quan trọng của thông tin biểu thị các mục nhật ký cung cấp thêm thông tin chi tiết và chẩn đoán cho hệ thống đang chạy.

Mức ghi thông tin có thể được sử dụng trong một khoảng thời gian dài trong hệ thống sản xuất hoặc có thể được sử dụng làm mức ghi mặc định trong thử nghiệm hiện trường. Trên các thiết bị bị ràng buộc, các mục nhập được ghi với mức Thông tin phải được tính vào ngân sách băng thông và bộ nhớ, nhưng không tính vào ngân sách năng lượng.

Production

Tầm quan trọng của sản xuất biểu thị các mục nhập nhật ký được sử dụng trong quá trình giám sát và duy trì liên tục của hệ sinh thái Nest.

Trên các thiết bị bị ràng buộc, các mục nhập được ghi với Mức độ quan trọng của sản xuất phải được tính vào ngân sách năng lượng và bộ nhớ, vì dự kiến ​​chúng luôn được ghi lại và giảm tải khỏi thiết bị.

ProductionCritical

Sản xuất Tầm quan trọng quan trọng biểu thị các sự kiện mà tổn thất sẽ ảnh hưởng trực tiếp đến các tính năng mà khách hàng phải đối mặt.

Các ứng dụng có thể sử dụng mất các sự kiện Quan trọng trong Sản xuất để chỉ ra lỗi hệ thống. Trên các thiết bị bị hạn chế, các mục nhập được ghi với Mức độ quan trọng Sản xuất phải được tính vào ngân sách năng lượng và bộ nhớ, vì dự kiến ​​chúng luôn được ghi lại và giảm tải khỏi thiết bị.

LoggingManagementStates

 LoggingManagementStates
Tính chất
kLoggingManagementState_Holdoff

Đã hoàn tất quá trình giảm tải nhật ký; chúng tôi không khởi động lại nhật ký cho đến khi hết thời gian lưu giữ.

kLoggingManagementState_Idle

Không có quá trình giảm tải nhật ký nào đang diễn ra, quá trình giảm tải nhật ký có thể bắt đầu mà không có bất kỳ ràng buộc nào.

kLoggingManagementState_InProgress

Đang ghi nhật ký giảm tải.

kLoggingManagementState_Shutdown

Không có khả năng thực hiện bất kỳ hoạt động ghi nhật ký nào.

TimestampType

 TimestampType

Tính hợp lệ và loại timestamp trong EventOptions .

Typedefs

CommandFlags

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

DataVersion

uint64_t DataVersion

EventProcessor

void * EventProcessor

EventWriterFunct

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

Một hàm cung cấp phần tử dữ liệu sự kiện cho hệ thống con ghi nhật ký sự kiện.

Các hàm thuộc loại này được mong đợi sẽ cung cấp phần tử eventData cho hệ thống con ghi nhật ký sự kiện. Các chức năng của loại này được gọi sau khi hệ thống con sự kiện đã tạo tất cả siêu dữ liệu sự kiện bắt buộc. Hàm được gọi với mộtnl :: Weave :: TLV :: TLVWriter đối tượng vào đó nó sẽ phát ra một đơn TLV yếu tố gắn thẻ kTag_EventData; giá trị của phần tử đó PHẢI là một cấu trúc chứa dữ liệu sự kiện. Bản thân dữ liệu sự kiện phải được cấu trúc bằng cách sử dụng thẻ ngữ cảnh.

Chi tiết
Thông số
[in,out] ioWriter
Một tham chiếu tớinl :: Weave :: TLV :: TLVWriter đối tượng được sử dụng cho dữ liệu sự kiện serialization.
[in] inDataTag
Thẻ bối cảnh cho TLV chúng tôi viết ra.
[in] appData
Một con trỏ đến một ngữ cảnh cụ thể của ứng dụng.
Giá trị trả lại
WEAVE_NO_ERROR
Về thành công.
other
Một lỗi thích hợp báo hiệu cho người gọi rằng không thể hoàn thành việc tuần tự hóa dữ liệu sự kiện. Các lỗi từ các cuộc gọi đến ioWriter sẽ được lan truyền mà không cần ánh xạ lại. Nếu hàm trả về bất kỳ loại lỗi nào, quá trình tạo sự kiện sẽ bị hủy bỏ và sự kiện không được ghi vào nhật ký.
Xem thêm:
PlainTextWriter
EventWriterTLVCopy

FetchExternalEventsFunct

WEAVE_ERROR(* FetchExternalEventsFunct)(EventLoadOutContext *aContext)

Một nguyên mẫu hàm cho lệnh gọi lại nền tảng tìm nạp dữ liệu sự kiện.

Tương tự như FetchEventsSince, đây lấy chức năng trả về tất cả các sự kiện từ EventLoadOutContext.mStartingEventID qua ExternalEvents.mLastEventID .

Con trỏ ngữ cảnh thuộc loại FetchExternalEventsContext. Điều này bao gồm các EventLoadOutContext , với một số biến helper cho định dạng của TLV . Nó cũng bao gồm một con trỏ đến ExternalEvents struct tạo về đăng ký gọi lại. Điều này chỉ định phạm vi ID sự kiện cho lệnh gọi lại.

Khi trở về từ chức năng, EventLoadOutContext.mCurrentEventID nên phản ánh ID sự kiện đầu tiên mà đã không được viết thành công đến TLV đệm. Nền tảng phải viết các sự kiện header và dữ liệu vào TLV nhà văn trong định dạng đúng, theo quy định của Nghị định thư EventLogging. Nền tảng cũng phải duy trì tính duy nhất của các sự kiện và dấu thời gian.

Tất cả TLV lỗi nên được phổ biến đến mức cao hơn. Ví dụ: hết dung lượng trong bộ đệm sẽ kích hoạt một tin nhắn đã gửi, theo sau là một lệnh gọi lại khác với bất kỳ ID sự kiện nào còn lại.

Chi tiết
Giá trị trả lại
WEAVE_ERROR_NO_MEMORY
Nếu không có không gian để viết sự kiện.
WEAVE_ERROR_BUFFER_TOO_SMALL
Nếu không có không gian để viết sự kiện.
WEAVE_NO_ERROR
Về thành công.
WEAVE_END_OF_TLV
Về thành công.

GenericTraitSinkCatalog

GenericTraitCatalogImpl< TraitDataSink > GenericTraitSinkCatalog

GenericTraitSourceCatalog

GenericTraitCatalogImpl< TraitDataSource > GenericTraitSourceCatalog

Tầm quan trọng

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

Tầm quan trọng của mục nhập nhật ký.

Tầm quan trọng được sử dụng như một cách để lọc các sự kiện trước khi chúng thực sự được đưa vào nhật ký. Sau khi sự kiện được ghi vào nhật ký, chúng tôi không đưa ra thêm quy định nào để xóa nó khỏi nhật ký. Mức độ quan trọng dùng để ưu tiên lưu trữ sự kiện. Nếu một sự kiện có tầm quan trọng cao được thêm vào bộ đệm đầy đủ, thì các sự kiện sẽ bị loại bỏ theo thứ tự quan trọng (và độ tuổi) để phù hợp với nó. Như vậy, mức độ quan trọng chỉ có giá trị tương đối. Nếu một hệ thống chỉ sử dụng một mức độ quan trọng, thì các sự kiện sẽ chỉ bị loại bỏ theo thứ tự độ tuổi, giống như một bộ đệm vòng.

IteratorCallback

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

Trình lặp xử lý đặc điểm.

LoggingBufferHandler

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

NotifyExternalEventsDeliveredFunct

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

Một nguyên mẫu hàm cho một cuộc gọi lại được gọi khi các sự kiện bên ngoài được gửi đến thuê bao từ xa.

Khi các sự kiện bên ngoài được gửi đến một người đăng ký từ xa, công cụ sẽ cung cấp một thông báo cho nhà cung cấp sự kiện bên ngoài. Cuộc gọi lại chứa sự kiện của ID cuối cùng đã được gửi và ID của người đăng ký đã nhận sự kiện.

Chi tiết
Thông số
[in] inEv
Đối tượng sự kiện bên ngoài tương ứng với các sự kiện đã phân phối
[in] inLastDeliveredEventID
ID của sự kiện cuối cùng được gửi cho người đăng ký.
[in] inRecipientNodeID
Dệt ID nút của người nhận

NotifyExternalEventsEvictedFunct

void(* NotifyExternalEventsEvictedFunct)(ExternalEvents *inEv)

Một nguyên mẫu hàm cho một lệnh gọi lại được gọi khi các sự kiện bên ngoài bị loại bỏ khỏi bộ đệm.

Khi đối tượng sự kiện bên ngoài được loại bỏ khỏi bộ đệm tin nhắn đi, công cụ sẽ cung cấp thông báo cho nhà cung cấp sự kiện bên ngoài. Lệnh gọi lại chứa sự kiện bên ngoài sẽ bị loại bỏ.

Chi tiết
Thông số
[in] inEv
Các sự kiện bên ngoài phản đối được loại bỏ

PropertyDictionaryKey

uint16_t PropertyDictionaryKey

PropertyPathHandle

uint32_t PropertyPathHandle

PropertyPathHandle là một băm số 32 bit duy nhất của đường dẫn WDM liên quan đến gốc của một cá thể đặc điểm.

Nó có hai phần:

  • Một số 16 bit thấp hơn ánh xạ đến phần tĩnh của lược đồ.
  • Trong trường hợp 16 bit thấp hơn tham chiếu đến một đường dẫn trong một phần tử từ điển, một số 16 bit phía trên đại diện cho khóa từ điển được liên kết với phần tử đó. Nếu 16 bit dưới tham chiếu đến một phần tử không phải từ điển, thì 16 bit trên phải là 0.

Một số đặc điểm:

  • Mỗi đặc điểm đều có không gian xử lý đường dẫn thuộc tính riêng của nó.
  • Mỗi đường dẫn con WDM duy nhất sẽ có một PropertyPathHandle duy nhất tương tự.
  • PropertyPathHandles được trình biên dịch đặc điểm từ IDL tạo tự động (thực hiện bằng tay) và được biểu diễn dưới dạng danh sách liệt kê trong tệp tiêu đề của đặc điểm tương ứng.
  • Với cấu trúc này, logic ứng dụng không bao giờ phải xử lý trực tiếp các đường dẫn WDM. Thay vào đó, tương tác của họ với WDM được thực hiện độc quyền thông qua các tay cầm này.
  • Có hai giá trị dành riêng cho các xử lý đường dẫn có ý nghĩa cụ thể:
    • 0 chỉ ra một tay cầm 'NULL'
    • 1 chỉ ra một chốt trỏ đến gốc của cá thể đặc điểm.

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

Tính hợp lệ và loại timestamp trong EventOptions .

TraitDataHandle

uint16_t TraitDataHandle

thời lượng_t

uint32_t duration_t

Loại được sử dụng để mô tả thời lượng, tính bằng mili giây.

event_id_t

uint32_t event_id_t

Loại ID sự kiện.

timestamp_t

uint32_t timestamp_t

Loại được sử dụng để mô tả dấu thời gian tính bằng mili giây.

utc_timestamp_t

uint64_t utc_timestamp_t

Loại được sử dụng để mô tả dấu thời gian UTC tính bằng mili giây.

Biến

sInstance

LoggingManagement sInstance

sLogFileName

char sLogFileName[] = "topazlog"

Chức năng

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
)

Một hàm trợ giúp dịch một phần tử dữ liệu sự kiện đã được tuần tự hóa vào bộ đệm sự kiện.

Chi tiết
Thông số
[in,out] ioWriter
Người viết sử dụng để viết ra sự kiện
[in] inDataTag
Thẻ bối cảnh cho TLV chúng tôi đang sao chép ra. Không được sử dụng ở đây, nhưng được yêu cầu bởi typedef cho EventWriterFunct.
[in] appData
Một con trỏ tới TLVReader chứa dữ liệu sự kiện được tuần tự hóa.
Giá trị trả lại
WEAVE_NO_ERROR
Về thành công.
other
Các lỗi khác mà mey được trả về từ 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
)

Đây là cách triển khai thuật toán được tối ưu hóa để so sánh các phiên bản.

Về phía khách hàng, phiên bản nhận được từ dịch vụ luôn là phiên bản mới nhất.

IsVersionNewerOrEqual

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

Định vị

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

Chức năng tiện ích mà tìm thấy một TraitUpdatableDataSink trong một TraitDataSink danh mục.

Chi tiết
Thông số
[in] aTraitDataHandle
Xử lý Chậu rửa để tra cứu.
[in] aDataSinkCatalog
Danh mục để tìm kiếm.
Lợi nhuận
Một con trỏ tới các TraitUpdatableDataSink ; NULL nếu xử lý không tồn tại hoặc nó trỏ tới một tổ chức phi có thể cập nhật TraitDataSink .

LogEvent

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

Ghi nhật ký một sự kiện từ một biểu mẫu được đăng trước.

Chức năng đăng nhập một sự kiện biểu diễn như mộtnl :: Weave :: TLV :: TLVReader . Điều này ngụ ý rằng biểu diễn dữ liệu sự kiện đã được đăng trên các lưu trữ cơ bản cácnl :: Weave :: TLV :: TLVReader . Cácnl :: Weave :: TLV :: TLVReader dự kiến sẽ có ít nhất một yếu tố dữ liệu duy nhất, yếu tố đó phải là một cấu trúc. Phần tử đầu tiên được đọc ra khỏi trình đọc được coi là dữ liệu sự kiện và được lưu trữ trong nhật ký sự kiện. Dữ liệu sự kiện PHẢI chứa các thẻ ngữ cảnh được diễn giải trong lược đồ được xác định bởi inProfileID và inEventType. Thẻ của phần tử đầu tiên sẽ bị bỏ qua; hệ thống ghi sự kiện sẽ thay thế nó bằng thẻ eventData.

Sự kiện này được đăng nhập nếu inImportance của nó vượt quá ngưỡng khai thác gỗ quy định tại các LoggingConfiguration . Nếu tầm quan trọng của sự kiện không đáp ứng được ngưỡng hiện tại, nó đang giảm và hàm trả về một 0 như kết quả ID sự kiện.

Biến thể của lời gọi này hoàn toàn chỉ định tất cả các tùy chọn sự kiện mặc định:

  • sự kiện được đánh dấu thời gian với thời gian hiện tại tại thời điểm cuộc gọi,
  • sự kiện được đánh dấu là liên quan đến thiết bị đang thực hiện cuộc gọi,
  • sự kiện là độc lập, không liên quan đến bất kỳ sự kiện nào khác,
  • sự kiện được đánh dấu là không khẩn cấp,

Chi tiết
Thông số
[in] inSchema
Schema định tầm quan trọng, ID hồ sơ, và các loại cấu trúc của sự kiện này.
[in] inData
Các TLV đọc có chứa dữ liệu sự kiện là yếu tố đầu tiên.
Lợi nhuận
event_id_t ID sự kiện nếu sự kiện được ghi vào nhật ký, 0 nếu không.

LogEvent

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

Ghi nhật ký sự kiện từ một biểu mẫu được đăng trước, với các tùy chọn bổ sung.

Chức năng đăng nhập một sự kiện biểu diễn như mộtnl :: Weave :: TLV :: TLVReader . Điều này ngụ ý rằng biểu diễn dữ liệu sự kiện đã được đăng trên các lưu trữ cơ bản cácnl :: Weave :: TLV :: TLVReader . Cácnl :: Weave :: TLV :: TLVReader dự kiến sẽ có ít nhất một yếu tố dữ liệu duy nhất, yếu tố đó phải là một cấu trúc. Phần tử đầu tiên được đọc ra khỏi trình đọc được coi là dữ liệu sự kiện và được lưu trữ trong nhật ký sự kiện. Dữ liệu sự kiện PHẢI chứa các thẻ ngữ cảnh được diễn giải trong lược đồ được xác định bởi inProfileID và inEventType. Thẻ của phần tử đầu tiên sẽ bị bỏ qua; hệ thống ghi sự kiện sẽ thay thế nó bằng thẻ eventData.

Sự kiện này được đăng nhập nếu inImportance của nó vượt quá ngưỡng khai thác gỗ quy định tại các LoggingConfiguration . Nếu tầm quan trọng của sự kiện không đáp ứng được ngưỡng hiện tại, nó đang giảm và hàm trả về một 0 như kết quả ID sự kiện.

Phiên bản này của invocation cho phép người gọi để đặt bất kỳ sự kết hợp của EventOptions :

  • dấu thời gian, khi 0 được mặc định là thời gian hiện tại tại thời điểm cuộc gọi,
  • phần "gốc" của nguồn sự kiện (nguồn sự kiện và ID đặc điểm); nếu NULL, nó mặc định là thiết bị hiện tại. sự kiện được đánh dấu là liên quan đến thiết bị đang thực hiện cuộc gọi,
  • ID sự kiện liên quan để nhóm các ID sự kiện; khi ID sự kiện liên quan bằng 0, sự kiện được đánh dấu là không liên quan đến bất kỳ sự kiện nào khác,
  • khẩn cấp; theo mặc định là không khẩn cấp.

Chi tiết
Thông số
[in] inSchema
Schema định tầm quan trọng, ID hồ sơ, và các loại cấu trúc của sự kiện này.
[in] inData
Các TLV đọc có chứa dữ liệu sự kiện là yếu tố đầu tiên. Nó không vô giá trị
[in] inOptions
Các tùy chọn cho siêu dữ liệu sự kiện. Có thể là KHÔNG.
Lợi nhuận
event_id_t ID sự kiện nếu sự kiện được ghi vào nhật ký, 0 nếu không.

LogEvent

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

Ghi lại một sự kiện thông qua một cuộc gọi lại.

Chức năng đăng nhập một sự kiện biểu diễn dưới dạng một EventWriterFunct và một ứng dụng cụ thể appData ngữ cảnh. Chức năng viết các siêu dữ liệu sự kiện và gọi inEventWriter vớinl :: Weave :: TLV :: TLVWriter tham khảo và inAppData bối cảnh để mã người dùng có thể phát ra các dữ liệu sự kiện trực tiếp vào bản ghi sự kiện. Hình thức ghi sự kiện này giảm thiểu tiêu thụ bộ nhớ, vì dữ liệu sự kiện được tuần tự hóa trực tiếp vào bộ đệm đích. Các dữ liệu sự kiện PHẢI chứa các thẻ ngữ cảnh để được giải thích trong giản đồ xác định bởi inProfileIDinEventType . Thẻ của phần tử đầu tiên sẽ bị bỏ qua; hệ thống ghi sự kiện sẽ thay thế nó bằng thẻ eventData.

Sự kiện này được đăng nhập nếu inImportance của nó vượt quá ngưỡng khai thác gỗ quy định tại các LoggingConfiguration . Nếu tầm quan trọng của sự kiện không đáp ứng được ngưỡng hiện tại, nó đang giảm và hàm trả về một 0 như kết quả ID sự kiện.

Biến thể của lời gọi này hoàn toàn chỉ định tất cả các tùy chọn sự kiện mặc định:

  • sự kiện được đánh dấu thời gian với thời gian hiện tại tại thời điểm cuộc gọi,
  • sự kiện được đánh dấu là liên quan đến thiết bị đang thực hiện cuộc gọi,
  • sự kiện là độc lập, không liên quan đến bất kỳ sự kiện nào khác,
  • sự kiện được đánh dấu là không khẩn cấp,

Chi tiết
Thông số
[in] inSchema
Schema định tầm quan trọng, ID hồ sơ, và các loại cấu trúc của sự kiện này.
[in] inEventWriter
Lệnh gọi lại để gọi để thực sự tuần tự hóa dữ liệu sự kiện
[in] inAppData
Bối cảnh ứng dụng cho cuộc gọi lại.
Lợi nhuận
event_id_t ID sự kiện nếu sự kiện được ghi vào nhật ký, 0 nếu không.

LogEvent

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

Ghi nhật ký một sự kiện thông qua một cuộc gọi lại, với các tùy chọn.

Chức năng đăng nhập một sự kiện biểu diễn dưới dạng một EventWriterFunct và một ứng dụng cụ thể appData ngữ cảnh. Chức năng viết các siêu dữ liệu sự kiện và gọi inEventWriter vớinl :: Weave :: TLV :: TLVWriter tham khảo và inAppData bối cảnh để mã người dùng có thể phát ra các dữ liệu sự kiện trực tiếp vào bản ghi sự kiện. Hình thức ghi sự kiện này giảm thiểu tiêu thụ bộ nhớ, vì dữ liệu sự kiện được tuần tự hóa trực tiếp vào bộ đệm đích. Các dữ liệu sự kiện PHẢI chứa các thẻ ngữ cảnh để được giải thích trong giản đồ xác định bởi inProfileIDinEventType . Thẻ của phần tử đầu tiên sẽ bị bỏ qua; hệ thống ghi sự kiện sẽ thay thế nó bằng thẻ eventData.

Sự kiện này được đăng nhập nếu inImportance của nó vượt quá ngưỡng khai thác gỗ quy định tại các LoggingConfiguration . Nếu tầm quan trọng của sự kiện không đáp ứng được ngưỡng hiện tại, nó đang giảm và hàm trả về một 0 như kết quả ID sự kiện.

Phiên bản này của invocation cho phép người gọi để đặt bất kỳ sự kết hợp của EventOptions :

  • dấu thời gian, khi 0 được mặc định là thời gian hiện tại tại thời điểm cuộc gọi,
  • phần "gốc" của nguồn sự kiện (nguồn sự kiện và ID đặc điểm); nếu NULL, nó mặc định là thiết bị hiện tại. sự kiện được đánh dấu là liên quan đến thiết bị đang thực hiện cuộc gọi,
  • ID sự kiện liên quan để nhóm các ID sự kiện; khi ID sự kiện liên quan bằng 0, sự kiện được đánh dấu là không liên quan đến bất kỳ sự kiện nào khác,
  • khẩn cấp; theo mặc định là không khẩn cấp.

Chi tiết
Thông số
[in] inSchema
Schema định tầm quan trọng, ID hồ sơ, và các loại cấu trúc của sự kiện này.
[in] inEventWriter
Lệnh gọi lại để gọi để thực sự tuần tự hóa dữ liệu sự kiện
[in] inAppData
Bối cảnh ứng dụng cho cuộc gọi lại.
[in] inOptions
Các tùy chọn cho siêu dữ liệu sự kiện. Có thể là KHÔNG.
Lợi nhuận
event_id_t ID sự kiện nếu sự kiện được ghi vào nhật ký, 0 nếu không.

LogFreeform

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

LogFreeform phát ra một chuỗi dạng tự do cho luồng sự kiện mặc định.

Chuỗi sẽ được đóng gói trong một cấu trúc sự kiện gỡ lỗi, có cấu trúc giống hệt với các chuỗi đã ghi khác. Hồ sơ cá nhân sự kiện ID sẽ là một sự kiện Nest Debug, và loại sự kiện sẽ kNestDebug_StringLogEntryEvent .

Chi tiết
Thông số
[in] inImportance
Tầm quan trọng của mục nhập nhật ký; nếu mức độ quan trọng giảm xuống dưới mức độ quan trọng hiện tại, sự kiện không thực sự được ghi lại
[in] inFormat
printf chuỗi định dạng -compliant, tiếp theo là đối số phải được định dạng
Lợi nhuận
event_id_t ID sự kiện nếu sự kiện được ghi vào nhật ký, 0 nếu không.

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
)

Một chức năng trợ giúp để tạo ra một văn bản dạng tự do dưới dạng một sự kiện gỡ lỗi.

Sự kiện gỡ lỗi là một cấu trúc có logregion và văn bản dạng tự do.

Chi tiết
Thông số
[in,out] ioWriter
Người viết sử dụng để viết ra sự kiện
[in] appData
Một con trỏ tới các DebugLogContext , một cấu trúc chứa một định dạng chuỗi, lập luận, và một khu vực đăng nhập
[in] inDataTag
Thẻ bối cảnh cho TLV chúng tôi viết ra. Không được sử dụng ở đây, nhưng được yêu cầu bởi typedef cho EventWriterFunct.
Giá trị trả lại
WEAVE_NO_ERROR
Về thành công.
other
Các lỗi khác mà mey được trả về từ ioWriter.

PlainTextWriter

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

Một chức năng trợ giúp để tạo ra một văn bản dạng tự do dưới dạng một sự kiện gỡ lỗi.

Sự kiện gỡ lỗi là một cấu trúc có logregion và văn bản dạng tự do.

Chi tiết
Thông số
[in,out] ioWriter
Người viết sử dụng để viết ra sự kiện
[in] inDataTag
Thẻ phát ra
[in] appData
Một con trỏ tới các DebugLogContext , một cấu trúc chứa một định dạng chuỗi, lập luận, và một khu vực đăng nhập
Giá trị trả lại
WEAVE_NO_ERROR
Về thành công.
other
Các lỗi khác có thể được trả về từ ioWriter.

toán tử! =

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

toán tử ==

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