nl::
Ta przestrzeń nazw zawiera wszystkie interfejsy Weave w profilu Weave Data Management (WDM), które są obecnie obsługiwane w środowisku produkcyjnym.
Podsumowanie
Definiuje typ |
|
|---|---|
CommandFlags
|
typedef |
DataVersion
|
typedefuint64_t
|
EventProcessor
|
typedefvoid *
|
EventWriterFunct)(nl::Weave::TLV::TLVWriter &ioWriter, uint8_t inDataTag, void *appData)
|
typedef Funkcja dostarczająca element eventData dla podsystemu logowania zdarzeń. |
FetchExternalEventsFunct)(EventLoadOutContext *aContext)
|
typedef Prototyp funkcji służącej do pobierania danych zdarzenia przez wywołania zwrotne platformy. |
GenericTraitSinkCatalog
|
typedef |
GenericTraitSourceCatalog
|
typedef |
ImportanceType
|
typedef Znaczenie wpisu logu. |
IteratorCallback)(void *aTraitInstance, TraitDataHandle aHandle, void *aContext)
|
typedefvoid(*
Iterator uchwytu cechy. |
LoggingBufferHandler)(void *inAppState, PacketBuffer *inBuffer)
|
typedef |
NotifyExternalEventsDeliveredFunct)(ExternalEvents *inEv, event_id_t inLastDeliveredEventID, uint64_t inRecipientNodeID)
|
typedefvoid(*
Prototyp funkcji dla wywołania zwrotnego wywoływanego po dostarczeniu zdarzeń zewnętrznych do zdalnego subskrybenta. |
NotifyExternalEventsEvictedFunct)(ExternalEvents *inEv)
|
typedefvoid(*
Prototyp funkcji dla wywołania zwrotnego wywoływanego po usunięciu z buforów zdarzeń zewnętrznych. |
PropertyDictionaryKey
|
typedefuint16_t
|
PropertyPathHandle
|
typedefuint32_t
Właściwość PropertyPathHandle to unikalny 32-bitowy hasz numeryczny ścieżki WDM odnoszący się do poziomu głównego instancji trait. |
PropertySchemaHandle
|
typedefuint16_t
|
SchemaVersion
|
typedefuint16_t
|
SingleResourceSinkTraitCatalog
|
typedef |
SingleResourceSourceTraitCatalog
|
typedef |
TimestampType
|
typedef Prawidłowość i typ sygnatury czasowej zawarte w parametrze EventOptions. |
TraitDataHandle
|
typedefuint16_t
|
duration_t
|
nl::Weave::Profiles::DataManagement_Current::duration_tuint32_t
Typ używany do opisania czasu trwania (w milisekundach). |
event_id_t
|
nl::Weave::Profiles::DataManagement_Current::event_id_tuint32_t
Typ identyfikatora zdarzenia. |
timestamp_t
|
nl::Weave::Profiles::DataManagement_Current::timestamp_tuint32_t
Typ używany do opisania sygnatury czasowej w milisekundach. |
utc_timestamp_t
|
nl::Weave::Profiles::DataManagement_Current::utc_timestamp_tuint64_t
Typ używany do opisania sygnatury czasowej UTC w milisekundach. |
Zmienne |
|
|---|---|
sInstance
|
|
sLogFileName = "topazlog"[]
|
char
|
Funkcje |
|
|---|---|
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)
|
Funkcja pomocnicza, która tłumaczy już zserializowany element eventdata na bufor zdarzeń.
|
GetPropertyDictionaryKey(PropertyPathHandle aHandle)
|
PropertyDictionaryKey
|
GetPropertySchemaHandle(PropertyPathHandle aHandle)
|
PropertySchemaHandle
|
IsNullPropertyPathHandle(PropertyPathHandle aHandle)
|
bool
|
IsRootPropertyPathHandle(PropertyPathHandle aHandle)
|
bool
|
IsVersionNewer(const DataVersion & aVersion, const DataVersion & aReference)
|
bool
Jest to zoptymalizowana implementacja algorytmu w celu porównywania wersji.
|
IsVersionNewerOrEqual(const DataVersion & aVersion, const DataVersion & aReference)
|
bool
|
Locate(TraitDataHandle aTraitDataHandle, const TraitCatalogBase< TraitDataSink > *aDataSinkCatalog)
|
Funkcja narzędziowa, która znajduje obiekt TraitUpdatableDataSink w katalogu TraitDataSink.
|
LogEvent(const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData)
|
Rejestruj zdarzenie ze wstępnie zdefiniowanej postaci.
|
LogEvent(const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData, const EventOptions *inOptions)
|
Rejestruj zdarzenie ze wstępnie zdefiniowanej postaci, korzystając z dodatkowych opcji.
|
LogEvent(const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData)
|
Zarejestruj zdarzenie przez wywołanie zwrotne.
|
LogEvent(const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData, const EventOptions *inOptions)
|
Zarejestruj zdarzenie przy użyciu wywołania zwrotnego i opcji.
|
LogFreeform(ImportanceType inImportance, const char *inFormat, ...)
|
LogFreeform wysyła dowolny ciąg znaków do domyślnego strumienia zdarzeń.
|
LookForElementWithTag(const nl::Weave::TLV::TLVReader & aSrcReader, const uint64_t aTagInApiForm, nl::Weave::TLV::TLVReader *apDstReader)
|
|
PlainTextWriter(TLVWriter & ioWriter, uint8_t inDataTag, void *appData)
|
Funkcja pomocnicza do przesyłania dowolnego tekstu jako zdarzenia debugowania.
|
PlainTextWriter(::nl::Weave::TLV::TLVWriter & ioWriter, uint8_t inDataTag, void *appData)
|
Funkcja pomocnicza do przesyłania dowolnego tekstu jako zdarzenia debugowania.
|
operator!=(const ResourceIdentifier & lhs, const ResourceIdentifier & rhs)
|
bool
|
operator==(const ResourceIdentifier & lhs, const ResourceIdentifier & rhs)
|
bool
|
Związki |
|
|---|---|
|
nl:: |
Związek, który udostępnia system zestawu aplikacji lub sygnaturę czasową UTC. |
Wyliczenia
@100
@100
Tagi zdarzenia kNestDebug_StringLogEntryEvent.
| Właściwości | |
|---|---|
kTag_Message
|
Ciąg tekstowy zawierający wiadomość debugowania. |
kTag_Region
|
32-bitowy tag niepodpisany wskazujący region logu, czyli moduł, którego dotyczy komunikat dziennika. |
@101
@101
Tagi zdarzenia kNestDebug_TokenizedLogEntryEvent.
| Właściwości | |
|---|---|
kTag_Args
|
Tablica argumentów do wysłania wraz z wiadomością tokena. |
kTag_Token
|
32-bitowa wartość bez znaku odpowiadająca tokenowi. |
@102
@102
Tagi zdarzeń utrzymujących się.
@104
@104
Typy komunikatów profilu WDM.
Wartości te są wywoływane w specyfikacji zarządzania danymi.
@105
@105
Kody stanu specyficzne dla WDM.
@147
@147
@95
@95
Tagi ustawień rejestrowania.
| Właściwości | |
|---|---|
kTag_CurrentImportance
|
Bieżące znaczenie logowania; wartość jest typu ImportanceType. |
kTag_ImportanceExpiration
|
Czas (w sekundach UTC), kiedy bieżące podwyższone ustawienia rejestrowania przywracają wartości domyślne. |
kTag_LoggingDestination
|
Adres URL określający miejsce docelowe przesyłania dziennika. |
kTag_MaximumLogUploadInterval
|
Maksymalny czas (w sekundach) między automatycznie aktywowanymi próbami przesłania logów. |
kTag_MinimumLogUploadInterval
|
Minimalny czas (w sekundach) między automatycznie aktywowanymi próbami przesłania dziennika. |
kTag_TraitLoggingImportance
|
Opcjonalna tablica z selektywnym mapowaniem wybranych profili na wyższe poziomy rejestrowania. Każdy element w tablicy ma formę (profil, ścieżka,loggingimportance), aby selektywnie podnosić logowanie z podzbioru systemu. Podwyższony priorytet logowania profilu ma znaczenie tylko wtedy, gdy priorytet rejestrowania przekracza bieżącą ważność i podlega temu samemu czasowi wygaśnięcia co obecna ważność. |
@96
@96
Tagi uprawnień logowania.
| Właściwości | |
|---|---|
kTag_LogBufferingCapacity
|
32-bitowa nieoznaczona liczba całkowita opisująca pojemność buforowania logów w kB. |
kTag_LoggingVolume
|
32-bitowa nieoznaczona liczba całkowita opisująca oczekiwany rozmiar logów w kB/dzień. |
kTag_SupportedLogTransports
|
Tablica obsługiwanych mechanizmów transportu logów. |
kTag_SupportsNonVolatileStorage
|
Wartość logiczna wskazująca, czy urządzenie obsługuje nieulotne przechowywanie logów. |
kTag_SupportsPerTraitVerbosity
|
Wartość logiczna wskazująca, czy urządzenie obsługuje ustawienia szczegółowości dla poszczególnych cech. |
kTag_SupportsStreaming
|
Wartość logiczna wskazująca, czy urządzenie obsługuje strumieniowe przesyłanie logów. |
@97
@97
Tagi metadanych zdarzeń.
Pełną semantykę wartości tagów znajdziesz w specyfikacji Event Design.
| Właściwości | |
|---|---|
kTag_EventData
|
Opcjonalnie: samych danych zdarzenia. Jeśli jest pusta, domyślnie stosowana jest struktura pusta. |
kTag_EventDeltaSystemTime
|
Wewnętrzny tag WDM, różnica czasu w kodowaniu w stosunku do poprzedniego zdarzenia. |
kTag_EventDeltaUTCTime
|
Wewnętrzny tag WDM, różnica czasu w kodowaniu w stosunku do poprzedniego zdarzenia. |
kTag_EventID
|
Numer sekwencyjny zdarzenia wyrażony jako 64-bitowa liczba bez znaku. Musi następować sekwencyjnie, a skoki w sekwencji oznaczają luki w zdarzeniach. |
kTag_EventImportance
|
Znaczenie zdarzenia. |
kTag_EventResourceID
|
Opcjonalnie: Wartość jest identyfikatorem zasobu, którego dotyczy zdarzenie. W przypadku pominięcia wartość jest taka sama jak wartość kTag_EventSource |
kTag_EventSource
|
Identyfikator węzła, który wygenerował zdarzenie. |
kTag_EventSystemTimestamp
|
Opcjonalnie: Systemowa sygnatura czasowa zdarzenia w milisekundach. |
kTag_EventTraitInstanceID
|
Wystąpienie cechy, które wywołało zdarzenie (opcjonalnie). |
kTag_EventTraitProfileID
|
Obowiązkowe. 32-bitowa nieoznaczona liczba całkowita, która jest równa identyfikatorowi ProfileID cechy. |
kTag_EventType
|
Obowiązkowe. 16-bitowa nieoznaczona liczba całkowita, która jest równa wartości wdl.event.id dla tego typu zdarzenia. |
kTag_EventUTCTimestamp
|
Opcjonalnie: Sygnatura czasowa zdarzenia UTC (w milisekundach). |
kTag_ExternalEventStructure
|
Wewnętrzny tag zdarzeń zewnętrznych. Nigdy nie przekazuj danych kablem i nie używaj go poza biblioteką Weave. |
kTag_RelatedEventID
|
Opcjonalnie: Identyfikator zdarzenia, z którym jest powiązane to zdarzenie. Jeśli zostanie pominięty, wartość jest równa wartości parametru kTag_EventID. |
kTag_RelatedEventImportance
|
Opcjonalnie: Znaczenie powiązanego zdarzenia. Jeśli zostanie pominięty, wartość jest równa wartości kTag_EventImportance. |
@98
@98
Definicje profili dla cechy debugowania.
@99
@99
Typy zdarzeń związanych z cechą Nest Debug.
| Właściwości | |
|---|---|
kNestDebug_StringLogEntryEvent
|
Zdarzenie wiadomości debugowania dowolnego ciągu znaków. |
kNestDebug_TokenizedHeaderEntryEvent
|
Zdarzenie służące do przekazywania informacji z tokenizowanego nagłówka. |
kNestDebug_TokenizedLogEntryEvent
|
Zdarzenie tokenizowanej wiadomości debugowania. |
CommandFlags
CommandFlags
| Właściwości | |
|---|---|
kCommandFlag_ActionTimeValid
|
Ustaw prawidłowy czas działania. |
kCommandFlag_ExpiryTimeValid
|
Ustaw prawidłowy czas ważności. |
kCommandFlag_InitiationTimeValid
|
Ustaw prawidłową godzinę rozpoczęcia. |
kCommandFlag_IsOneWay
|
Ustaw, jeśli polecenie jest jednokierunkowe. |
kCommandFlag_MustBeVersionValid
|
Ustaw, kiedy pole wersji jest prawidłowe. |
ImportanceType
ImportanceType
Znaczenie wpisu logu.
Znaczenie pozwala filtrować zdarzenia, zanim zostaną faktycznie wysłane do logu. Gdy zdarzenie zostanie zapisane w dzienniku, nie będziemy udostępniać żadnej dodatkowej konfiguracji umożliwiającej jego usunięcie z dziennika. Poziom ważności służy priorytetyzacji przechowywania wydarzeń. Jeśli ważne wydarzenie zostanie dodane do pełnego bufora, wydarzenia są pomijane w kolejności pod względem ważności (i wieku), aby je uwzględnić. Poziomy ważności mają więc tylko wartość względną. Jeśli system używa tylko jednego poziomu ważności, wydarzenia są pomijane tylko w zależności od wieku, tak jak w przypadku bufora dzwonienia.
| Właściwości | |
|---|---|
Debug
|
Znaczenie debugowania wskazuje wpisy logu interesujące dla programistów systemu i jest używane głównie na etapie programowania. Logi ważności debugowania nie są uwzględniane w budżetach przepustowości ani mocy energii z ograniczonymi urządzeniami. W związku z tym w systemach produkcyjnych należy ich używać tylko przez ograniczony czas. |
Info
|
Znaczenie informacji oznacza wpisy logu, które zapewniają dodatkowe informacje i diagnostykę w działającym systemie. Poziom logowania informacji może być używany przez dłuższy czas w systemie produkcyjnym lub jako domyślny poziom logowania w testach funkcjonalnych. Na urządzeniach z ograniczeniami wpisy rejestrowane na poziomie informacji muszą być uwzględniane w budżetach przepustowości i pamięci, ale nie w budżetach mocy. |
Production
|
Znaczenie produkcyjne wskazuje wpisy logu używane do ciągłego monitorowania i utrzymywania ekosystemu Nest. W przypadku urządzeń z ograniczeniami wpisy logowane ze znaczeniem produkcyjnym muszą być uwzględniane w budżetach mocy obliczeniowej i pamięci, ponieważ powinny być zawsze logowane i wyłączane z urządzenia. |
ProductionCritical
|
Kluczowe znaczenie dla środowiska produkcyjnego wskazuje wydarzenia, w przypadku których utrata bezpośrednia miałaby bezpośredni wpływ na funkcje dostępne dla klientów. Aplikacje mogą wykorzystywać zdarzenia utraty krytycznych czynników produkcyjnych do wskazywania awarii systemu. W przypadku urządzeń z ograniczeniami wpisy logowane z wartością krytyczną w zakresie produkcji muszą być uwzględniane w budżecie zasilania i pamięci, ponieważ powinny być zawsze logowane i wyłączane z urządzenia. |
LoggingManagementStates
LoggingManagementStates
| Właściwości | |
|---|---|
kLoggingManagementState_Holdoff
|
Odciążanie logów zakończone; nie uruchamiamy ponownie dziennika do czasu upłynięcia wstrzymania. |
kLoggingManagementState_Idle
|
Odciążanie logów nie jest w toku. Odciążanie logów może rozpocząć się bez ograniczeń. |
kLoggingManagementState_InProgress
|
Odprowadzanie logów w toku. |
kLoggingManagementState_Shutdown
|
Nie może przeprowadzać żadnych operacji logowania. |
TimestampType
TimestampType
Prawidłowość i typ sygnatury czasowej zawarte w parametrze EventOptions.
Definiuje typ
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)
Funkcja dostarczająca element eventData dla podsystemu logowania zdarzeń.
Funkcje tego typu powinny dostarczać element eventData na potrzeby podsystemu logowania zdarzeń. Funkcje tego typu są wywoływane po wygenerowaniu przez podsystem zdarzeń wszystkich wymaganych metadanych zdarzeń. Funkcja jest wywoływana za pomocą obiektu nl::Weave::TLV::TLVWriter, do którego przesyła pojedynczy element TLV otagowany kTag_EventData. wartością tego elementu MUSI być struktura zawierająca dane zdarzenia. Same dane zdarzeń muszą być uporządkowane za pomocą tagów kontekstu.
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
| Zwracane wartości |
|
||||||
PlainTextWriter
EventWriterTLVCopy
FetchExternalEventsFunct
WEAVE_ERROR(* FetchExternalEventsFunct)(EventLoadOutContext *aContext)
Prototyp funkcji służącej do pobierania danych zdarzenia przez wywołania zwrotne platformy.
Podobnie jak FetchEventsFrom, ta funkcja pobierania zwraca wszystkie zdarzenia od EventLoadOutContext.mStartingEventID do ExternalEvents.mLastEventID.
Wskaźnik kontekstu jest typu FetchExternalEventsContext. Obejmuje to EventLoadOutContext z pewnymi zmiennymi pomocniczymi dla formatu TLV. Zawiera też wskaźnik do struktury ExternalEvents utworzonej podczas rejestracji wywołania zwrotnego. Określa zakres identyfikatorów zdarzenia dla wywołania zwrotnego.
Po powrocie z funkcji identyfikator EventLoadOutContext.mCurrentEventID powinien odzwierciedlać pierwszy identyfikator zdarzenia, którego nie udało się zapisać w buforze TLV. Platforma musi zapisać nagłówek i dane zdarzeń do zapisującego TLV w odpowiednim formacie określonym przez protokół EventLogging. Platforma musi też zachowywać niepowtarzalność zdarzeń i sygnałów czasowych.
Wszystkie błędy TLV należy przekazywać na wyższe poziomy. Na przykład brak miejsca w buforze spowoduje wysłanie wiadomości, a następnie kolejne wywołanie zwrotne z tym, który identyfikator zdarzenia pozostaje.
| Szczegóły | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Zwracane wartości |
|
||||||||
GenericTraitSinkCatalog
GenericTraitCatalogImpl< TraitDataSink > GenericTraitSinkCatalog
GenericTraitSourceCatalog
GenericTraitCatalogImpl< TraitDataSource > GenericTraitSourceCatalog
ImportanceType
enum nl::Weave::Profiles::DataManagement_Current::ImportanceType ImportanceType
Znaczenie wpisu logu.
Znaczenie pozwala filtrować zdarzenia, zanim zostaną faktycznie wysłane do logu. Gdy zdarzenie zostanie zapisane w dzienniku, nie będziemy udostępniać żadnej dodatkowej konfiguracji umożliwiającej jego usunięcie z dziennika. Poziom ważności służy priorytetyzacji przechowywania wydarzeń. Jeśli ważne wydarzenie zostanie dodane do pełnego bufora, wydarzenia są pomijane w kolejności pod względem ważności (i wieku), aby je uwzględnić. Poziomy ważności mają więc tylko wartość względną. Jeśli system używa tylko jednego poziomu ważności, wydarzenia są pomijane tylko w zależności od wieku, tak jak w przypadku bufora dzwonienia.
IteratorCallback
void(* IteratorCallback)(void *aTraitInstance, TraitDataHandle aHandle, void *aContext)
Iterator uchwytu cechy.
LoggingBufferHandler
WEAVE_ERROR(* LoggingBufferHandler)(void *inAppState, PacketBuffer *inBuffer)
NotifyExternalEventsDeliveredFunct
void(* NotifyExternalEventsDeliveredFunct)(ExternalEvents *inEv, event_id_t inLastDeliveredEventID, uint64_t inRecipientNodeID)
Prototyp funkcji dla wywołania zwrotnego wywoływanego po dostarczeniu zdarzeń zewnętrznych do zdalnego subskrybenta.
Gdy zdarzenia zewnętrzne są dostarczane do zdalnego abonenta, wyszukiwarka wysyła powiadomienie do zewnętrznego dostawcy zdarzeń. Wywołanie zwrotne zawiera zdarzenie ostatniego dostarczonego identyfikatora oraz identyfikator subskrybenta, który otrzymał to zdarzenie.
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
NotifyExternalEventsEvictedFunct
void(* NotifyExternalEventsEvictedFunct)(ExternalEvents *inEv)
Prototyp funkcji dla wywołania zwrotnego wywoływanego po usunięciu z buforów zdarzeń zewnętrznych.
Gdy obiekt zdarzeń zewnętrznych zostanie usunięty z bufora wiadomości wychodzących, wyszukiwarka przekaże powiadomienie do zewnętrznego dostawcy zdarzeń. Wywołanie zwrotne zawiera zdarzenie zewnętrzne do wykluczenia.
| Szczegóły | |||
|---|---|---|---|
| Parametry |
|
||
PropertyDictionaryKey
uint16_t PropertyDictionaryKey
PropertyPathHandle
uint32_t PropertyPathHandle
Właściwość PropertyPathHandle to unikalny 32-bitowy hasz numeryczny ścieżki WDM odnoszący się do poziomu głównego instancji trait.
Składa się z dwóch części:
- Niższa liczba 16-bitowa, która jest mapowana na statyczną część schematu.
- Jeżeli dolne 16-bitowe części odnoszą się do ścieżki w elemencie słownika, wyświetlana jest górna liczba 16-bitowa, która reprezentuje klucz słownika powiązany z tym elementem. Jeśli dolne 16 bitów odnosi się do elementu niebędącego słownikiem, górne 16 bitów powinno mieć wartość 0.
Cechy charakterystyczne:
- Każda cecha ma własną przestrzeń jako uchwyt ścieżki właściwości.
- Każda niepowtarzalna ścieżka podrzędna WDM będzie miała podobnie unikalny parametr PropertyPathHandle.
- Obiekty PropertyPathHandles są generowane automatycznie (na razie ręcznie) przez kompilator cech z IDL i reprezentowane jako lista wyliczeniowa w odpowiednim pliku nagłówkowym cech.
- Dzięki tej konstrukcji logika aplikacji nigdy nie musi bezpośrednio zajmować się ścieżkami WDM. Zamiast tego ich interakcje z WDM są prowadzone wyłącznie przy użyciu tych nicków.
- Istnieją dwie zarezerwowane wartości dla uchwytów ścieżek, które mają konkretne znaczenie:
- 0 oznacza „NULL” nick
- 1 oznacza nick, który wskazuje katalog główny instancji trait.
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
Prawidłowość i typ sygnatury czasowej zawarte w parametrze EventOptions.
TraitDataHandle
uint16_t TraitDataHandle
duration_t
uint32_t duration_t
Typ używany do opisania czasu trwania (w milisekundach).
event_id_t
uint32_t event_id_t
Typ identyfikatora zdarzenia.
timestamp_t
uint32_t timestamp_t
Typ używany do opisania sygnatury czasowej w milisekundach.
utc_timestamp_t
uint64_t utc_timestamp_t
Typ używany do opisania sygnatury czasowej UTC w milisekundach.
Zmienne
sInstance
LoggingManagement sInstance
sLogFileName
char sLogFileName[] = "topazlog"
Funkcje
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 )
Funkcja pomocnicza, która tłumaczy już zserializowany element eventdata na bufor zdarzeń.
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
| Zwracane wartości |
|
||||||
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 )
Jest to zoptymalizowana implementacja algorytmu w celu porównywania wersji.
Po stronie klienta wersja otrzymana z usługi jest zawsze najnowsza.
IsVersionNewerOrEqual
bool IsVersionNewerOrEqual( const DataVersion & aVersion, const DataVersion & aReference )
Zlokalizuj
TraitUpdatableDataSink * Locate( TraitDataHandle aTraitDataHandle, const TraitCatalogBase< TraitDataSink > *aDataSinkCatalog )
Funkcja narzędziowa, która znajduje obiekt TraitUpdatableDataSink w katalogu TraitDataSink.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwroty |
wskaźnik do tabeli TraitUpdatableDataSink, Wartość NULL, jeśli nick nie istnieje lub wskazuje na niemożliwy do aktualizacji parametr TraitDataSink.
|
||||
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData )
Rejestruj zdarzenie ze wstępnie zdefiniowanej postaci.
Funkcja rejestruje zdarzenie reprezentowane przez ciąg nl::Weave::TLV::TLVReader. Oznacza to, że prezentacja danych zdarzenia jest już zserializowana w pamięci bazowej, na której jest podany nl::Weave::TLV::TLVReader. Tag nl::Weave::TLV::TLVReader powinien zawierać co najmniej 1 element danych, który musi być strukturą. Pierwszy element odczytany z czytnika jest traktowany jako dane zdarzenia i zapisywany w dzienniku zdarzeń. Dane zdarzenia MUSZĄ zawierać tagi kontekstu, które mają być interpretowane w ramach schematu określonego przez wartości inProfileID i inEventType. Tag pierwszego elementu zostanie zignorowany. system logowania zdarzeń zastąpi go tagiem eventData.
Zdarzenie jest logowane, jeśli jego ważność przekracza próg logowania określony w LoggingConfiguration. Jeśli znaczenie zdarzenia nie osiąga aktualnego progu, jest ono pomijane, a funkcja zwraca 0 jako otrzymany identyfikator zdarzenia.
Ten wariant wywołania niejawnie określa wszystkie domyślne opcje zdarzenia:
- w momencie rozpoczęcia połączenia wyświetli się sygnatura czasowa zdarzenia z bieżącą godziną w momencie połączenia.
- wydarzenie zostanie oznaczone jako powiązane z urządzeniem, z którego nawiązuje połączenie;
- wydarzenie jest niezależne i nie ma związku z żadnymi innymi wydarzeniami,
- wydarzenie jest oznaczone jako niepilne,
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwroty |
event_id_t: identyfikator zdarzenia, jeśli zdarzenie zostało zapisane w dzienniku. W przeciwnym razie ma wartość 0.
|
||||
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData, const EventOptions *inOptions )
Rejestruj zdarzenie ze wstępnie zdefiniowanej postaci, korzystając z dodatkowych opcji.
Funkcja rejestruje zdarzenie reprezentowane przez ciąg nl::Weave::TLV::TLVReader. Oznacza to, że prezentacja danych zdarzenia jest już zserializowana w pamięci bazowej, na której jest podany nl::Weave::TLV::TLVReader. Tag nl::Weave::TLV::TLVReader powinien zawierać co najmniej 1 element danych, który musi być strukturą. Pierwszy element odczytany z czytnika jest traktowany jako dane zdarzenia i zapisywany w dzienniku zdarzeń. Dane zdarzenia MUSZĄ zawierać tagi kontekstu, które mają być interpretowane w ramach schematu określonego przez wartości inProfileID i inEventType. Tag pierwszego elementu zostanie zignorowany. system logowania zdarzeń zastąpi go tagiem eventData.
Zdarzenie jest logowane, jeśli jego ważność przekracza próg logowania określony w LoggingConfiguration. Jeśli znaczenie zdarzenia nie osiąga aktualnego progu, jest ono pomijane, a funkcja zwraca 0 jako otrzymany identyfikator zdarzenia.
Ten wariant wywołania umożliwia obiektowi wywołującemu ustawienie dowolnej kombinacji wartości EventOptions:
- timestamp, gdy 0 przyjmuje domyślnie aktualną godzinę w momencie połączenia,
- „root” sekcji źródła zdarzeń (źródła zdarzeń i identyfikator cechy); Jeśli zawiera wartość NULL, domyślnie jest używane bieżące urządzenie. wydarzenie zostanie oznaczone jako powiązane z urządzeniem, z którego nawiązuje połączenie;
- identyfikator powiązanego zdarzenia służący do grupowania identyfikatorów zdarzeń; jeśli identyfikator powiązanego zdarzenia ma wartość 0, wydarzenie jest oznaczone jako niepowiązane z żadnymi innymi zdarzeniami.
- pilność; domyślnie nie są pilne.
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
| Zwroty |
event_id_t: identyfikator zdarzenia, jeśli zdarzenie zostało zapisane w dzienniku. W przeciwnym razie ma wartość 0.
|
||||||
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData )
Zarejestruj zdarzenie przez wywołanie zwrotne.
Funkcja rejestruje zdarzenie reprezentowane jako EventWriterFunct i kontekst appData danej aplikacji. Funkcja zapisuje metadane zdarzenia i wywołuje inEventWriter z odwołaniem nl::Weave::TLV::TLVWriter i kontekstem inAppData, tak aby kod użytkownika mógł emitować dane zdarzenia bezpośrednio do dziennika zdarzeń. Ta forma rejestrowania zdarzeń minimalizuje wykorzystanie pamięci, ponieważ dane zdarzeń są serializowane bezpośrednio w buforze docelowym. Dane zdarzenia MUSZĄ zawierać tagi kontekstu, które można zinterpretować w ramach schematu określonego przez inProfileID i inEventType. Tag pierwszego elementu zostanie zignorowany. system logowania zdarzeń zastąpi go tagiem eventData.
Zdarzenie jest logowane, jeśli jego ważność przekracza próg logowania określony w LoggingConfiguration. Jeśli znaczenie zdarzenia nie osiąga aktualnego progu, jest ono pomijane, a funkcja zwraca 0 jako otrzymany identyfikator zdarzenia.
Ten wariant wywołania niejawnie określa wszystkie domyślne opcje zdarzenia:
- w momencie rozpoczęcia połączenia wyświetli się sygnatura czasowa zdarzenia z bieżącą godziną w momencie połączenia.
- wydarzenie zostanie oznaczone jako powiązane z urządzeniem, z którego nawiązuje połączenie;
- wydarzenie jest niezależne i nie ma związku z żadnymi innymi wydarzeniami,
- wydarzenie jest oznaczone jako niepilne,
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
| Zwroty |
event_id_t: identyfikator zdarzenia, jeśli zdarzenie zostało zapisane w dzienniku. W przeciwnym razie ma wartość 0.
|
||||||
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData, const EventOptions *inOptions )
Zarejestruj zdarzenie przy użyciu wywołania zwrotnego i opcji.
Funkcja rejestruje zdarzenie reprezentowane jako EventWriterFunct i kontekst appData danej aplikacji. Funkcja zapisuje metadane zdarzenia i wywołuje inEventWriter z odwołaniem nl::Weave::TLV::TLVWriter i kontekstem inAppData, tak aby kod użytkownika mógł emitować dane zdarzenia bezpośrednio do dziennika zdarzeń. Ta forma rejestrowania zdarzeń minimalizuje wykorzystanie pamięci, ponieważ dane zdarzeń są serializowane bezpośrednio w buforze docelowym. Dane zdarzenia MUSZĄ zawierać tagi kontekstu, które można zinterpretować w ramach schematu określonego przez inProfileID i inEventType. Tag pierwszego elementu zostanie zignorowany. system logowania zdarzeń zastąpi go tagiem eventData.
Zdarzenie jest logowane, jeśli jego ważność przekracza próg logowania określony w LoggingConfiguration. Jeśli znaczenie zdarzenia nie osiąga aktualnego progu, jest ono pomijane, a funkcja zwraca 0 jako otrzymany identyfikator zdarzenia.
Ten wariant wywołania umożliwia obiektowi wywołującemu ustawienie dowolnej kombinacji wartości EventOptions:
- timestamp, gdy 0 przyjmuje domyślnie aktualną godzinę w momencie połączenia,
- „root” sekcji źródła zdarzeń (źródła zdarzeń i identyfikator cechy); Jeśli zawiera wartość NULL, domyślnie jest używane bieżące urządzenie. wydarzenie zostanie oznaczone jako powiązane z urządzeniem, z którego nawiązuje połączenie;
- identyfikator powiązanego zdarzenia służący do grupowania identyfikatorów zdarzeń; jeśli identyfikator powiązanego zdarzenia ma wartość 0, wydarzenie jest oznaczone jako niepowiązane z żadnymi innymi zdarzeniami.
- pilność; domyślnie nie są pilne.
| Szczegóły | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||||
| Zwroty |
event_id_t: identyfikator zdarzenia, jeśli zdarzenie zostało zapisane w dzienniku. W przeciwnym razie ma wartość 0.
|
||||||||
LogFreeform
event_id_t LogFreeform( ImportanceType inImportance, const char *inFormat, ... )
LogFreeform wysyła dowolny ciąg znaków do domyślnego strumienia zdarzeń.
Ciąg znaków zostanie umieszczony w strukturze zdarzeń debugowania i będzie taka sama jak pozostałe rejestrowane ciągi znaków. Identyfikatorem profilu zdarzenia będzie zdarzenie Nest Debug, a typem zdarzenia będzie kNestDebug_StringLogEntryEvent.
| Szczegóły | |||||
|---|---|---|---|---|---|
| Parametry |
|
||||
| Zwroty |
event_id_t: identyfikator zdarzenia, jeśli zdarzenie zostało zapisane w dzienniku. W przeciwnym razie ma wartość 0.
|
||||
LookForElementWithTag
WEAVE_ERROR LookForElementWithTag( const nl::Weave::TLV::TLVReader & aSrcReader, const uint64_t aTagInApiForm, nl::Weave::TLV::TLVReader *apDstReader )
PlainTextWriter
WEAVE_ERROR PlainTextWriter( TLVWriter & ioWriter, uint8_t inDataTag, void *appData )
Funkcja pomocnicza do przesyłania dowolnego tekstu jako zdarzenia debugowania.
Zdarzenie debugowania to struktura z regionem logów i dowolnym tekstem.
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
| Zwracane wartości |
|
||||||
PlainTextWriter
WEAVE_ERROR PlainTextWriter( ::nl::Weave::TLV::TLVWriter & ioWriter, uint8_t inDataTag, void *appData )
Funkcja pomocnicza do przesyłania dowolnego tekstu jako zdarzenia debugowania.
Zdarzenie debugowania to struktura z regionem logów i dowolnym tekstem.
| Szczegóły | |||||||
|---|---|---|---|---|---|---|---|
| Parametry |
|
||||||
| Zwracane wartości |
|
||||||