nl:: Weave:: Profiles:: DataManagement_Current
Bu ad alanı, şu anda üretim kullanımı için desteklenen Weave Data Management (WDM) profiline yönelik Weave'deki tüm arayüzleri içerir.
Özet
Typedef'ler |
|
---|---|
CommandFlags
|
typedef |
DataVersion
|
typedefuint64_t
|
EventProcessor
|
typedefvoid *
|
EventWriterFunct)(nl::Weave::TLV::TLVWriter &ioWriter, uint8_t inDataTag, void *appData)
|
typedef Olay günlük kaydı alt sistemi için eventData öğesini sağlayan bir işlev. |
FetchExternalEventsFunct)(EventLoadOutContext *aContext)
|
typedef Etkinlik verilerini getiren platform geri çağırmaları için bir işlev prototipi. |
GenericTraitSinkCatalog
|
typedef |
GenericTraitSourceCatalog
|
typedef |
ImportanceType
|
typedef Günlük girişinin önemi. |
IteratorCallback)(void *aTraitInstance, TraitDataHandle aHandle, void *aContext)
|
typedefvoid(*
Özellik işleyici yineleyici. |
LoggingBufferHandler)(void *inAppState, PacketBuffer *inBuffer)
|
typedef |
NotifyExternalEventsDeliveredFunct)(ExternalEvents *inEv, event_id_t inLastDeliveredEventID, uint64_t inRecipientNodeID)
|
typedefvoid(*
Uzak aboneye harici etkinlikler iletildiğinde çağrılan bir geri çağırma için işlev prototipi. |
NotifyExternalEventsEvictedFunct)(ExternalEvents *inEv)
|
typedefvoid(*
Harici etkinlikler arabelleklerden çıkarıldığında çağrılan bir geri çağırma için işlev prototipi. |
PropertyDictionaryKey
|
typedefuint16_t
|
PropertyPathHandle
|
typedefuint32_t
PropertyPathHandle, bir özellik örneğinin köküne göre bir WDM yolunun 32 bit'lik benzersiz bir sayısal karmasıdır. |
PropertySchemaHandle
|
typedefuint16_t
|
SchemaVersion
|
typedefuint16_t
|
SingleResourceSinkTraitCatalog
|
typedef |
SingleResourceSourceTraitCatalog
|
typedef |
TimestampType
|
typedef EventOptions öğesine eklenen zaman damgasının geçerliliği ve türü. |
TraitDataHandle
|
typedefuint16_t
|
duration_t
|
nl::Weave::Profiles::DataManagement_Current::duration_tuint32_t
Milisaniye cinsinden süreyi açıklamak için kullanılan tür. |
event_id_t
|
nl::Weave::Profiles::DataManagement_Current::event_id_tuint32_t
Etkinlik kimliğinin türü. |
timestamp_t
|
nl::Weave::Profiles::DataManagement_Current::timestamp_tuint32_t
Zaman damgasını milisaniye cinsinden açıklamak için kullanılan tür. |
utc_timestamp_t
|
nl::Weave::Profiles::DataManagement_Current::utc_timestamp_tuint64_t
UTC zaman damgasını milisaniye cinsinden açıklamak için kullanılan tür. |
Değişkenler |
|
---|---|
sInstance
|
|
sLogFileName = "topazlog"[]
|
char
|
İşlevler |
|
---|---|
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)
|
Halihazırda serileştirilmiş bir eventdata öğesini etkinlik arabelleğine çeviren yardımcı işlev.
|
GetPropertyDictionaryKey(PropertyPathHandle aHandle)
|
PropertyDictionaryKey
|
GetPropertySchemaHandle(PropertyPathHandle aHandle)
|
PropertySchemaHandle
|
IsNullPropertyPathHandle(PropertyPathHandle aHandle)
|
bool
|
IsRootPropertyPathHandle(PropertyPathHandle aHandle)
|
bool
|
IsVersionNewer(const DataVersion & aVersion, const DataVersion & aReference)
|
bool
Bu, sürümleri karşılaştırmak için algoritmanın optimize edilmiş bir uygulamasıdır.
|
IsVersionNewerOrEqual(const DataVersion & aVersion, const DataVersion & aReference)
|
bool
|
Locate(TraitDataHandle aTraitDataHandle, const TraitCatalogBase< TraitDataSink > *aDataSinkCatalog)
|
TraitDataSink kataloğunda TraitUpdatableDataSink bulan yardımcı program işlevi.
|
LogEvent(const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData)
|
Önceden seri numaralı formdan bir etkinliği günlüğe kaydedin.
|
LogEvent(const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData, const EventOptions *inOptions)
|
Ek seçeneklerle birlikte, önceden seri haline getirilmiş bir formdan etkinlik kaydedin.
|
LogEvent(const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData)
|
Geri çağırma yoluyla bir etkinlik kaydedin.
|
LogEvent(const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData, const EventOptions *inOptions)
|
Seçenekleri de içeren bir geri arama aracılığıyla etkinlik kaydedin.
|
LogFreeform(ImportanceType inImportance, const char *inFormat, ...)
|
LogFreeform, varsayılan etkinlik akışına serbest biçimli bir dize yayar.
|
LookForElementWithTag(const nl::Weave::TLV::TLVReader & aSrcReader, const uint64_t aTagInApiForm, nl::Weave::TLV::TLVReader *apDstReader)
|
|
PlainTextWriter(TLVWriter & ioWriter, uint8_t inDataTag, void *appData)
|
Hata ayıklama etkinliği olarak serbest biçimli metin yayınlamak için yardımcı işlev.
|
PlainTextWriter(::nl::Weave::TLV::TLVWriter & ioWriter, uint8_t inDataTag, void *appData)
|
Hata ayıklama etkinliği olarak serbest biçimli metin yayınlamak için yardımcı işlev.
|
operator!=(const ResourceIdentifier & lhs, const ResourceIdentifier & rhs)
|
bool
|
operator==(const ResourceIdentifier & lhs, const ResourceIdentifier & rhs)
|
bool
|
Birlikler |
|
---|---|
nl:: |
Uygulama grubu sistemi veya UTC zaman damgası sağlayan birleştirme. |
Numaralandırmalar
@100
@100
kNestDebug_StringLogEntryEvent için etiketler.
Özellikler | |
---|---|
kTag_Message
|
Asıl hata ayıklama mesajını içeren bir dize. |
kTag_Region
|
Günlük bölgesini (ör. günlük mesajının ait olduğu modül) gösteren 32 bitlik imzalanmamış bir kod. |
@101
@101
kNestDebug_TokenizedLogEntryEvent.
Özellikler | |
---|---|
kTag_Args
|
Jeton mesajıyla birlikte gönderilecek bir bağımsız değişken dizisi. |
kTag_Token
|
Jetona karşılık gelen 32 bitlik imzalanmamış bir değer. |
@102
@102
Kalıcı etkinlikler için etiketler.
@104
@104
WDM profil mesajı türleri.
Bu değerler, veri yönetimi spesifikasyonunda belirtilmektedir.
@105
@105
WDM'ye özel durum kodları.
@147
@147
@95
@95
Günlük Kaydı Ayarları etiketleri.
Özellikler | |
---|---|
kTag_CurrentImportance
|
Şu anki günlük kaydının önem derecesi. Değer, ImportanceType türündedir. |
kTag_ImportanceExpiration
|
Mevcut yükseltilmiş günlük kaydı ayarlarının varsayılan değerlere geri döndüğü saat (UTC) (UTC). |
kTag_LoggingDestination
|
Günlük yüklemenin hedefini belirten URL. |
kTag_MaximumLogUploadInterval
|
Otomatik olarak tetiklenen günlük yükleme denemeleri arasındaki saniye cinsinden maksimum süre. |
kTag_MinimumLogUploadInterval
|
Otomatik olarak tetiklenen günlük yükleme denemeleri arasındaki saniye cinsinden minimum süre. |
kTag_TraitLoggingImportance
|
Seçilen profilleri daha yüksek günlük kaydı düzeylerine seçmeli olarak eşleyen isteğe bağlı bir dizi. Dizideki her öğe, günlük kaydını sistemin bir alt kümesinden seçmeli olarak yükseltmek için bir form (profile,path,loggingimportance) alır. Yükseltilmiş profil günlük kaydı önceliği yalnızca günlük kaydı önceliği, mevcut Önem derecesini aştığında önem taşır ve currentÖnemle aynı geçerlilik bitiş tarihine tabiyse bu öncelik düzeyi daha yüksek olur. |
@96
@96
Günlük kaydı özellikleri için etiketler.
Özellikler | |
---|---|
kTag_LogBufferingCapacity
|
Günlük arabelleğe alma kapasitesini kB cinsinden açıklayan 32 bitlik imzasız bir tam sayı. |
kTag_LoggingVolume
|
Beklenen günlük kaydı hacmini kB/gün cinsinden açıklayan 32 bitlik imzasız bir tam sayı. |
kTag_SupportedLogTransports
|
Desteklenen günlük aktarma mekanizmaları dizisi. |
kTag_SupportsNonVolatileStorage
|
Cihazın kalıcı günlük depolamasını destekleyip desteklemediğini gösteren boole değeri. |
kTag_SupportsPerTraitVerbosity
|
Cihazın özellik başına ayrıntı ayarlarını destekleyip desteklemediğini gösteren boole değeri. |
kTag_SupportsStreaming
|
Cihazın akış günlüklerini destekleyip desteklemediğini gösteren boole değeri. |
@97
@97
Etkinlik meta verileri için etiketler.
Etiket değerlerinin tam anlamları için Etkinlik Tasarımı Spesifikasyonu'na bakın.
Özellikler | |
---|---|
kTag_EventData
|
İsteğe bağlı. Etkinlik verilerinin kendisi. Boşsa varsayılan olarak boş bir yapı kullanılır. |
kTag_EventDeltaSystemTime
|
WDM dahili etiketi, kodlamada önceki etkinlikten saat farkı. |
kTag_EventDeltaUTCTime
|
WDM dahili etiketi, kodlamada önceki etkinlikten saat farkı. |
kTag_EventID
|
64 bitlik imzasız miktar olarak ifade edilen etkinlik sıra numarası. Sıralı olmalıdır ve dizideki atlamalar etkinlik boşluklarını gösterir. |
kTag_EventImportance
|
Etkinliğin önemi. |
kTag_EventResourceID
|
İsteğe bağlı. Değer, etkinliğin ait olduğu kaynağın kimliğidir. Atlandığında, değer kTag_EventSource değeriyle aynı olur. |
kTag_EventSource
|
Etkinliği oluşturan cihazın NodeID. |
kTag_EventSystemTimestamp
|
İsteğe bağlı. Etkinliğin milisaniye cinsinden sistem Zaman damgası. |
kTag_EventTraitInstanceID
|
İsteğe bağlı, etkinliği oluşturan özelliğin örneği. |
kTag_EventTraitProfileID
|
Zorunludur. Özelliğin ProfileID'ye eşit olan 32 bitlik imzalanmamış tam sayı. |
kTag_EventType
|
Zorunludur. Bu etkinlik türü için wdl.event.id değerine eşit olan 16 bitlik imzalanmamış tam sayı. |
kTag_EventUTCTimestamp
|
İsteğe bağlı. Etkinliğin UTC zaman damgası (milisaniye cinsinden). |
kTag_ExternalEventStructure
|
Harici etkinlikler için dahili etiket. Asla kablolu bağlantı üzerinden iletilmez, hiçbir zaman Weave kitaplığının dışında kullanılmamalıdır. |
kTag_RelatedEventID
|
İsteğe bağlı. Bu etkinliğin alakalı olduğu bir Etkinliğin kimliği. Atlanırsa, değer kTag_EventID değerine eşit olur. |
kTag_RelatedEventImportance
|
İsteğe bağlı. İlgili etkinliğin önemi. Atlanırsa değer, kTag_EventImportance değerine eşit olur. |
@98
@98
Hata ayıklama özelliğinin profil tanımları.
@99
@99
Nest Hata Ayıklama özelliği için etkinlik türleri.
Özellikler | |
---|---|
kNestDebug_StringLogEntryEvent
|
Serbest biçimli dize hata ayıklama mesajı etkinliği. |
kNestDebug_TokenizedHeaderEntryEvent
|
Token atanmış başlık bilgilerini aktarmak için bir etkinlik. |
kNestDebug_TokenizedLogEntryEvent
|
Token atanmış hata ayıklama mesajı için bir etkinlik. |
CommandFlags
CommandFlags
Özellikler | |
---|---|
kCommandFlag_ActionTimeValid
|
İşlem zamanının geçerli olduğu zamanı ayarlayın. |
kCommandFlag_ExpiryTimeValid
|
Geçerlilik bitiş zamanının geçerli olduğu zamanı ayarlayın. |
kCommandFlag_InitiationTimeValid
|
Başlatma zamanının geçerli olduğu zamanı ayarlayın. |
kCommandFlag_IsOneWay
|
Komut tek yönlü olduğunda ayarlayın. |
kCommandFlag_MustBeVersionValid
|
Sürüm alanının geçerli olduğu zamanı ayarlayın. |
ImportanceType
ImportanceType
Günlük girişinin önemi.
Önem, etkinlikleri günlüğe gerçekten eklenmeden önce filtrelemenin bir yolu olarak kullanılır. Etkinlik günlüğe eklendikten sonra, etkinliği günlükten kalıcı olarak silmek için herhangi bir hazırlık yapılmaz. Önem düzeyi, etkinlik depolama alanına öncelik verilmesini sağlar. Yüksek önem düzeyine sahip bir olay tam arabelleğe eklenirse etkinlikler, önem sırasına (ve yaşa) göre çıkarılır. Bu nedenle, önem düzeyleri yalnızca göreli bir değere sahiptir. Bir sistem yalnızca tek bir önem düzeyi kullanıyorsa etkinlikler, halka tampon gibi yalnızca yaş sırasına göre çıkarılır.
Özellikler | |
---|---|
Debug
|
Hata ayıklama önemi, sistemin geliştiricilerinin ilgilendiği günlük girişlerini ifade eder ve esas olarak geliştirme aşamasında kullanılır. Hata ayıklama önem günlükleri, kısıtlamaya tabi cihazların bant genişliği veya güç bütçelerinde dikkate alınmaz; Bu nedenle, üretim sistemlerinde yalnızca sınırlı bir süre boyunca kullanılmalıdır. |
Info
|
Bilginin önem derecesi, çalışan sistemle ilgili ek bilgiler ve teşhisler sağlayan günlük girişlerini ifade eder. Bilgi günlük kaydı düzeyi, bir üretim sisteminde uzun süre veya saha denemesinde varsayılan günlük düzeyi olarak kullanılabilir. Kısıtlanmış cihazlarda Bilgi düzeyi ile kaydedilen girişler, bant genişliği ve bellek bütçesinde hesaba katılmalı, güç bütçesinde hesaba katılmamalıdır. |
Production
|
Üretimin önemi, Nest ekosisteminin sürekli izlenmesi ve bakımında kullanılan günlük girişlerini ifade eder. Kısıtlı cihazlarda, Üretim önem derecesi ile kaydedilen girişler güç ve bellek bütçesine dahil edilmelidir. Bu tür girişlerin her zaman günlüğe kaydedilmesi ve cihazdan kaldırılması beklenir. |
ProductionCritical
|
Üretim kritik önem, kaybı müşteriye yönelik özellikleri doğrudan etkileyecek etkinlikleri ifade eder. Uygulamalar, sistem hatasını belirtmek için Kritik Üretim olaylarının kaybını kullanabilir. Kısıtlı cihazlarda, Üretim Kritik önem derecesi ile günlüğe kaydedilen girişler, her zaman günlüğe kaydedilmesi ve cihazdan boşaltılması beklendiğinden güç ve bellek bütçesinde hesaba katılmalıdır. |
LoggingManagementStates
LoggingManagementStates
Özellikler | |
---|---|
kLoggingManagementState_Holdoff
|
Günlük boşaltma tamamlandı; bekletme süresi sona erene kadar günlüğü yeniden başlatmayız. |
kLoggingManagementState_Idle
|
Günlük boşaltma işlemi devam etmiyor, günlük aktarımı herhangi bir kısıtlama olmadan başlayabilir. |
kLoggingManagementState_InProgress
|
Günlük boşaltma işlemi devam ediyor. |
kLoggingManagementState_Shutdown
|
Herhangi bir günlük kaydı işlemi gerçekleştiremez. |
Typedef'ler
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)
Olay günlük kaydı alt sistemi için eventData öğesini sağlayan bir işlev.
Bu tür işlevlerin, etkinlik günlük kaydı alt sistemi için eventData öğesini sağlaması beklenir. Bu türdeki işlevler, etkinlik alt sistemi gerekli tüm etkinlik meta verilerini oluşturduktan sonra çağrılır. İşlev, kTag_EventData etiketli tek bir TLV öğesi yayımlayacağı bir nl::Weave::TLV::TLVWriter nesnesiyle çağrılır; söz konusu öğenin değerinin, etkinlik verilerini içeren bir yapı olması ZORUNLUDUR. Etkinlik verilerinin kendisi bağlam etiketleri kullanılarak yapılandırılmalıdır.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Değerleri Döndür |
|
PlainTextWriter
EventWriterTLVCopy
FetchExternalEventsFunct
WEAVE_ERROR(* FetchExternalEventsFunct)(EventLoadOutContext *aContext)
Etkinlik verilerini getiren platform geri çağırmaları için bir işlev prototipi.
FetchEventsBefore'e benzer şekilde, bu getirme işlevi EventLoadOutContext.mLaunchEventID ile ExternalEvents.mLastEventID arasındaki tüm etkinlikleri döndürür.
Bağlam işaretçisi FetchExternalEventsContext türündedir. Buna, TLV biçimi için bazı yardımcı değişkenlerle birlikte EventLoadOutContext dahildir. Ayrıca, geri çağırmanın kaydedildiğinde oluşturulan ExternalEvents yapısına bir işaretçi de içerir. Bu, geri çağırma için etkinlik kimliği aralığını belirtir.
İşlevden geri dönüldüğünde, EventLoadOutContext.mCurrentEventID, TLV arabelleğine başarıyla yazılmamış ilk etkinlik kimliğini yansıtmalıdır. Platform, etkinlik başlığını ve verilerini TLV yazıcısına EventLogging protokolü tarafından belirtilen doğru biçimde yazmalıdır. Platformda etkinliklerin ve zaman damgalarının da benzersiz olması gerekir.
Tüm TLV hataları daha yüksek düzeylere yayılmalıdır. Örneğin, arabellekteki alanın dolması, gönderilen bir mesajı ve ardından, kalan etkinlik kimliği ile başka bir geri çağırma çağrısını tetikler.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Değerleri Döndür |
|
GenericTraitSinkCatalog
GenericTraitCatalogImpl< TraitDataSink > GenericTraitSinkCatalog
GenericTraitSourceCatalog
GenericTraitCatalogImpl< TraitDataSource > GenericTraitSourceCatalog
ImportanceType
enum nl::Weave::Profiles::DataManagement_Current::ImportanceType ImportanceType
Günlük girişinin önemi.
Önem, etkinlikleri günlüğe gerçekten eklenmeden önce filtrelemenin bir yolu olarak kullanılır. Etkinlik günlüğe eklendikten sonra, etkinliği günlükten kalıcı olarak silmek için herhangi bir hazırlık yapılmaz. Önem düzeyi, etkinlik depolama alanına öncelik verilmesini sağlar. Yüksek önem düzeyine sahip bir olay tam arabelleğe eklenirse etkinlikler, önem sırasına (ve yaşa) göre çıkarılır. Bu nedenle, önem düzeyleri yalnızca göreli bir değere sahiptir. Bir sistem yalnızca tek bir önem düzeyi kullanıyorsa etkinlikler, halka tampon gibi yalnızca yaş sırasına göre çıkarılır.
IteratorCallback
void(* IteratorCallback)(void *aTraitInstance, TraitDataHandle aHandle, void *aContext)
Özellik işleyici yineleyici.
LoggingBufferHandler
WEAVE_ERROR(* LoggingBufferHandler)(void *inAppState, PacketBuffer *inBuffer)
NotifyExternalEventsDeliveredFunct
void(* NotifyExternalEventsDeliveredFunct)(ExternalEvents *inEv, event_id_t inLastDeliveredEventID, uint64_t inRecipientNodeID)
Uzak aboneye harici etkinlikler iletildiğinde çağrılan bir geri çağırma için işlev prototipi.
Harici etkinlikler bir uzak aboneye iletildiğinde motor, harici etkinlik sağlayıcısına bir bildirim sağlar. Geri çağırma, yayınlanan son kimliğin etkinliğini ve etkinliği alan abonenin kimliğini içerir.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
NotifyExternalEventsEvictedFunct
void(* NotifyExternalEventsEvictedFunct)(ExternalEvents *inEv)
Harici etkinlikler arabelleklerden çıkarıldığında çağrılan bir geri çağırma için işlev prototipi.
Harici etkinlik nesnesi, giden ileti arabelleğinden çıkarıldığında motor, harici etkinlik sağlayıcısına bir bildirim sağlar. Geri çağırma, çıkarılacak harici etkinliği içerir.
Ayrıntılar | |||
---|---|---|---|
Parametreler |
|
PropertyDictionaryKey
uint16_t PropertyDictionaryKey
PropertyPathHandle
uint32_t PropertyPathHandle
PropertyPathHandle, bir özellik örneğinin köküne göre bir WDM yolunun 32 bit'lik benzersiz bir sayısal karmasıdır.
İki bölümden oluşur:
- Şemanın statik bölümüyle eşleşen 16 bitten küçük bir sayı.
- Alttaki 16 bitler sözlük öğesi içindeki bir yolu ifade ettiğinde, söz konusu öğeyle ilişkili sözlük anahtarını temsil eden 16 bitlik üst bir sayı bulunur. Alttaki 16 bitler sözlük dışı bir öğeye işaret ediyorsa üst 16 bit 0 olmalıdır.
Bazı özellikleri:
- Her özelliğin kendi özellik yolu tutma alanı vardır.
- Her benzersiz WDM alt yolu yolunun benzer şekilde benzersiz bir PropertyPathHandle'ı olacaktır.
- PropertyPathHandle'lar, IDL'den bir özellik derleyici tarafından otomatik olarak oluşturulur (şimdilik elle yapılır) ve ilgili özelliğin başlık dosyasında numaralandırıcı listesi olarak temsil edilir.
- Bu yapıyla, uygulama mantığının WDM yollarıyla doğrudan ilgilenmesi gerekmez. Daha ziyade, WDM ile olan etkileşimleri yalnızca bu herkese açık kullanıcı adları üzerinden yürütülür.
- Yol tutma yerleri için belirli anlamları olan iki ayrılmış değer vardır:
- 0, "NULL" değerini gösterir herkese açık kullanıcı adı
- 1, özellik örneğinin köküne işaret eden bir tutma yerini belirtir.
PropertySchemaHandle
uint16_t PropertySchemaHandle
SchemaVersion
uint16_t SchemaVersion
SingleResourceSinkTraitCatalog
SingleResourceTraitCatalog< TraitDataSink > SingleResourceSinkTraitCatalog
SingleResourceSourceTraitCatalog
SingleResourceTraitCatalog< TraitDataSource > SingleResourceSourceTraitCatalog
TimestampType
enum nl::Weave::Profiles::DataManagement_Current::TimestampType TimestampType
EventOptions öğesine eklenen zaman damgasının geçerliliği ve türü.
TraitDataHandle
uint16_t TraitDataHandle
duration_t
uint32_t duration_t
Milisaniye cinsinden süreyi açıklamak için kullanılan tür.
event_id_t
uint32_t event_id_t
Etkinlik kimliğinin türü.
timestamp_t
uint32_t timestamp_t
Zaman damgasını milisaniye cinsinden açıklamak için kullanılan tür.
utc_timestamp_t
uint64_t utc_timestamp_t
UTC zaman damgasını milisaniye cinsinden açıklamak için kullanılan tür.
Değişkenler
sInstance
LoggingManagement sInstance
sLogFileName
char sLogFileName[] = "topazlog"
İşlevler
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 )
Halihazırda serileştirilmiş bir eventdata öğesini etkinlik arabelleğine çeviren yardımcı işlev.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Değerleri Döndür |
|
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 )
Bu, sürümleri karşılaştırmak için algoritmanın optimize edilmiş bir uygulamasıdır.
İstemci tarafında, hizmetten alınan sürüm her zaman en yeni sürümdür.
IsVersionNewerOrEqual
bool IsVersionNewerOrEqual( const DataVersion & aVersion, const DataVersion & aReference )
Yerini bul
TraitUpdatableDataSink * Locate( TraitDataHandle aTraitDataHandle, const TraitCatalogBase< TraitDataSink > *aDataSinkCatalog )
TraitDataSink kataloğunda TraitUpdatableDataSink bulan yardımcı program işlevi.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
İadeler |
Bir TraitUpdatableDataSink işaretçisi; Herkese açık kullanıcı adı yoksa veya güncellenemeyen bir TraitDataSink'e işaret ediyorsa NULL değerini alır.
|
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData )
Önceden seri numaralı formdan bir etkinliği günlüğe kaydedin.
İşlev, nl::Weave::TLV::TLVReader olarak temsil edilen bir etkinliği günlüğe kaydeder. Bu, etkinlik verileri temsilinin nl::Weave::TLV::TLVReader'ın altındaki depolama alanında zaten serileştirildiği anlamına gelir. nl::Weave::TLV::TLVReader öğesinin en az tek bir veri öğesi içermesi beklenir. Bu öğe bir yapı olmalıdır. Okuyucudan çıkan ilk öğe, etkinlik verisi olarak değerlendirilir ve etkinlik günlüğünde depolanır. Etkinlik verilerinin inProfileID ve inEventType tarafından tanımlanan şema içinde yorumlanacak içerik etiketleri içermesi ZORUNLUDUR. İlk öğenin etiketi yok sayılır; etkinlik günlük kaydı sistemi bunu eventData etiketiyle değiştirir.
Etkinlik, inImportance özelliği LoggingConfiguration'da belirtilen günlük kaydı eşiğini aşarsa günlüğe kaydedilir. Etkinliğin önemi, geçerli eşiği karşılamıyorsa etkinlik çıkarılır ve işlev, sonuç olarak elde edilen etkinlik kimliği olarak bir 0
döndürür.
Çağrının bu varyantı, tüm varsayılan etkinlik seçeneklerini dolaylı olarak belirtir:
- çağrının yapıldığı andaki saate ekleyerek etkinliğe
- Etkinlik, aramayı yapan cihazla alakalı olarak işaretlenirse
- başka hiçbir etkinlikle ilgisi olmayan bağımsız bir etkinliktir.
- etkinlik acil değil olarak işaretlendiyse
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
İadeler |
event_id_t Etkinlik günlüğe yazıldıysa etkinlik kimliği; aksi halde 0 değerini alır.
|
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData, const EventOptions *inOptions )
Ek seçeneklerle birlikte, önceden seri haline getirilmiş bir formdan etkinlik kaydedin.
İşlev, nl::Weave::TLV::TLVReader olarak temsil edilen bir etkinliği günlüğe kaydeder. Bu, etkinlik verileri temsilinin nl::Weave::TLV::TLVReader'ın altındaki depolama alanında zaten serileştirildiği anlamına gelir. nl::Weave::TLV::TLVReader öğesinin en az tek bir veri öğesi içermesi beklenir. Bu öğe bir yapı olmalıdır. Okuyucudan çıkan ilk öğe, etkinlik verisi olarak değerlendirilir ve etkinlik günlüğünde depolanır. Etkinlik verilerinin inProfileID ve inEventType tarafından tanımlanan şema içinde yorumlanacak içerik etiketleri içermesi ZORUNLUDUR. İlk öğenin etiketi yok sayılır; etkinlik günlük kaydı sistemi bunu eventData etiketiyle değiştirir.
Etkinlik, inImportance özelliği LoggingConfiguration'da belirtilen günlük kaydı eşiğini aşarsa günlüğe kaydedilir. Etkinliğin önemi, geçerli eşiği karşılamıyorsa etkinlik çıkarılır ve işlev, sonuç olarak elde edilen etkinlik kimliği olarak bir 0
döndürür.
Çağrının bu varyantı, arayanın herhangi bir EventOptions
kombinasyonunu ayarlamasına izin verir:
- 0 varsayılan olarak çağrı noktasında geçerli saate ayarlandığında zaman damgası
- "kök" etkinlik kaynağının bölümü (etkinlik kaynağı ve özellik kimliği); NULL ise varsayılan olarak mevcut cihaz olur. Etkinlik, aramayı yapan cihazla alakalı olarak işaretlenirse
- Etkinlik kimliklerini gruplandırmak için ilgili bir etkinlik kimliği; İlgili etkinlik kimliği 0 olduğunda, etkinlik başka bir etkinlikle alakalı değil olarak işaretlenir.
- aciliyet; varsayılan olarak acil değildir.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
İadeler |
event_id_t Etkinlik günlüğe yazıldıysa etkinlik kimliği; aksi halde 0 değerini alır.
|
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData )
Geri çağırma yoluyla bir etkinlik kaydedin.
İşlev, EventWriterFunct ve uygulamaya özel appData
bağlamı olarak temsil edilen bir etkinliği günlüğe kaydeder. Kullanıcı kodunun etkinlik verilerini doğrudan etkinlik günlüğüne yayınlayabilmesi için işlev, etkinlik meta verilerini yazar ve inEventWriter
öğesini bir nl::Weave::TLV::TLVWriter referansı ve inAppData
bağlamıyla çağırır. Bu etkinlik günlük kaydı biçimi, etkinlik verileri doğrudan hedef arabelleğe alındığından bellek tüketimini en aza indirir. Etkinlik verilerinin, inProfileID
ve inEventType
tarafından tanımlanan şema içinde yorumlanacak içerik etiketleri İÇERMELİDİR. İlk öğenin etiketi yok sayılır; etkinlik günlük kaydı sistemi bunu eventData etiketiyle değiştirir.
Etkinlik, inImportance özelliği LoggingConfiguration'da belirtilen günlük kaydı eşiğini aşarsa günlüğe kaydedilir. Etkinliğin önemi, geçerli eşiği karşılamıyorsa etkinlik çıkarılır ve işlev, sonuç olarak elde edilen etkinlik kimliği olarak bir 0
döndürür.
Çağrının bu varyantı, tüm varsayılan etkinlik seçeneklerini dolaylı olarak belirtir:
- çağrının yapıldığı andaki saate ekleyerek etkinliğe
- Etkinlik, aramayı yapan cihazla alakalı olarak işaretlenirse
- başka hiçbir etkinlikle ilgisi olmayan bağımsız bir etkinliktir.
- etkinlik acil değil olarak işaretlendiyse
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
İadeler |
event_id_t Etkinlik günlüğe yazıldıysa etkinlik kimliği; aksi halde 0 değerini alır.
|
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData, const EventOptions *inOptions )
Seçenekleri de içeren bir geri arama aracılığıyla etkinlik kaydedin.
İşlev, EventWriterFunct ve uygulamaya özel appData
bağlamı olarak temsil edilen bir etkinliği günlüğe kaydeder. Kullanıcı kodunun etkinlik verilerini doğrudan etkinlik günlüğüne yayınlayabilmesi için işlev, etkinlik meta verilerini yazar ve inEventWriter
öğesini bir nl::Weave::TLV::TLVWriter referansı ve inAppData
bağlamıyla çağırır. Bu etkinlik günlük kaydı biçimi, etkinlik verileri doğrudan hedef arabelleğe alındığından bellek tüketimini en aza indirir. Etkinlik verilerinin, inProfileID
ve inEventType
tarafından tanımlanan şema içinde yorumlanacak içerik etiketleri İÇERMELİDİR. İlk öğenin etiketi yok sayılır; etkinlik günlük kaydı sistemi bunu eventData etiketiyle değiştirir.
Etkinlik, inImportance özelliği LoggingConfiguration'da belirtilen günlük kaydı eşiğini aşarsa günlüğe kaydedilir. Etkinliğin önemi, geçerli eşiği karşılamıyorsa etkinlik çıkarılır ve işlev, sonuç olarak elde edilen etkinlik kimliği olarak bir 0
döndürür.
Çağrının bu varyantı, arayanın herhangi bir EventOptions
kombinasyonunu ayarlamasına izin verir:
- 0 varsayılan olarak çağrı noktasında geçerli saate ayarlandığında zaman damgası
- "kök" etkinlik kaynağının bölümü (etkinlik kaynağı ve özellik kimliği); NULL ise varsayılan olarak mevcut cihaz olur. Etkinlik, aramayı yapan cihazla alakalı olarak işaretlenirse
- Etkinlik kimliklerini gruplandırmak için ilgili bir etkinlik kimliği; İlgili etkinlik kimliği 0 olduğunda, etkinlik başka bir etkinlikle alakalı değil olarak işaretlenir.
- aciliyet; varsayılan olarak acil değildir.
Ayrıntılar | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parametreler |
|
||||||||
İadeler |
event_id_t Etkinlik günlüğe yazıldıysa etkinlik kimliği; aksi halde 0 değerini alır.
|
LogFreeform
event_id_t LogFreeform( ImportanceType inImportance, const char *inFormat, ... )
LogFreeform, varsayılan etkinlik akışına serbest biçimli bir dize yayar.
Dize, günlüğe kaydedilen diğer dizelerle yapısal olarak aynı olacak şekilde bir hata ayıklama etkinlik yapısına dahil edilir. Etkinlik profili kimliği bir Nest Debug etkinliğine ait, etkinlik türü ise kNestDebug_StringLogEntryEvent
olur.
Ayrıntılar | |||||
---|---|---|---|---|---|
Parametreler |
|
||||
İadeler |
event_id_t Etkinlik günlüğe yazıldıysa etkinlik kimliği; aksi halde 0 değerini alır.
|
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 )
Hata ayıklama etkinliği olarak serbest biçimli metin yayınlamak için yardımcı işlev.
Hata ayıklama etkinliği, logregion ve serbest biçimli metin içeren bir yapıdır.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Değerleri Döndür |
|
PlainTextWriter
WEAVE_ERROR PlainTextWriter( ::nl::Weave::TLV::TLVWriter & ioWriter, uint8_t inDataTag, void *appData )
Hata ayıklama etkinliği olarak serbest biçimli metin yayınlamak için yardımcı işlev.
Hata ayıklama etkinliği, logregion ve serbest biçimli metin içeren bir yapıdır.
Ayrıntılar | |||||||
---|---|---|---|---|---|---|---|
Parametreler |
|
||||||
Değerleri Döndür |
|