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
Typedefs | |
---|---|
CommandFlags | typedef |
DataVersion | typedefuint64_t |
EventProcessor | typedefvoid * |
EventWriterFunct )(nl::Weave::TLV::TLVWriter &ioWriter, uint8_t inDataTag, void *appData) | typedefWEAVE_ERROR (* Một hàm cung cấp phần tử eventData cho hệ thống con ghi nhật ký sự kiện. |
FetchExternalEventsFunct )(EventLoadOutContext *aContext) | typedefWEAVE_ERROR (* 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) | typedefvoid(* Trình lặp xử lý đặc điểm. |
LoggingBufferHandler )(void *inAppState, PacketBuffer *inBuffer) | typedefWEAVE_ERROR (* |
NotifyExternalEventsDeliveredFunct )(ExternalEvents *inEv, event_id_t inLastDeliveredEventID, uint64_t inRecipientNodeID) | typedefvoid(* 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) | typedefvoid(* 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 | typedefuint16_t |
PropertyPathHandle | typedefuint32_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 | typedefuint16_t |
SchemaVersion | typedefuint16_t |
SingleResourceSinkTraitCatalog | typedef |
SingleResourceSourceTraitCatalog | typedef |
TimestampType | typedef Tính hợp lệ và loại dấu thời gian có trong EventOptions . |
TraitDataHandle | typedefuint16_t |
duration_t | nl :: Weave :: Profiles :: DataManagement_Current :: time_tuint32_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_tuint32_t Loại ID sự kiện. |
timestamp_t | nl :: Weave :: Profiles :: DataManagement_Current :: timestamp_tuint32_t Loại 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_tuint64_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 tìm thấy một TraitUpdatableDataSink trong danh mục TraitDataSink . |
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ý 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 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 hàm trợ giúp để tạo văn bản dạng tự do dưới dạng sự kiện gỡ lỗi. |
PlainTextWriter (::nl::Weave::TLV::TLVWriter & ioWriter, uint8_t inDataTag, void *appData) | Một hàm trợ giúp để tạo văn bản dạng tự do dưới dạng sự kiện gỡ lỗi. |
operator!= (const ResourceIdentifier & lhs, const ResourceIdentifier & rhs) | bool |
operator== (const ResourceIdentifier & lhs, const ResourceIdentifier & rhs) | bool |
Đoàn thể | |
---|---|
nl :: Weave :: Profiles :: DataManagement_Current :: Timestamp | Liên minh cung cấp hệ thống tập hợp ứng dụng hoặc dấu thời gian UTC. |
Bảng kê
@ 100
@100
@ 101
@101
@ 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
Ghi nhật ký các thẻ Cài đặt.
@ 96
@96
Thẻ cho khả năng ghi nhật ký.
@ 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 chính nó. Nếu trống, nó mặc định là 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. Dấu thời gian hệ thống của sự kiện tính bằng 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 Dấu thời gian của sự kiện tính bằng 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.
CommandFlags
CommandFlags
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ó mức độ 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ỉ đang sử dụng một mức độ quan trọng, thì các sự kiện chỉ bị loại bỏ theo thứ tự tuổi, giống như một bộ đệm vòng.
LoggingManagementStates
LoggingManagementStates
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ử eventData 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ột đối tượngnl :: Weave :: TLV :: TLVWriter mà nó sẽ phát ra một phần tử TLV duy nhất được 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ác thẻ ngữ cảnh.
Chi tiết | |||||||
---|---|---|---|---|---|---|---|
Thông số |
| ||||||
Giá trị trả lại |
|
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, hàm tìm nạp này trả về tất cả các sự kiện từ EventLoadOutContext.mStartingEventID thông qua ExternalEvents.mLastEventID .
Con trỏ ngữ cảnh thuộc loại FetchExternalEventsContext. Điều này bao gồm EventLoadOutContext , với một số biến trợ giúp cho định dạng của TLV . Nó cũng bao gồm một con trỏ đến cấu trúc ExternalEvents được tạo khi đă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ừ hàm, EventLoadOutContext.mCurrentEventID sẽ phản ánh ID sự kiện đầu tiên chưa được ghi thành công vào bộ đệm TLV . Nền tảng phải ghi tiêu đề sự kiện và dữ liệu vào trình ghi TLV ở định dạng chính xác, được chỉ định bởi giao thức 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ả các lỗi TLV nên được tuyên truyền lên cấp 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, tiếp theo 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 |
|
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ỉ đang sử dụng một mức độ quan trọng, thì các sự kiện 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 thuê bao từ xa, công cụ sẽ cung cấp 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ố |
|
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. Cuộc gọi lại chứa sự kiện bên ngoài sẽ bị loại bỏ.
Chi tiết | |||
---|---|---|---|
Thông số |
|
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 đó, các 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 dấu thời gian có trong EventOptions .
TraitDataHandle
uint16_t TraitDataHandle
thời lượng_t
uint32_t duration_t
Loại 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 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ố |
| ||||||
Giá trị trả lại |
|
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à 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.
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 tìm một TraitUpdatableDataSink trong danh mục TraitDataSink .
Chi tiết | |||||
---|---|---|---|---|---|
Thông số |
| ||||
Lợi nhuận | Một con trỏ đến TraitUpdatableDataSink ; NULL nếu xử lý không tồn tại hoặc nó trỏ đến TraitDataSink không thể cập nhật. |
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.
Hàm ghi lại một sự kiện được biểu diễn dưới dạngnl :: Weave :: TLV :: TLVReader . Điều này ngụ ý rằng biểu diễn dữ liệu sự kiện đã được tuần tự hóa trong bộ lưu trữ bên dướinl :: Weave :: TLV :: TLVReader .Nl :: Weave :: TLV :: TLVReader dự kiến sẽ chứa ít nhất một phần tử dữ liệu duy nhất, phần 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 được ghi lại nếu inImportance của nó vượt quá ngưỡng ghi nhật ký được chỉ định trong LoggingConfiguration . Nếu mức độ quan trọng của sự kiện không đáp ứng ngưỡng hiện tại, nó sẽ bị loại bỏ và hàm trả về giá trị 0
làm ID sự kiện kết quả.
Biến thể của lời gọi này chỉ định ngầm 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ố |
| ||||
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.
Hàm ghi lại một sự kiện được biểu diễn dưới dạngnl :: Weave :: TLV :: TLVReader . Điều này ngụ ý rằng biểu diễn dữ liệu sự kiện đã được tuần tự hóa trong bộ lưu trữ bên dướinl :: Weave :: TLV :: TLVReader .Nl :: Weave :: TLV :: TLVReader dự kiến sẽ chứa ít nhất một phần tử dữ liệu duy nhất, phần 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 được ghi lại nếu inImportance của nó vượt quá ngưỡng ghi nhật ký được chỉ định trong LoggingConfiguration . Nếu mức độ quan trọng của sự kiện không đáp ứng ngưỡng hiện tại, nó sẽ bị loại bỏ và hàm trả về giá trị 0
làm ID sự kiện kết quả.
Biến thể của lời gọi này cho phép người gọi thiết lập bất kỳ sự kết hợp nào 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 có 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ố |
| ||||||
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.
Hàm ghi lại một sự kiện được biểu thị dưới dạng EventWriterFunct và ngữ cảnh appData
ứng dụng cụ thể. Hàm ghi siêu dữ liệu sự kiện và gọi inEventWriter
với tham chiếunl :: Weave :: TLV :: TLVWriter và ngữ cảnh inAppData
để mã người dùng có thể gửi dữ liệu sự kiện trực tiếp vào nhật ký 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. 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 được ghi lại nếu inImportance của nó vượt quá ngưỡng ghi nhật ký được chỉ định trong LoggingConfiguration . Nếu mức độ quan trọng của sự kiện không đáp ứng ngưỡng hiện tại, nó sẽ bị loại bỏ và hàm trả về giá trị 0
làm ID sự kiện kết quả.
Biến thể của lời gọi này chỉ định ngầm 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ố |
| ||||||
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 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
Hàm ghi lại một sự kiện được biểu thị dưới dạng EventWriterFunct và ngữ cảnh appData
ứng dụng cụ thể. Hàm ghi siêu dữ liệu sự kiện và gọi inEventWriter
với tham chiếunl :: Weave :: TLV :: TLVWriter và ngữ cảnh inAppData
để mã người dùng có thể gửi dữ liệu sự kiện trực tiếp vào nhật ký 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. 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 được ghi lại nếu inImportance của nó vượt quá ngưỡng ghi nhật ký được chỉ định trong LoggingConfiguration . Nếu mức độ quan trọng của sự kiện không đáp ứng ngưỡng hiện tại, nó sẽ bị loại bỏ và hàm trả về 0
làm ID sự kiện kết quả.
Biến thể của lời gọi này cho phép người gọi thiết lập bất kỳ sự kết hợp nào 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 có 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ố |
| ||||||||
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. ID hồ sơ sự kiện sẽ là ID của sự kiện Nest Debug và loại sự kiện sẽ là kNestDebug_StringLogEntryEvent
.
Chi tiết | |||||
---|---|---|---|---|---|
Thông số |
| ||||
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 hàm trợ giúp để tạo văn bản dạng tự do dưới dạng 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ố |
| ||||||
Giá trị trả lại |
|
PlainTextWriter
WEAVE_ERROR PlainTextWriter( ::nl::Weave::TLV::TLVWriter & ioWriter, uint8_t inDataTag, void *appData )
Một hàm trợ giúp để tạo văn bản dạng tự do dưới dạng 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ố |
| ||||||
Giá trị trả lại |
|
toán tử! =
bool operator!=( const ResourceIdentifier & lhs, const ResourceIdentifier & rhs )
toán tử ==
bool operator==( const ResourceIdentifier & lhs, const ResourceIdentifier & rhs )