nl::Weave::Profiles::DataManagement_Legacy::ProfileDatabase

Esta es una clase abstracta.

#include <src/lib/profiles/data-management/Legacy/ProfileDatabase.h>

La clase auxiliar abstracta ProfileDatabase.

Resumen

WDM separa la implementación del protocolo de la implementación de la administración de datos y, al menos en el principio, deja la mayor parte de esta última tarea en manos del desarrollador de la aplicación. Todas las llamadas interesantes en WDM y todos los métodos abstractos que el desarrollador de perfiles debe implementar toman las listas de rutas de acceso con codificación TLV o las listas de datos. Esto supone una carga para los desarrolladores de perfiles y, en la práctica, causará muchas duplicaciones de código que el desarrollador después de escribir el mismo código para empaquetar y descomprimir TLV, y así sucesivamente. Para facilitar las cosas, ofrecemos una especie de "kit de herramientas de administración de datos".

Esta clase auxiliar proporciona compatibilidad para almacenar y recuperar datos, siempre que se hayan suministrado las subclases concretas de ProfileData y se hayan agregado al método LookupProfileData() a continuación.

Funciones públicas
LookupDataFromProfileDescriptor(nl::Weave::TLV::TLVReader & aDescReader, ProfileData **aProfileData)
Busca un objeto ProfileData en la base de datos.
LookupProfileData(nl::Weave::TLV::TLVReader & aPathReader, ProfileData **aProfileData)
Busca un objeto ProfileData en la base de datos.
LookupProfileData(uint32_t aProfileId, nl::Weave::TLV::TLVReader *aInstanceIdRdr, ProfileData **aResult)=0
virtual WEAVE_ERROR
Busca un objeto ProfileData.
Retrieve(ReferencedTLVData & aPathList, ReferencedTLVData & aDataList)
Recuperar una lista de datos según una lista de rutas de acceso.
Retrieve(ReferencedTLVData & aPathList, nl::Weave::TLV::TLVWriter & aWriter)
Escribir una lista de datos a partir de una lista de rutas de acceso.
Store(ReferencedTLVData & aDataList)
Almacena una lista de datos.

Funciones protegidas
StoreInternal(nl::Weave::TLV::TLVReader & aPathReader, uint64_t aVersion, nl::Weave::TLV::TLVReader & aDataReader)

Clases
nl::Weave::Profiles::DataManagement_Legacy::ProfileDatabase::ProfileData

La clase interna auxiliar abstracta ProfileData.

Funciones públicas

LookupDataFromProfileDescriptor

WEAVE_ERROR LookupDataFromProfileDescriptor(
  nl::Weave::TLV::TLVReader & aDescReader,
  ProfileData **aProfileData
)

Busca un objeto ProfileData en la base de datos.

Este método de utilidad se usa para encontrar objetos ProfileData en una ProfileDatabase específica. Depende en gran medida de los métodos de búsqueda que proporciona el implementador de la subclase concreta ProfileDatabase.

Detalles
Parámetros
[in] aDescReader
Es una referencia a un lector de TLV posicionado en una ruta de WDM, es decir, una ruta de acceso de TLV que tiene, como primer elemento, una descripción de perfil.
[out] aProfileData
Un puntero, diseñado para mostrar un puntero al objeto ProfileData de interés.
Qué muestra
WEAVE_NO_ERROR si se ejecuta de forma correcta; de lo contrario, muestra un WEAVE_ERROR que indica un error al buscar un objeto ProfileData que coincida.

LookupProfileData

WEAVE_ERROR LookupProfileData(
  nl::Weave::TLV::TLVReader & aPathReader,
  ProfileData **aProfileData
)

Busca un objeto ProfileData en la base de datos.

Este método de utilidad se usa para encontrar objetos ProfileData en una ProfileDatabase específica. Depende en gran medida de los métodos de búsqueda que proporciona el implementador de la subclase concreta ProfileDatabase.

Detalles
Parámetros
[in] aPathReader
Es una referencia a un lector de TLV posicionado en una ruta de WDM, es decir, una ruta de acceso de TLV que tiene, como primer elemento, una descripción de perfil.
[out] aProfileData
Un puntero, diseñado para mostrar un puntero al objeto ProfileData de interés.
Qué muestra
WEAVE_NO_ERROR si se ejecuta de forma correcta; de lo contrario, muestra un WEAVE_ERROR que indica un error al buscar un objeto ProfileData que coincida.

LookupProfileData

virtual WEAVE_ERROR LookupProfileData(
  uint32_t aProfileId,
  nl::Weave::TLV::TLVReader *aInstanceIdRdr,
  ProfileData **aResult
)=0

Busca un objeto ProfileData.

Busca un objeto ProfileData específico con un ID de perfil y un ID de instancia (opcional) proporcionado como un lector de TLV.

Detalles
Parámetros
[in] aProfileId
Es el número de perfil de 32 bits del perfil de interés.
[in] aInstanceIdRdr
Un puntero para un lector de TLV ubicado en los datos del identificador de instancia. Si no se proporcionó un identificador de instancia, el valor será NULL.
[out] aResult
Un puntero, diseñado para mostrar un puntero al objeto ProfileData de interés.
Qué muestra
WEAVE_NO_ERROR Si la operación es exitosa. De lo contrario, muestra un WEAVE_ERROR que refleja la incapacidad para encontrar un objeto ProfileData.

Recuperar

WEAVE_ERROR Retrieve(
  ReferencedTLVData & aPathList,
  ReferencedTLVData & aDataList
)

Recuperar una lista de datos según una lista de rutas de acceso.

Con una lista de rutas de acceso, recupera una lista de datos que contenga elementos de lista de datos para cada ruta en la lista de los datos que son la terminal de esa ruta.

Detalles
Parámetros
[in] aPathList
Una referencia a un objeto ReferencedTLVData que contiene una lista codificada en TLV de rutas de acceso que representan datos para recuperar. Este parámetro se mantiene constante durante la ejecución de esta función.
[out] aDataList
Una referencia a un objeto ReferencedTLVData en la que se escriben los resultados recuperados. La longitud de los datos se ajusta solo después de la ejecución correcta de esta función.
Qué muestra
WEAVE_NO_ERROR Si la operación es exitosa. De lo contrario, muestra un WEAVE_ERROR que indica que no se pudo recuperar la lista de datos de interés.

Recuperar

WEAVE_ERROR Retrieve(
  ReferencedTLVData & aPathList,
  nl::Weave::TLV::TLVWriter & aWriter
)

Escribir una lista de datos a partir de una lista de rutas de acceso.

Con una lista de rutas de acceso y un escritor TLV, escribe una lista de datos que contenga los elementos de lista de datos para cada ruta de acceso en la lista de ruta de acceso y los datos que son la terminal de esa ruta.

Detalles
Parámetros
[in] aPathList
Es una referencia a un objeto ReferencedTLVData que contiene una lista de rutas de acceso de TLV que representan los datos que se recuperarán. Este parámetro se mantiene constante durante la ejecución de esta función.
[in] aWriter
Una referencia al escritor TLV para escribir la lista de rutas de acceso recuperadas. El estado interno del escritor podría ser irrecuperable en caso de un error.
Qué muestra
WEAVE_NO_ERROR Si la operación es exitosa. De lo contrario, muestra un WEAVE_ERROR que indica que no se pudieron recuperar los datos o escribir la lista de datos de interés.

Almacenar

WEAVE_ERROR Store(
  ReferencedTLVData & aDataList
)

Almacena una lista de datos.

Dada una lista de datos codificada con TLV, este método pasa por el proceso de analizar esa lista y llamar a los métodos concretos que proporcionan los implementadores de subclase ProfileDatabase para colocar los datos referenciados donde pertenecen.

Detalles
Parámetros
[in] aDataList
Una referencia a un objeto ReferencedTLVData que contiene los datos de interés en formato codificado con TLV.
Qué muestra
WEAVE_NO_ERROR Si la operación es exitosa. De lo contrario, muestra un WEAVE_ERROR que indica un error en el almacenamiento de los datos de interés.

Funciones protegidas

StoreInternal

WEAVE_ERROR StoreInternal(
  nl::Weave::TLV::TLVReader & aPathReader,
  uint64_t aVersion,
  nl::Weave::TLV::TLVReader & aDataReader
)