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
Typedefs | |
|---|---|
CommandFlags | typedef |
DataVersion | typedefuint64_t |
EventProcessor | typedefvoid * |
EventWriterFunct )(nl::Weave::TLV::TLVWriter &ioWriter, uint8_t inDataTag, void *appData) | typedefWEAVE_ERROR (* Uma função que fornece o elemento eventData para o subsistema de registro de eventos. |
FetchExternalEventsFunct )(EventLoadOutContext *aContext) | typedefWEAVE_ERROR (* Um protótipo de função para callbacks 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) | typedefvoid(* Iterador de identificador de traço. |
LoggingBufferHandler )(void *inAppState, PacketBuffer *inBuffer) | typedefWEAVE_ERROR (* |
NotifyExternalEventsDeliveredFunct )(ExternalEvents *inEv, event_id_t inLastDeliveredEventID, uint64_t inRecipientNodeID) | typedefvoid(* Um protótipo de função para um retorno de chamada invocado quando eventos externos são entregues ao assinante remoto. |
NotifyExternalEventsEvictedFunct )(ExternalEvents *inEv) | typedefvoid(* Um protótipo de função para um retorno de chamada invocado quando eventos externos são removidos dos buffers. |
PropertyDictionaryKey | typedefuint16_t |
PropertyPathHandle | typedefuint32_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 | typedefuint16_t |
SchemaVersion | typedefuint16_t |
SingleResourceSinkTraitCatalog | typedef |
SingleResourceSourceTraitCatalog | typedef |
TimestampType | typedef A validade eo tipo de timestamp incluído no EventOptions . |
TraitDataHandle | typedefuint16_t |
duration_t | nl :: Weave :: Profiles :: DataManagement_Current :: duration_tuint32_t Tipo usado para descrever a duração, em milissegundos. |
event_id_t | nl :: Weave :: Profiles :: DataManagement_Current :: event_id_tuint32_t O tipo de ID do evento. |
timestamp_t | nl :: Weave :: Profiles :: DataManagement_Current :: timestamp_tuint32_t Tipo usado para descrever o carimbo de data / hora em milissegundos. |
utc_timestamp_t | nl :: Weave :: Profiles :: DataManagement_Current :: utc_timestamp_tuint64_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 TraitDataSink catálogo. |
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 |
Sindicatos | |
|---|---|
| nl :: Weave :: Profiles :: DataManagement_Current :: Timestamp | A união que fornece um sistema de conjunto de aplicativos ou carimbo de data / hora UTC. |
Enumerações
@ 100
@100
@ 101
@101
@ 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
Registrando marcas Definições.
@ 96
@96
Marcas para recursos de registro.
@ 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. Sistema Timestamp 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. UTC Timestamp 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.
CommandFlags
CommandFlags
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.
LoggingManagementStates
LoggingManagementStates
Typedefs
CommandFlags
enum nl::Weave::Profiles::DataManagement_Current::CommandFlags CommandFlags
DataVersion
uint64_t DataVersion
EventProcessor
void * EventProcessor
EventWriterFunct
WEAVE_ERROR(* EventWriterFunct)(nl::Weave::TLV::TLVWriter &ioWriter, uint8_t inDataTag, void *appData)
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 umanl :: :: tecer TLV :: TLVWriter objecto em que se emite um único TLV elemento etiquetado 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 |
| ||||||
| Valores Retornados |
|
PlainTextWriter
EventWriterTLVCopy
FetchExternalEventsFunct
WEAVE_ERROR(* FetchExternalEventsFunct)(EventLoadOutContext *aContext)
Um protótipo de função para callbacks de plataforma que buscam dados de eventos.
Semelhante ao FetchEventsSince, este buscar função retorna todos os eventos do EventLoadOutContext.mStartingEventID através 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 os ExternalEvents struct criadas no registro da chamada de retorno. Isso especifica o intervalo de ID do evento para o retorno de chamada.
Ao retornar da função, EventLoadOutContext.mCurrentEventID deve refletir a primeira identificação de evento que não tenha sido gravado com êxito para o TLV buffer. A plataforma deve escrever o cabeçalho eventos e dados para o TLV escritor no formato correto, especificado pelo protocolo EventLogging. A plataforma também deve manter exclusividade de eventos e carimbos de data / hora.
Todos TLV erros devem ser propagadas para os níveis mais elevados. 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 |
|
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 sã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 |
|
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 |
|
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 eo tipo de timestamp incluído no 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 |
| ||||||
| Valores Retornados |
|
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 TraitDataSink catálogo.
| Detalhes | |||||
|---|---|---|---|---|---|
| Parâmetros |
| ||||
| Devoluções | Um apontador para a TraitUpdatableDataSink ; NULL se o identificador não existe ou ele aponta para um não atualizável TraitDataSink . |
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 . Isto implica que a representação de dados evento já é serializado no armazenamento subjacente aonl :: Weave :: TLV :: TLVReader . Onl :: :: tecer TLV :: TLVReader está prevista para conter pelo menos um único elemento de dados, que 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 o seu inImportance exceder o limite de registro especificado na LoggingConfiguration . Se a importância do evento não cumprir o limite atual, ele é descartado e a função retorna um 0 como o ID do evento que resultou.
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 |
| ||||
| 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 . Isto implica que a representação de dados evento já é serializado no armazenamento subjacente aonl :: Weave :: TLV :: TLVReader . Onl :: :: tecer TLV :: TLVReader está prevista para conter pelo menos um único elemento de dados, que 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 o seu inImportance exceder o limite de registro especificado na LoggingConfiguration . Se a importância do evento não cumprir o limite atual, ele é descartado e a função retorna um 0 como o ID do evento que resultou.
Esta variante da invocação permite o chamador para definir 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 |
| ||||||
| 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 um específico do aplicativo e appData contexto. A função escreve os metadados evento e chama o inEventWriter com umnl :: Weave :: TLV :: TLVWriter de referência e inAppData contexto para que o código de usuário pode 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 deve conter etiquetas de contexto devem ser 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 o seu inImportance exceder o limite de registro especificado na LoggingConfiguration . Se a importância do evento não cumprir o limite atual, ele é descartado e a função retorna um 0 como o ID do evento que resultou.
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 |
| ||||||
| 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 um específico do aplicativo e appData contexto. A função escreve os metadados evento e chama o inEventWriter com umnl :: Weave :: TLV :: TLVWriter de referência e inAppData contexto para que o código de usuário pode 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 deve conter etiquetas de contexto devem ser 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 o seu inImportance exceder o limite de registro especificado na LoggingConfiguration . Se a importância do evento não cumprir o limite atual, ele é descartado e a função retorna um 0 como o ID do evento que resultou.
Esta variante da invocação permite o chamador para definir 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 |
| ||||||||
| 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 evento será a de um evento Nest Debug, e o tipo de evento será kNestDebug_StringLogEntryEvent .
| Detalhes | |||||
|---|---|---|---|---|---|
| Parâmetros |
| ||||
| 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 uma região e um texto de forma livre.
| Detalhes | |||||||
|---|---|---|---|---|---|---|---|
| Parâmetros |
| ||||||
| Valores Retornados |
|
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 uma região e um texto de forma livre.
| Detalhes | |||||||
|---|---|---|---|---|---|---|---|
| Parâmetros |
| ||||||
| Valores Retornados |
|
operador! =
bool operator!=( const ResourceIdentifier & lhs, const ResourceIdentifier & rhs )
operador ==
bool operator==( const ResourceIdentifier & lhs, const ResourceIdentifier & rhs )