nl :: Tejido:: Perfiles: DataManagement_Current
Este espacio de nombres incluye todas las interfaces dentro de Weave para el perfil Weave Data Management (WDM) que actualmente son compatibles para uso de producción.
Resumen
Typedefs | |
---|---|
CommandFlags | typedef |
DataVersion | typedefuint64_t |
EventProcessor | typedefvoid * |
EventWriterFunct )(nl::Weave::TLV::TLVWriter &ioWriter, uint8_t inDataTag, void *appData) | typedefWEAVE_ERROR (* Una función que proporciona el elemento eventData para el subsistema de registro de eventos. |
FetchExternalEventsFunct )(EventLoadOutContext *aContext) | typedefWEAVE_ERROR (* Un prototipo de función para devoluciones de llamada de plataforma que obtienen datos de eventos. |
GenericTraitSinkCatalog | typedef |
GenericTraitSourceCatalog | typedef |
ImportanceType | typedef La importancia de la entrada del registro. |
IteratorCallback )(void *aTraitInstance, TraitDataHandle aHandle, void *aContext) | typedefvoid(* Iterador de control de rasgo. |
LoggingBufferHandler )(void *inAppState, PacketBuffer *inBuffer) | typedefWEAVE_ERROR (* |
NotifyExternalEventsDeliveredFunct )(ExternalEvents *inEv, event_id_t inLastDeliveredEventID, uint64_t inRecipientNodeID) | typedefvoid(* Un prototipo de función para una devolución de llamada que se invoca cuando se envían eventos externos al suscriptor remoto. |
NotifyExternalEventsEvictedFunct )(ExternalEvents *inEv) | typedefvoid(* Un prototipo de función para una devolución de llamada que se invoca cuando se expulsan eventos externos de los búferes. |
PropertyDictionaryKey | typedefuint16_t |
PropertyPathHandle | typedefuint32_t Un PropertyPathHandle es un hash numérico único de 32 bits de una ruta WDM relativa a la raíz de una instancia de rasgo. |
PropertySchemaHandle | typedefuint16_t |
SchemaVersion | typedefuint16_t |
SingleResourceSinkTraitCatalog | typedef |
SingleResourceSourceTraitCatalog | typedef |
TimestampType | typedef La validez y el tipo de marca de tiempo incluida en EventOptions . |
TraitDataHandle | typedefuint16_t |
duration_t | nl :: Weave :: Profiles :: DataManagement_Current :: duration_tuint32_t Tipo utilizado para describir la duración, en milisegundos. |
event_id_t | nl :: Weave :: Perfiles :: DataManagement_Current :: event_id_tuint32_t El tipo de ID de evento. |
timestamp_t | nl :: Weave :: Profiles :: DataManagement_Current :: timestamp_tuint32_t Tipo utilizado para describir la marca de tiempo en milisegundos. |
utc_timestamp_t | nl :: Weave :: Profiles :: DataManagement_Current :: utc_timestamp_tuint64_t Tipo utilizado para describir la marca de tiempo UTC en milisegundos. |
Variables | |
---|---|
sInstance | |
sLogFileName = "topazlog"[] | char |
Funciones | |
---|---|
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) | Una función auxiliar que traduce un elemento eventdata ya serializado al búfer 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 es una implementación optimizada del algoritmo para comparar versiones. |
IsVersionNewerOrEqual (const DataVersion & aVersion, const DataVersion & aReference) | bool |
Locate (TraitDataHandle aTraitDataHandle, const TraitCatalogBase < TraitDataSink > *aDataSinkCatalog) | Función de utilidad que encuentra un TraitUpdatableDataSink en un catálogo de TraitDataSink . |
LogEvent (const EventSchema & inSchema,nl::Weave::TLV::TLVReader & inData) | Registre un evento desde un formulario previamente serializado. |
LogEvent (const EventSchema & inSchema,nl::Weave::TLV::TLVReader & inData, const EventOptions *inOptions) | Registre un evento desde un formulario previamente serializado, con opciones adicionales. |
LogEvent (const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData) | Registre un evento a través de una devolución de llamada. |
LogEvent (const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData, const EventOptions *inOptions) | Registre un evento a través de una devolución de llamada, con opciones. |
LogFreeform ( ImportanceType inImportance, const char *inFormat, ...) | LogFreeform emite una cadena de forma libre al flujo de eventos predeterminado. |
LookForElementWithTag (constnl::Weave::TLV::TLVReader & aSrcReader, const uint64_t aTagInApiForm,nl::Weave::TLV::TLVReader *apDstReader) | |
PlainTextWriter (TLVWriter & ioWriter, uint8_t inDataTag, void *appData) | Una función auxiliar para emitir un texto de forma libre como evento de depuración. |
PlainTextWriter (::nl::Weave::TLV::TLVWriter & ioWriter, uint8_t inDataTag, void *appData) | Una función auxiliar para emitir un texto de forma libre como evento de depuración. |
operator!= (const ResourceIdentifier & lhs, const ResourceIdentifier & rhs) | bool |
operator== (const ResourceIdentifier & lhs, const ResourceIdentifier & rhs) | bool |
Sindicatos | |
---|---|
nl :: Weave :: Profiles :: DataManagement_Current :: Marca de tiempo | La unión que proporciona un sistema de conjunto de aplicaciones o marca de tiempo UTC. |
Enumeraciones
@ 100
@100
@ 101
@101
@ 102
@102
Etiquetas para eventos persistentes.
@ 104
@104
Los tipos de mensajes del perfil WDM.
Estos valores se indican en la especificación de gestión de datos.
@ 105
@105
Códigos de estado específicos de WDM.
@ 147
@147
@ 95
@95
Etiquetas de configuración de registro .
@ 96
@96
Etiquetas para capacidades de registro.
@ 97
@97
Etiquetas para metadatos de eventos.
Para conocer la semántica completa de los valores de las etiquetas, consulte la Especificación de diseño de eventos.
Propiedades | |
---|---|
kTag_EventData | Opcional. Datos del evento en sí. Si está vacío, por defecto es una estructura vacía. |
kTag_EventDeltaSystemTime | Etiqueta interna WDM, diferencia horaria del evento anterior en la codificación. |
kTag_EventDeltaUTCTime | Etiqueta interna WDM, diferencia horaria del evento anterior en la codificación. |
kTag_EventID | Número de secuencia del evento, expresado como una cantidad sin firmar de 64 bits. Debe ser secuencial, los saltos en la secuencia indican brechas de eventos. |
kTag_EventImportance | Importancia del evento. |
kTag_EventResourceID | Opcional. El valor es el ID del recurso al que pertenece el evento. Cuando se omite, el valor es el mismo que el valor de kTag_EventSource |
kTag_EventSource | NodeID del dispositivo que generó el evento. |
kTag_EventSystemTimestamp | Opcional. Marca de tiempo del sistema del evento en milisegundos. |
kTag_EventTraitInstanceID | Opcional, la instancia del rasgo que generó el evento. |
kTag_EventTraitProfileID | Obligatorio. Entero sin signo de 32 bits que es igual al ProfileID del rasgo. |
kTag_EventType | Obligatorio. Entero sin signo de 16 bits que es igual al wdl.event.id para este tipo de evento. |
kTag_EventUTCTimestamp | |
kTag_ExternalEventStructure | Etiqueta interna para eventos externos. Nunca se transmite a través del cable, nunca debe usarse fuera de la biblioteca Weave. |
kTag_RelatedEventID | Opcional. ID de un evento con el que está relacionado este evento. Si se omite, el valor es igual al valor de kTag_EventID. |
kTag_RelatedEventImportance | Opcional. Importancia del evento relacionado. Si se omite, el valor es igual al valor de kTag_EventImportance. |
@ 98
@98
Definiciones de perfil para el rasgo de depuración.
@ 99
@99
Tipos de eventos para el rasgo Nest Debug.
CommandFlags
CommandFlags
ImportanceType
ImportanceType
La importancia de la entrada del registro.
La importancia se utiliza como una forma de filtrar eventos antes de que se emitan en el registro. Una vez que el evento está en el registro, no tomamos más medidas para eliminarlo del registro. El nivel de importancia sirve para priorizar el almacenamiento de eventos. Si se agrega un evento de gran importancia a un búfer completo, los eventos se eliminan en orden de importancia (y antigüedad) para acomodarlo. Como tal, los niveles de importancia solo tienen valor relativo. Si un sistema usa solo un nivel de importancia, los eventos se eliminan solo por orden de antigüedad, como un búfer circular.
LoggingManagementStates
LoggingManagementStates
Typedefs
CommandFlags
enum nl::Weave::Profiles::DataManagement_Current::CommandFlags CommandFlags
DataVersion
uint64_t DataVersion
Procesador de eventos
void * EventProcessor
EventWriterFunct
WEAVE_ERROR(* EventWriterFunct)(nl::Weave::TLV::TLVWriter &ioWriter, uint8_t inDataTag, void *appData)
Una función que proporciona el elemento eventData para el subsistema de registro de eventos.
Se espera que las funciones de este tipo proporcionen el elemento eventData para el subsistema de registro de eventos. Las funciones de este tipo se llaman después de que el subsistema de eventos haya generado todos los metadatos de eventos requeridos. La función se llama con un objetonl :: Weave :: TLV :: TLVWriter en el que emitirá un solo elemento TLV etiquetado como kTag_EventData; el valor de ese elemento DEBE ser una estructura que contenga los datos del evento. Los datos del evento en sí deben estructurarse mediante etiquetas de contexto.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
PlainTextWriter
EventWriterTLVCopy
FetchExternalEventsFunct
WEAVE_ERROR(* FetchExternalEventsFunct)(EventLoadOutContext *aContext)
Un prototipo de función para devoluciones de llamada de plataforma que obtienen datos de eventos.
Similar a FetchEventsSince, esta función de recuperación devuelve todos los eventos de EventLoadOutContext.mStartingEventID a ExternalEvents.mLastEventID .
El puntero de contexto es de tipo FetchExternalEventsContext. Esto incluye EventLoadOutContext , con algunas variables auxiliares para el formato del TLV . También incluye un puntero a la estructura ExternalEvents creada en el registro de la devolución de llamada. Esto especifica el rango de ID de evento para la devolución de llamada.
Al regresar de la función, EventLoadOutContext.mCurrentEventID debe reflejar el primer ID de evento que no se ha escrito correctamente en el búfer TLV . La plataforma debe escribir el encabezado y los datos de los eventos en el escritor de TLV en el formato correcto, especificado por el protocolo EventLogging. La plataforma también debe mantener la singularidad de los eventos y las marcas de tiempo.
Todos los errores de TLV deben propagarse a niveles superiores. Por ejemplo, quedarse sin espacio en el búfer activará un mensaje enviado, seguido de otra llamada a la devolución de llamada con el ID de evento que quede.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Valores devueltos |
|
GenéricoTraitSinkCatálogo
GenericTraitCatalogImpl< TraitDataSink > GenericTraitSinkCatalog
GenericTraitSourceCatalog
GenericTraitCatalogImpl< TraitDataSource > GenericTraitSourceCatalog
ImportanceType
enum nl::Weave::Profiles::DataManagement_Current::ImportanceType ImportanceType
La importancia de la entrada del registro.
La importancia se utiliza como una forma de filtrar eventos antes de que se emitan en el registro. Una vez que el evento está en el registro, no tomamos más disposiciones para eliminarlo del registro. El nivel de importancia sirve para priorizar el almacenamiento de eventos. Si se agrega un evento de gran importancia a un búfer completo, los eventos se eliminan en orden de importancia (y antigüedad) para acomodarlo. Como tal, los niveles de importancia solo tienen un valor relativo. Si un sistema usa solo un nivel de importancia, los eventos se eliminan solo por orden de antigüedad, como un búfer circular.
IteratorCallback
void(* IteratorCallback)(void *aTraitInstance, TraitDataHandle aHandle, void *aContext)
Iterador de control de rasgo.
LoggingBufferHandler
WEAVE_ERROR(* LoggingBufferHandler)(void *inAppState, PacketBuffer *inBuffer)
NotifyExternalEventsDeliveredFunct
void(* NotifyExternalEventsDeliveredFunct)(ExternalEvents *inEv, event_id_t inLastDeliveredEventID, uint64_t inRecipientNodeID)
Un prototipo de función para una devolución de llamada que se invoca cuando se envían eventos externos al suscriptor remoto.
Cuando los eventos externos se envían a un suscriptor remoto, el motor proporcionará una notificación al proveedor de eventos externos. La devolución de llamada contiene el evento del último ID que se entregó y el ID del suscriptor que recibió el evento.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
|
NotifyExternalEventsEvictedFunct
void(* NotifyExternalEventsEvictedFunct)(ExternalEvents *inEv)
Un prototipo de función para una devolución de llamada que se invoca cuando se expulsan eventos externos de los búferes.
Cuando el objeto de eventos externos se desaloja del búfer de mensajes salientes, el motor proporcionará una notificación al proveedor de eventos externos. La devolución de llamada contiene el evento externo que se va a desalojar.
Detalles | |||
---|---|---|---|
Parámetros |
|
PropertyDictionaryKey
uint16_t PropertyDictionaryKey
PropertyPathHandle
uint32_t PropertyPathHandle
Un PropertyPathHandle es un hash numérico único de 32 bits de una ruta WDM relativa a la raíz de una instancia de rasgo.
Tiene dos partes:
- Un número inferior de 16 bits que se asigna a la parte estática del esquema.
- Cuando los 16 bits inferiores se refieren a una ruta dentro de un elemento del diccionario, hay un número superior de 16 bits que representa la clave del diccionario asociada con ese elemento. Si los 16 bits inferiores se refieren a un elemento que no es del diccionario, entonces los 16 bits superiores deben ser 0.
Algunas caracteristicas:
- Cada rasgo tiene su propio espacio de manejo de ruta de propiedad.
- Cada ruta de acceso secundaria WDM única tendrá un PropertyPathHandle igualmente único.
- PropertyPathHandles se genera automáticamente (hecho a mano por ahora) por un compilador de rasgos de IDL y se representa como una lista de enumeradores en el archivo de encabezado del rasgo correspondiente.
- Con esta construcción, la lógica de la aplicación nunca tiene que tratar directamente con las rutas WDM. Más bien, sus interacciones con WDM se llevan a cabo exclusivamente a través de estos identificadores.
- Hay dos valores reservados para los identificadores de ruta que tienen un significado específico:
- 0 indica un identificador 'NULL'
- 1 indica un identificador que apunta a la raíz de la instancia del rasgo.
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
La validez y el tipo de marca de tiempo incluida en EventOptions .
TraitDataHandle
uint16_t TraitDataHandle
duración_t
uint32_t duration_t
Tipo utilizado para describir la duración, en milisegundos.
event_id_t
uint32_t event_id_t
El tipo de ID de evento.
timestamp_t
uint32_t timestamp_t
Tipo utilizado para describir la marca de tiempo en milisegundos.
utc_timestamp_t
uint64_t utc_timestamp_t
Tipo utilizado para describir la marca de tiempo UTC en milisegundos.
Variables
sInstance
LoggingManagement sInstance
sLogFileName
char sLogFileName[] = "topazlog"
Funciones
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 )
Una función auxiliar que traduce un elemento eventdata ya serializado al búfer de eventos.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
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 es una implementación optimizada del algoritmo para comparar versiones.
Del lado del cliente, una versión recibida del servicio es siempre la más reciente.
IsVersionNewerOrEqual
bool IsVersionNewerOrEqual( const DataVersion & aVersion, const DataVersion & aReference )
Localizar
TraitUpdatableDataSink * Locate( TraitDataHandle aTraitDataHandle, const TraitCatalogBase< TraitDataSink > *aDataSinkCatalog )
Función de utilidad que encuentra un TraitUpdatableDataSink en un catálogo de TraitDataSink .
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Devoluciones | Un puntero al TraitUpdatableDataSink ; NULL si el identificador no existe o apunta a un TraitDataSink no actualizable. |
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData )
Registre un evento desde un formulario previamente serializado.
La función registra un evento representado comonl :: Weave :: TLV :: TLVReader . Esto implica que la representación de datos de eventos ya está serializada en el almacenamiento subyacente anl :: Weave :: TLV :: TLVReader . Se espera quenl :: Weave :: TLV :: TLVReader contenga al menos un único elemento de datos, ese elemento debe ser una estructura. El primer elemento leído del lector se trata como datos de eventos y se almacena en el registro de eventos. Los datos del evento DEBEN contener etiquetas de contexto para ser interpretadas dentro del esquema identificado por inProfileID e inEventType. Se ignorará la etiqueta del primer elemento; el sistema de registro de eventos lo reemplazará con la etiqueta eventData.
El evento se registra si su inImportance excede el umbral de registro especificado en LoggingConfiguration . Si la importancia del evento no alcanza el umbral actual, se descarta y la función devuelve un 0
como ID del evento resultante.
Esta variante de la invocación especifica implícitamente todas las opciones de eventos predeterminadas:
- el evento tiene una marca de tiempo con la hora actual en el momento de la llamada,
- el evento está marcado como relacionado con el dispositivo que está haciendo la llamada,
- el evento es independiente, no se relaciona con ningún otro evento,
- el evento está marcado como no urgente,
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Devoluciones | event_id_t El ID del evento si el evento se escribió en el registro, 0 en caso contrario. |
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, nl::Weave::TLV::TLVReader & inData, const EventOptions *inOptions )
Registre un evento desde un formulario previamente serializado, con opciones adicionales.
La función registra un evento representado comonl :: Weave :: TLV :: TLVReader . Esto implica que la representación de datos de eventos ya está serializada en el almacenamiento subyacente anl :: Weave :: TLV :: TLVReader . Se espera quenl :: Weave :: TLV :: TLVReader contenga al menos un único elemento de datos, ese elemento debe ser una estructura. El primer elemento leído del lector se trata como datos de eventos y se almacena en el registro de eventos. Los datos del evento DEBEN contener etiquetas de contexto para ser interpretadas dentro del esquema identificado por inProfileID e inEventType. Se ignorará la etiqueta del primer elemento; el sistema de registro de eventos lo reemplazará con la etiqueta eventData.
El evento se registra si su inImportance excede el umbral de registro especificado en LoggingConfiguration . Si la importancia del evento no alcanza el umbral actual, se descarta y la función devuelve un 0
como ID de evento resultante.
Esta variante de la invocación permite a la persona que llama establecer cualquier combinación de EventOptions
:
- marca de tiempo, cuando 0 por defecto es la hora actual en el punto de la llamada,
- sección "raíz" del origen del evento (origen del evento e ID de rasgo); si es NULL, toma como valor predeterminado el dispositivo actual. el evento está marcado como relacionado con el dispositivo que está haciendo la llamada,
- un ID de evento relacionado para agrupar ID de eventos; cuando el ID de evento relacionado es 0, el evento se marca como no relacionado con ningún otro evento,
- urgencia; por defecto no urgente.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Devoluciones | event_id_t El ID del evento si el evento se escribió en el registro, 0 en caso contrario. |
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData )
Registre un evento a través de una devolución de llamada.
La función registra un evento representado como EventWriterFunct y un contexto appData
específico de la appData
. La función escribe los metadatos del evento y llama a inEventWriter
con una referencianl :: Weave :: TLV :: TLVWriter y inAppData
contexto inAppData
para que el código de usuario pueda emitir los datos del evento directamente en el registro de eventos. Esta forma de registro de eventos minimiza el consumo de memoria, ya que los datos de eventos se serializan directamente en el búfer de destino. Los datos del evento DEBEN contener etiquetas de contexto para ser interpretadas dentro del esquema identificado por inProfileID
e inEventType
. Se ignorará la etiqueta del primer elemento; el sistema de registro de eventos lo reemplazará con la etiqueta eventData.
El evento se registra si su inImportance excede el umbral de registro especificado en LoggingConfiguration . Si la importancia del evento no alcanza el umbral actual, se descarta y la función devuelve un 0
como ID del evento resultante.
Esta variante de la invocación especifica implícitamente todas las opciones de eventos predeterminadas:
- el evento tiene una marca de tiempo con la hora actual en el momento de la llamada,
- el evento está marcado como relacionado con el dispositivo que está haciendo la llamada,
- el evento es independiente, no se relaciona con ningún otro evento,
- el evento está marcado como no urgente,
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Devoluciones | event_id_t El ID del evento si el evento se escribió en el registro, 0 en caso contrario. |
LogEvent
event_id_t LogEvent( const EventSchema & inSchema, EventWriterFunct inEventWriter, void *inAppData, const EventOptions *inOptions )
Registre un evento a través de una devolución de llamada, con opciones.
La función registra un evento representado como EventWriterFunct y un contexto appData
específico de la appData
. La función escribe los metadatos del evento y llama a inEventWriter
con una referencianl :: Weave :: TLV :: TLVWriter y inAppData
contexto inAppData
para que el código de usuario pueda emitir los datos del evento directamente en el registro de eventos. Esta forma de registro de eventos minimiza el consumo de memoria, ya que los datos de eventos se serializan directamente en el búfer de destino. Los datos del evento DEBEN contener etiquetas de contexto para ser interpretadas dentro del esquema identificado por inProfileID
e inEventType
. Se ignorará la etiqueta del primer elemento; el sistema de registro de eventos lo reemplazará con la etiqueta eventData.
El evento se registra si su inImportance excede el umbral de registro especificado en LoggingConfiguration . Si la importancia del evento no alcanza el umbral actual, se descarta y la función devuelve un 0
como ID de evento resultante.
Esta variante de la invocación permite a la persona que llama establecer cualquier combinación de EventOptions
:
- marca de tiempo, cuando 0 por defecto es la hora actual en el punto de la llamada,
- sección "raíz" del origen del evento (origen del evento e ID de rasgo); si es NULL, toma el dispositivo actual de forma predeterminada. el evento está marcado como relacionado con el dispositivo que está haciendo la llamada,
- un ID de evento relacionado para agrupar ID de eventos; cuando el ID de evento relacionado es 0, el evento se marca como no relacionado con ningún otro evento,
- urgencia; por defecto no urgente.
Detalles | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parámetros |
| ||||||||
Devoluciones | event_id_t El ID del evento si el evento se escribió en el registro, 0 en caso contrario. |
Iniciar sesión
event_id_t LogFreeform( ImportanceType inImportance, const char *inFormat, ... )
LogFreeform emite una cadena de forma libre al flujo de eventos predeterminado.
La cadena se encapsulará en una estructura de eventos de depuración, estructuralmente idéntica a otras cadenas registradas. El ID del perfil del evento será el de un evento Nest Debug y el tipo de evento será kNestDebug_StringLogEntryEvent
.
Detalles | |||||
---|---|---|---|---|---|
Parámetros |
| ||||
Devoluciones | event_id_t El ID del evento si el evento se escribió en el registro, 0 en caso contrario. |
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 )
Una función auxiliar para emitir un texto de forma libre como evento de depuración.
El evento de depuración es una estructura con un logregion y un texto de forma libre.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
PlainTextWriter
WEAVE_ERROR PlainTextWriter( ::nl::Weave::TLV::TLVWriter & ioWriter, uint8_t inDataTag, void *appData )
Una función auxiliar para emitir un texto de forma libre como evento de depuración.
El evento de depuración es una estructura con un logregion y un texto de forma libre.
Detalles | |||||||
---|---|---|---|---|---|---|---|
Parámetros |
| ||||||
Valores devueltos |
|
operador! =
bool operator!=( const ResourceIdentifier & lhs, const ResourceIdentifier & rhs )
operador ==
bool operator==( const ResourceIdentifier & lhs, const ResourceIdentifier & rhs )