O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.
Esta página foi traduzida pela API Cloud Translation.
Switch to English

nl :: Tecer:: Perfis :: DataManagement_Current

Este namespace inclui todas as interfaces dentro do Weave para o perfil Weave Data Management (WDM) que são atualmente suportados para uso em produção.

Resumo

Enumerações

@100 {
kTag_Region = 1,
kTag_Message = 2
}
enum
Marcas para kNestDebug_StringLogEntryEvent.
@101 {
kTag_Token = 1,
kTag_Args = 2
}
enum
Marcas para kNestDebug_TokenizedLogEntryEvent.
@102 enum
Tags para eventos persistentes.
@104 enum
Os tipos de mensagem do perfil WDM.
@105 enum
Códigos de status específicos do WDM.
@147 enum
@95 {
kTag_CurrentImportance = 1,
kTag_ImportanceExpiration ,
kTag_MinimumLogUploadInterval ,
kTag_MaximumLogUploadInterval ,
kTag_LoggingDestination ,
kTag_TraitLoggingImportance
}
enum
Tags de configurações de registro .
@96 {
kTag_SupportedLogTransports = 1,
kTag_SupportsStreaming = 2,
kTag_SupportsNonVolatileStorage = 3,
kTag_SupportsPerTraitVerbosity = 4,
kTag_LoggingVolume = 5,
kTag_LogBufferingCapacity = 6
}
enum
Marcas para recursos de registro.
@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
Tags para metadados de eventos.
@98 enum
Definições de perfil para o traço de depuração.
@99 {
kNestDebug_StringLogEntryEvent = 1,
kNestDebug_TokenizedLogEntryEvent = 2,
kNestDebug_TokenizedHeaderEntryEvent = 3
}
enum
Tipos de eventos para o traço 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
A importância da entrada do log.
LoggingManagementStates {
kLoggingManagementState_Idle = 1,
kLoggingManagementState_InProgress = 2,
kLoggingManagementState_Holdoff = 3,
kLoggingManagementState_Shutdown = 4
}
enum
TimestampType enum
A validade e o tipo de carimbo de data / hora incluído em EventOptions .

Typedefs

CommandFlags typedef
DataVersion typedef
uint64_t
EventProcessor typedef
void *
EventWriterFunct )(nl::Weave::TLV::TLVWriter &ioWriter, uint8_t inDataTag, void *appData) typedef
Uma função que fornece o elemento eventData para o subsistema de registro de eventos.
FetchExternalEventsFunct )(EventLoadOutContext *aContext) typedef
Um protótipo de função para retornos de chamada de plataforma que buscam dados de eventos.
GenericTraitSinkCatalog typedef
GenericTraitSourceCatalog typedef
ImportanceType typedef
A importância da entrada do log.
IteratorCallback )(void *aTraitInstance, TraitDataHandle aHandle, void *aContext) typedef
void(*
Iterador de identificador de traço.
LoggingBufferHandler )(void *inAppState, PacketBuffer *inBuffer) typedef
NotifyExternalEventsDeliveredFunct )(ExternalEvents *inEv, event_id_t inLastDeliveredEventID, uint64_t inRecipientNodeID) typedef
void(*
Um protótipo de função para um retorno de chamada invocado quando eventos externos são entregues ao assinante remoto.
NotifyExternalEventsEvictedFunct )(ExternalEvents *inEv) typedef
void(*
Um protótipo de função para um retorno de chamada invocado quando eventos externos são removidos dos buffers.
PropertyDictionaryKey typedef
uint16_t
PropertyPathHandle typedef
uint32_t
Um PropertyPathHandle é um hash numérico exclusivo de 32 bits de um caminho WDM relativo à raiz de uma instância de característica.
PropertySchemaHandle typedef
uint16_t
SchemaVersion typedef
uint16_t
SingleResourceSinkTraitCatalog typedef
SingleResourceSourceTraitCatalog typedef
TimestampType typedef
A validade e o tipo de carimbo de data / hora incluído em EventOptions .
TraitDataHandle typedef
uint16_t
duration_t nl :: Weave :: Profiles :: DataManagement_Current :: duration_t
uint32_t
Tipo usado para descrever a duração, em milissegundos.
event_id_t nl :: Weave :: Profiles :: DataManagement_Current :: event_id_t
uint32_t
O tipo de ID do evento.
timestamp_t nl :: Weave :: Profiles :: DataManagement_Current :: timestamp_t
uint32_t
Tipo usado para descrever o carimbo de data / hora em milissegundos.
utc_timestamp_t nl :: Weave :: Profiles :: DataManagement_Current :: utc_timestamp_t
uint64_t
Tipo usado para descrever o carimbo de data / hora UTC em milissegundos.

Variáveis

sInstance
sLogFileName = "topazlog"[]
char

Funções

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)
Uma função auxiliar que converte um elemento eventdata já serializado no buffer de eventos.
GetPropertyDictionaryKey ( PropertyPathHandle aHandle)
PropertyDictionaryKey
GetPropertySchemaHandle ( PropertyPathHandle aHandle)
PropertySchemaHandle
IsNullPropertyPathHandle ( PropertyPathHandle aHandle)
bool
IsRootPropertyPathHandle ( PropertyPathHandle aHandle)
bool
IsVersionNewer (const DataVersion & aVersion, const DataVersion & aReference)
bool
Esta é uma implementação otimizada do algoritmo para comparar versões.
IsVersionNewerOrEqual (const DataVersion & aVersion, const DataVersion & aReference)
bool
Locate (TraitDataHandle aTraitDataHandle, const TraitCatalogBase < TraitDataSink > *aDataSinkCatalog)
Função de utilidade que encontra um TraitUpdatableDataSink em um catálogo TraitDataSink .
LogEvent (const EventSchema & inSchema,nl::Weave::TLV::TLVReader & inData)
Registre um evento de um formulário pré-serializado.
LogEvent (const EventSchema & inSchema,nl::Weave::TLV::TLVReader & inData, const EventOptions *inOptions)
Registre um evento de um formulário pré-serializado, com opções adicionais.
LogEvent (const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData)
Registre um evento por meio de um retorno de chamada.
LogEvent (const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData, const EventOptions *inOptions)
Registre um evento por meio de um retorno de chamada, com opções.
LogFreeform ( ImportanceType inImportance, const char *inFormat, ...)
LogFreeform emite uma string de forma livre para o fluxo de eventos padrão.
LookForElementWithTag (constnl::Weave::TLV::TLVReader & aSrcReader, const uint64_t aTagInApiForm,nl::Weave::TLV::TLVReader *apDstReader)
PlainTextWriter (TLVWriter & ioWriter, uint8_t inDataTag, void *appData)
Uma função auxiliar para emitir um texto de forma livre como um evento de depuração.
PlainTextWriter (::nl::Weave::TLV::TLVWriter & ioWriter, uint8_t inDataTag, void *appData)
Uma função auxiliar para emitir um texto de forma livre como um evento de depuração.
operator!= (const ResourceIdentifier & lhs, const ResourceIdentifier & rhs)
bool
operator== (const ResourceIdentifier & lhs, const ResourceIdentifier & rhs)
bool

Aulas

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

Classe base para codificadores de mensagens WDM.

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

Um TLVReader apoiado por CircularEventBuffer .

nl :: Weave :: Profiles :: DataManagement_Current :: Command
nl :: Weave :: Profiles :: DataManagement_Current :: CommandSender
nl :: Weave :: Profiles :: DataManagement_Current :: GenericTraitCatalogImpl

Um Weave forneceu a implementação da interface TraitCatalogBase para uma coleção de instâncias de dados de características que se referem ao mesmo recurso.

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

Interface que deve ser implementada por um processador de elementos de dados em um NotifyRequest.

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

Interface que deve ser implementada pelo aplicativo para serializar o acesso às principais estruturas de dados WDM.

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

Interface de um objeto mutex.

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

Classe base para codificadores de mensagem WDM, especializada em elementos de array TLV como Listas de Dados e Listas de Versão.

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

Classe base para analisadores de mensagem WDM, especializada em elementos de array TLV como Listas de Dados e Listas de Versão.

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

LoggingConfiguration encapsula o componente configurável do subsistema Weave Event Logging .

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

Uma classe para gerenciar os logs de eventos na memória.

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

Classe base para analisadores de mensagens WDM.

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

Uma estrutura que encapsula o ID de um recurso.

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

Este é um singleton que hospeda todas as assinaturas WDM Next, tanto do lado do cliente quanto do editor.

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

O mecanismo de esquema obtém informações de esquema associadas a uma característica específica e fornece recursos para analisar e traduzir isso em uma forma utilizável pela máquina WDM.

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

Classe de utilitário para colocar o dicionário de volta na fila pendente ao processar o caminho da propriedade que possui o dicionário filho.

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

Classe de utilitário para filtrar o caminho ao lidar com a notificação.

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

Este objeto codifica cargas úteis WDM UpdateRequest e PartialUpdateRequest.

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

Structs

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

Buffer de evento interno, criado em torno do nl :: Weave :: TLV :: WeaveCircularTLVBuffer .

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

Estrutura interna para percorrer a lista de eventos.

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

A estrutura que fornece uma resolução completa da instância do trait.

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

Estrutura interna para atravessar eventos.

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

Estrutura para copiar listas de eventos na saída.

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

A estrutura que fornece opções para os diferentes campos de eventos.

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

A estrutura que define um esquema para metadados de eventos.

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

Estrutura para rastrear eventos armazenados na plataforma.

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

Uma classe auxiliar usada na inicialização do gerenciamento de log.

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

Sindicatos

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

A união que fornece um sistema de conjunto de aplicativos ou carimbo de data / hora UTC.

Namespaces

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

Definição do Comando Personalizado WDM.

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

Definição de resposta de comando personalizado do WDM.

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

Definição do elemento de dados WDM.

nl :: Weave :: Profiles :: DataManagement_Current :: DataList
nl :: Weave :: Profiles :: DataManagement_Current :: Event
nl :: Weave :: Profiles :: DataManagement_Current :: EventList
nl :: Weave :: Profiles :: DataManagement_Current :: NotificationRequest
nl :: Weave :: Profiles :: DataManagement_Current :: Path

Definição de caminho WDM.

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

WDM Path definição da lista.

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

Definição do elemento de status 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

Definição de solicitação de atualização de WDM.

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

Enumerações

@ 100

 @100

Marcas para kNestDebug_StringLogEntryEvent.

Propriedades
kTag_Message

Uma string contendo a mensagem de depuração real.

kTag_Region

Um sem sinal de 32 bits que indica a região de registro, ou seja, o módulo ao qual a mensagem de registro pertence.

@ 101

 @101

Marcas para kNestDebug_TokenizedLogEntryEvent.

Propriedades
kTag_Args

Uma matriz de argumentos a serem enviados junto com a mensagem de token.

kTag_Token

Um valor sem sinal de 32 bits correspondente ao token.

@ 102

 @102

Tags para eventos persistentes.

@ 104

 @104

Os tipos de mensagem do perfil WDM.

Esses valores são chamados na especificação de gerenciamento de dados.

@ 105

 @105

Códigos de status específicos do WDM.

@ 147

 @147

@ 95

 @95

Tags de configurações de registro .

Propriedades
kTag_CurrentImportance

Importância de registro atual, o valor é do tipo ImportanceType.

kTag_ImportanceExpiration

Tempo, em segundos UTC, quando as configurações de log elevado atuais são revertidas para os valores padrão.

kTag_LoggingDestination

Um URL denotando o destino do upload do log.

kTag_MaximumLogUploadInterval

Duração máxima, em segundos, entre as tentativas de upload de log acionadas automaticamente.

kTag_MinimumLogUploadInterval

Duração mínima, em segundos, entre as tentativas de upload de log acionadas automaticamente.

kTag_TraitLoggingImportance

Uma matriz opcional que mapeia seletivamente perfis escolhidos nos níveis de registro mais altos.

Cada elemento na matriz assume uma forma (perfil, caminho, importância de registro) para elevar seletivamente o registro de um subconjunto do sistema. A prioridade de log de perfil elevado só é significativa quando a prioridade de log excede a de currentImportance e está sujeita ao mesmo tempo de expiração de currentImportance.

@ 96

 @96

Marcas para recursos de registro.

Propriedades
kTag_LogBufferingCapacity

Um inteiro sem sinal de 32 bits que descreve a capacidade de armazenamento em buffer do log em kB.

kTag_LoggingVolume

Um inteiro não assinado de 32 bits que descreve o volume de registro esperado em KB / dia.

kTag_SupportedLogTransports

Uma matriz de mecanismos de transporte de log com suporte.

kTag_SupportsNonVolatileStorage

Um booleano que indica se o dispositivo oferece suporte ao armazenamento de log não volátil.

kTag_SupportsPerTraitVerbosity

Um booleano que indica se o dispositivo oferece suporte a configurações de detalhamento por característica.

kTag_SupportsStreaming

Um booleano que indica se o dispositivo oferece suporte a logs de streaming.

@ 97

 @97

Tags para metadados de eventos.

Para a semântica completa dos valores de tag, consulte a Especificação de Design de Evento.

Propriedades
kTag_EventData

Opcional. Dados do evento em si. Se estiver vazio, o padrão é uma estrutura vazia.

kTag_EventDeltaSystemTime

Etiqueta interna WDM, diferença de tempo em relação ao evento anterior na codificação.

kTag_EventDeltaUTCTime

Etiqueta interna WDM, diferença de tempo em relação ao evento anterior na codificação.

kTag_EventID

Número de sequência do evento, expresso como uma quantidade não sinalizada de 64 bits.

Deve ser sequencial, os saltos na sequência indicam lacunas de eventos.

kTag_EventImportance

Importância do evento.

kTag_EventResourceID

Opcional.

O valor é o ID do recurso ao qual o evento pertence. Quando omitido, o valor é igual ao valor de kTag_EventSource

kTag_EventSource

NodeID do dispositivo que gerou o evento.

kTag_EventSystemTimestamp

Opcional. Registro de data e hora do sistema do evento em milissegundos.

kTag_EventTraitInstanceID

Opcional, a instância da característica que gerou o evento.

kTag_EventTraitProfileID

Obrigatório. Inteiro não assinado de 32 bits que é igual ao ProfileID da característica.

kTag_EventType

Obrigatório. Inteiro não assinado de 16 bits que é igual a wdl.event.id para este tipo de evento.

kTag_EventUTCTimestamp

Opcional. Carimbo de data / hora UTC do evento em milissegundos.

kTag_ExternalEventStructure

Tag interna para eventos externos. Nunca transmitido através do fio, nunca deve ser usado fora da biblioteca Weave.

kTag_RelatedEventID

Opcional.

ID de um evento ao qual este evento está relacionado. Se omitido, o valor é igual ao valor de kTag_EventID.

kTag_RelatedEventImportance

Opcional.

Importância do evento relacionado. Se omitido, o valor é igual ao valor de kTag_EventImportance.

@ 98

 @98

Definições de perfil para o traço de depuração.

@ 99

 @99

Tipos de eventos para o traço Nest Debug.

Propriedades
kNestDebug_StringLogEntryEvent

Um evento para mensagem de depuração de string de formato livre.

kNestDebug_TokenizedHeaderEntryEvent

Um evento para transmitir as informações do cabeçalho tokenizado.

kNestDebug_TokenizedLogEntryEvent

Um evento para mensagem de depuração tokenizada.

CommandFlags

 CommandFlags
Propriedades
kCommandFlag_ActionTimeValid

Defina quando o tempo de ação é válido.

kCommandFlag_ExpiryTimeValid

Definido quando o tempo de expiração é válido.

kCommandFlag_InitiationTimeValid

Defina quando o tempo de inicialização é válido.

kCommandFlag_IsOneWay

Definido quando o comando é unilateral.

kCommandFlag_MustBeVersionValid

Definido quando o campo de versão é válido.

ImportanceType

 ImportanceType

A importância da entrada do log.

A importância é usada como uma forma de filtrar eventos antes que eles sejam realmente emitidos no log. Depois que o evento estiver no log, não faremos mais nenhuma providência para eliminá-lo do log. O nível de importância serve para priorizar o armazenamento de eventos. Se um evento de alta importância for adicionado a um buffer cheio, os eventos serão descartados em ordem de importância (e idade) para acomodá-lo. Como tal, os níveis de importância têm apenas valor relativo. Se um sistema estiver usando apenas um nível de importância, os eventos são descartados apenas em ordem de idade, como um buffer de anel.

Propriedades
Debug

A importância da depuração denota entradas de log de interesse para os desenvolvedores do sistema e é usada principalmente na fase de desenvolvimento.

Os registros de importância de depuração não são contabilizados nos orçamentos de largura de banda ou energia dos dispositivos restritos; como resultado, eles devem ser usados ​​apenas por um período de tempo limitado em sistemas de produção.

Info

A importância das informações denota entradas de log que fornecem informações e diagnósticos extras sobre o sistema em execução.

O nível de registro de informações pode ser usado por um longo período de tempo em um sistema de produção ou pode ser usado como o nível de registro padrão em um teste de campo. Nos dispositivos restritos, as entradas registradas com nível de informação devem ser contabilizadas no orçamento de largura de banda e memória, mas não no orçamento de energia.

Production

A importância da produção denota as entradas de registro que são usadas no monitoramento e manutenção contínuos do ecossistema Nest.

Em dispositivos restritos, as entradas registradas com importância de produção devem ser contabilizadas no orçamento de energia e memória, pois é esperado que elas sempre sejam registradas e descarregadas do dispositivo.

ProductionCritical

Produção A importância crítica denota eventos cuja perda afetaria diretamente os recursos voltados para o cliente.

Os aplicativos podem usar eventos de perda de produção crítica para indicar falha do sistema. Em dispositivos restritos, as entradas registradas com importância crítica de produção devem ser contabilizadas no orçamento de energia e memória, pois é esperado que elas sempre sejam registradas e descarregadas do dispositivo.

LoggingManagementStates

 LoggingManagementStates
Propriedades
kLoggingManagementState_Holdoff

O descarregamento do log foi concluído; não reiniciamos o log até que o tempo de espera expire.

kLoggingManagementState_Idle

Sem log offload em andamento, o log offload pode começar sem quaisquer restrições.

kLoggingManagementState_InProgress

Log offload em andamento.

kLoggingManagementState_Shutdown

Incapaz de realizar qualquer operação de registro.

TimestampType

 TimestampType

A validade e o tipo de carimbo de data / hora incluído em 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)

Uma função que fornece o elemento eventData para o subsistema de registro de eventos.

Espera-se que as funções desse tipo forneçam o elemento eventData para o subsistema de registro de eventos. As funções desse tipo são chamadas depois que o subsistema de eventos gerou todos os metadados de eventos necessários. A função é chamada com um objetonl :: Weave :: TLV :: TLVWriter no qual ela emitirá um único elemento TLV marcado com kTag_EventData; o valor desse elemento DEVE ser uma estrutura contendo os dados do evento. Os próprios dados do evento devem ser estruturados usando tags de contexto.

Detalhes
Parâmetros
[in,out] ioWriter
Uma referência ao objetonl :: Weave :: TLV :: TLVWriter a ser usado para serialização de dados de evento.
[in] inDataTag
Uma tag de contexto para o TLV que estamos escrevendo.
[in] appData
Um ponteiro para um contexto específico do aplicativo.
Valores Retornados
WEAVE_NO_ERROR
Com sucesso.
other
Um erro apropriado sinalizando ao chamador que a serialização dos dados do evento não pôde ser concluída. Erros de chamadas para o ioWriter devem ser propagados sem remapeamento. Se a função retornar algum tipo de erro, a geração do evento é abortada e o evento não é gravado no log.
Veja também:
PlainTextWriter
EventWriterTLVCopy

FetchExternalEventsFunct

WEAVE_ERROR(* FetchExternalEventsFunct)(EventLoadOutContext *aContext)

Um protótipo de função para callbacks de plataforma que buscam dados de eventos.

Semelhante a FetchEventsSince, esta função de busca retorna todos os eventos de EventLoadOutContext.mStartingEventID por meio de ExternalEvents.mLastEventID .

O ponteiro de contexto é do tipo FetchExternalEventsContext. Isso inclui o EventLoadOutContext , com algumas variáveis ​​auxiliares para o formato do TLV . Ele também inclui um ponteiro para a estrutura ExternalEvents criada no registro do retorno de chamada. Isso especifica o intervalo de ID do evento para o retorno de chamada.

Ao retornar da função, EventLoadOutContext.mCurrentEventID deve refletir o primeiro ID de evento que não foi gravado com sucesso no buffer TLV . A plataforma deve gravar o cabeçalho e os dados dos eventos no gravador TLV no formato correto, especificado pelo protocolo EventLogging. A plataforma também deve manter a exclusividade de eventos e carimbos de data / hora.

Todos os erros TLV devem ser propagados para níveis superiores. Por exemplo, ficar sem espaço no buffer irá acionar uma mensagem enviada, seguida por outra chamada para o retorno de chamada com qualquer ID de evento restante.

Detalhes
Valores Retornados
WEAVE_ERROR_NO_MEMORY
Se não houver espaço para escrever eventos.
WEAVE_ERROR_BUFFER_TOO_SMALL
Se não houver espaço para escrever eventos.
WEAVE_NO_ERROR
Com sucesso.
WEAVE_END_OF_TLV
Com sucesso.

GenericTraitSinkCatalog

GenericTraitCatalogImpl< TraitDataSink > GenericTraitSinkCatalog

GenericTraitSourceCatalog

GenericTraitCatalogImpl< TraitDataSource > GenericTraitSourceCatalog

ImportanceType

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

A importância da entrada do log.

A importância é usada como uma forma de filtrar eventos antes que eles sejam realmente emitidos no log. Depois que o evento estiver no log, não faremos mais nenhuma providência para eliminá-lo do log. O nível de importância serve para priorizar o armazenamento de eventos. Se um evento de alta importância for adicionado a um buffer cheio, os eventos serão descartados em ordem de importância (e idade) para acomodá-lo. Como tal, os níveis de importância têm apenas valor relativo. Se um sistema estiver usando apenas um nível de importância, os eventos serão descartados apenas em ordem de idade, como um buffer de anel.

IteratorCallback

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

Iterador de identificador de traço.

LoggingBufferHandler

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

NotifyExternalEventsDeliveredFunct

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

Um protótipo de função para um retorno de chamada invocado quando eventos externos são entregues ao assinante remoto.

Quando os eventos externos são entregues a um assinante remoto, o mecanismo fornecerá uma notificação ao provedor de eventos externo. O retorno de chamada contém o evento da última ID entregue e a ID do assinante que recebeu o evento.

Detalhes
Parâmetros
[in] inEv
Objeto de eventos externos correspondente a eventos entregues
[in] inLastDeliveredEventID
ID do último evento entregue ao assinante.
[in] inRecipientNodeID
ID de nó de tecido do destinatário

NotifyExternalEventsEvictedFunct

void(* NotifyExternalEventsEvictedFunct)(ExternalEvents *inEv)

Um protótipo de função para um retorno de chamada invocado quando eventos externos são removidos dos buffers.

Quando o objeto de eventos externos é removido do buffer de mensagem de saída, o mecanismo fornecerá uma notificação ao provedor de eventos externo. O retorno de chamada contém o evento externo a ser despejado.

Detalhes
Parâmetros
[in] inEv
Objeto de eventos externos a ser despejado

PropertyDictionaryKey

uint16_t PropertyDictionaryKey

PropertyPathHandle

uint32_t PropertyPathHandle

Um PropertyPathHandle é um hash numérico exclusivo de 32 bits de um caminho WDM relativo à raiz de uma instância de característica.

Tem duas partes:

  • Um número inferior de 16 bits que mapeia para a parte estática do esquema.
  • Onde os 16 bits inferiores se referem a um caminho dentro de um elemento de dicionário, um número superior de 16 bits está presente que representa a chave de dicionário associada a esse elemento. Se os 16 bits inferiores se referem a um elemento que não está no dicionário, os 16 bits superiores devem ser 0.

Algumas características:

  • Cada característica tem seu próprio espaço de manipulação de caminho de propriedade.
  • Cada caminho de subcaminho WDM exclusivo terá um PropertyPathHandle exclusivo semelhante.
  • PropertyPathHandles são gerados automaticamente (feitos manualmente por enquanto) por um compilador de característica da IDL e é representado como uma lista de enumerantes no arquivo de cabeçalho da característica correspondente.
  • Com essa construção, a lógica do aplicativo nunca precisa lidar com os caminhos WDM diretamente. Em vez disso, suas interações com o WDM são conduzidas exclusivamente por meio dessas alças.
  • Existem dois valores reservados para identificadores de caminho que têm um significado específico:
    • 0 indica um identificador 'NULL'
    • 1 indica um identificador que aponta para a raiz da instância do 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

A validade e o tipo de carimbo de data / hora incluído em EventOptions .

TraitDataHandle

uint16_t TraitDataHandle

duration_t

uint32_t duration_t

Tipo usado para descrever a duração, em milissegundos.

event_id_t

uint32_t event_id_t

O tipo de ID do evento.

timestamp_t

uint32_t timestamp_t

Tipo usado para descrever o carimbo de data / hora em milissegundos.

utc_timestamp_t

uint64_t utc_timestamp_t

Tipo usado para descrever o carimbo de data / hora UTC em milissegundos.

Variáveis

sInstance

LoggingManagement sInstance

sLogFileName

char sLogFileName[] = "topazlog"

Funções

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
)

Uma função auxiliar que converte um elemento eventdata já serializado no buffer de eventos.

Detalhes
Parâmetros
[in,out] ioWriter
O escritor a ser usado para escrever o evento
[in] inDataTag
Uma tag de contexto para o TLV que estamos copiando. Não usado aqui, mas exigido pelo typedef para EventWriterFunct.
[in] appData
Um ponteiro para o TLVReader que contém dados de eventos serializados.
Valores Retornados
WEAVE_NO_ERROR
Com sucesso.
other
Outros erros que podem ser retornados do 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
)

Esta é uma implementação otimizada do algoritmo para comparar versões.

Do lado do cliente, uma versão recebida do serviço é sempre a mais recente.

IsVersionNewerOrEqual

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

Localizar

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

Função de utilidade que encontra um TraitUpdatableDataSink em um catálogo TraitDataSink .

Detalhes
Parâmetros
[in] aTraitDataHandle
Alça da pia para pesquisar.
[in] aDataSinkCatalog
Catálogo para pesquisar.
Devoluções
Um ponteiro para o TraitUpdatableDataSink ; NULL se o identificador não existir ou apontar para um TraitDataSink não atualizável.

LogEvent

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

Registre um evento de um formulário pré-serializado.

A função registra um evento representado como umnl :: Weave :: TLV :: TLVReader . Isso implica que a representação dos dados do evento já está serializada no armazenamento subjacente aonl :: Weave :: TLV :: TLVReader . Espera-se que onl :: Weave :: TLV :: TLVReader contenha pelo menos um único elemento de dados, esse elemento deve ser uma estrutura. O primeiro elemento lido pelo leitor é tratado como dados de evento e armazenado no log de eventos. Os dados do evento DEVEM conter tags de contexto a serem interpretados dentro do esquema identificado por inProfileID e inEventType. A tag do primeiro elemento será ignorada; o sistema de registro de eventos irá substituí-lo pela tag eventData.

O evento é registrado se sua importância exceder o limite de registro especificado em LoggingConfiguration . Se a importância do evento não atingir o limite atual, ele será descartado e a função retornará 0 como o ID do evento resultante.

Esta variante da invocação especifica implicitamente todas as opções de evento padrão:

  • o evento é marcado com a hora atual no ponto da chamada,
  • o evento é marcado como relacionado ao dispositivo que está fazendo a chamada,
  • o evento é autônomo, não relacionado a nenhum outro evento,
  • o evento é marcado como não urgente,

Detalhes
Parâmetros
[in] inSchema
Esquema que define a importância, o ID do perfil e o tipo de estrutura deste evento.
[in] inData
O leitor TLV que contém os dados do evento como o primeiro elemento.
Devoluções
event_id_t O ID do evento se o evento foi gravado no log, 0 caso contrário.

LogEvent

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

Registre um evento de um formulário pré-serializado, com opções adicionais.

A função registra um evento representado como umnl :: Weave :: TLV :: TLVReader . Isso implica que a representação dos dados do evento já está serializada no armazenamento subjacente aonl :: Weave :: TLV :: TLVReader . Espera-se que onl :: Weave :: TLV :: TLVReader contenha pelo menos um único elemento de dados, esse elemento deve ser uma estrutura. O primeiro elemento lido pelo leitor é tratado como dados de evento e armazenado no log de eventos. Os dados do evento DEVEM conter tags de contexto a serem interpretados dentro do esquema identificado por inProfileID e inEventType. A tag do primeiro elemento será ignorada; o sistema de registro de eventos irá substituí-lo pela tag eventData.

O evento é registrado se sua importância exceder o limite de registro especificado em LoggingConfiguration . Se a importância do evento não atingir o limite atual, ele será descartado e a função retornará 0 como o ID do evento resultante.

Esta variante da invocação permite que o chamador defina qualquer combinação de EventOptions :

  • carimbo de data / hora, quando 0 padroniza para a hora atual no ponto da chamada,
  • seção "raiz" da fonte do evento (fonte do evento e ID do trait); se NULL, o padrão é o dispositivo atual. o evento é marcado como relacionado ao dispositivo que está fazendo a chamada,
  • um ID de evento relacionado para agrupar IDs de eventos; quando o ID do evento relacionado é 0, o evento é marcado como não relacionado a nenhum outro evento,
  • urgência; por padrão, não urgente.

Detalhes
Parâmetros
[in] inSchema
Esquema que define a importância, o ID do perfil e o tipo de estrutura deste evento.
[in] inData
O leitor TLV que contém os dados do evento como o primeiro elemento. Não deve ser nulo
[in] inOptions
As opções para os metadados do evento. Pode ser NULL.
Devoluções
event_id_t O ID do evento se o evento foi gravado no log, 0 caso contrário.

LogEvent

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

Registre um evento por meio de um retorno de chamada.

A função registra um evento representado como um EventWriterFunct e um contexto appData específico do aplicativo. A função grava os metadados do evento e chama inEventWriter com uma referêncianl :: Weave :: TLV :: TLVWriter e contexto inAppData para que o código do usuário possa emitir os dados do evento diretamente no log de eventos. Essa forma de registro de eventos minimiza o consumo de memória, pois os dados do evento são serializados diretamente no buffer de destino. Os dados do evento DEVEM conter tags de contexto a serem interpretados dentro do esquema identificado por inProfileID e inEventType . A tag do primeiro elemento será ignorada; o sistema de registro de eventos irá substituí-lo pela tag eventData.

O evento é registrado se sua importância exceder o limite de registro especificado em LoggingConfiguration . Se a importância do evento não atingir o limite atual, ele será descartado e a função retornará 0 como o ID do evento resultante.

Esta variante da invocação especifica implicitamente todas as opções de evento padrão:

  • o evento é marcado com a hora atual no ponto da chamada,
  • o evento é marcado como relacionado ao dispositivo que está fazendo a chamada,
  • o evento é autônomo, não relacionado a nenhum outro evento,
  • o evento é marcado como não urgente,

Detalhes
Parâmetros
[in] inSchema
Esquema que define a importância, o ID do perfil e o tipo de estrutura deste evento.
[in] inEventWriter
O retorno de chamada a ser invocado para realmente serializar os dados do evento
[in] inAppData
Contexto do aplicativo para o retorno de chamada.
Devoluções
event_id_t O ID do evento se o evento foi gravado no log, 0 caso contrário.

LogEvent

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

Registre um evento por meio de um retorno de chamada, com opções.

A função registra um evento representado como um EventWriterFunct e um contexto appData específico do aplicativo. A função grava os metadados do evento e chama inEventWriter com uma referêncianl :: Weave :: TLV :: TLVWriter e contexto inAppData para que o código do usuário possa emitir os dados do evento diretamente no log de eventos. Essa forma de registro de eventos minimiza o consumo de memória, pois os dados do evento são serializados diretamente no buffer de destino. Os dados do evento DEVEM conter tags de contexto a serem interpretados dentro do esquema identificado por inProfileID e inEventType . A tag do primeiro elemento será ignorada; o sistema de registro de eventos irá substituí-lo pela tag eventData.

O evento é registrado se sua importância exceder o limite de registro especificado em LoggingConfiguration . Se a importância do evento não atingir o limite atual, ele será descartado e a função retornará 0 como o ID do evento resultante.

Esta variante da invocação permite que o chamador defina qualquer combinação de EventOptions :

  • carimbo de data / hora, quando 0 padroniza para a hora atual no ponto da chamada,
  • seção "raiz" da fonte do evento (fonte do evento e ID do trait); se NULL, o padrão é o dispositivo atual. o evento é marcado como relacionado ao dispositivo que está fazendo a chamada,
  • um ID de evento relacionado para agrupar IDs de eventos; quando o ID do evento relacionado é 0, o evento é marcado como não relacionado a nenhum outro evento,
  • urgência; por padrão, não urgente.

Detalhes
Parâmetros
[in] inSchema
Esquema que define a importância, o ID do perfil e o tipo de estrutura deste evento.
[in] inEventWriter
O retorno de chamada a ser invocado para serializar de fato os dados do evento
[in] inAppData
Contexto do aplicativo para o retorno de chamada.
[in] inOptions
As opções para os metadados do evento. Pode ser NULL.
Devoluções
event_id_t O ID do evento se o evento foi gravado no log, 0 caso contrário.

LogFreeform

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

LogFreeform emite uma string de forma livre para o fluxo de eventos padrão.

A string será encapsulada em uma estrutura de evento de depuração, estruturalmente idêntica a outras strings registradas. O ID do perfil do evento será o de um evento Nest Debug e o tipo de evento será kNestDebug_StringLogEntryEvent .

Detalhes
Parâmetros
[in] inImportance
Importância da entrada do log; se a importância cair abaixo da importância atual, o evento não é realmente registrado
[in] inFormat
string de formato compatível com printf , seguida por argumentos a serem formatados
Devoluções
event_id_t O ID do evento se o evento foi gravado no log, 0 caso contrário.

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
)

Uma função auxiliar para emitir um texto de forma livre como um evento de depuração.

O evento de depuração é uma estrutura com um logregion e um texto de forma livre.

Detalhes
Parâmetros
[in,out] ioWriter
O escritor a ser usado para escrever o evento
[in] appData
Um ponteiro para DebugLogContext , uma estrutura que contém um formato de string, argumentos e uma região de log
[in] inDataTag
Uma tag de contexto para o TLV que estamos escrevendo. Não usado aqui, mas exigido pelo typedef para EventWriterFunct.
Valores Retornados
WEAVE_NO_ERROR
Com sucesso.
other
Outros erros que podem ser retornados do ioWriter.

PlainTextWriter

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

Uma função auxiliar para emitir um texto de forma livre como um evento de depuração.

O evento de depuração é uma estrutura com um logregion e um texto de forma livre.

Detalhes
Parâmetros
[in,out] ioWriter
O escritor a ser usado para escrever o evento
[in] inDataTag
A tag a ser emitida
[in] appData
Um ponteiro para DebugLogContext , uma estrutura que contém um formato de string, argumentos e uma região de log
Valores Retornados
WEAVE_NO_ERROR
Com sucesso.
other
Outros erros que podem ser retornados do ioWriter.

operador! =

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

operador ==

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