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

Essa é uma classe abstrata.

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

A classe auxiliar ProfileDatabase abstrata.

Resumo

O WDM separa a implementação do protocolo da implementação do gerenciamento de dados e, pelo menos em princípio, deixa a maior parte do segundo para o desenvolvedor do aplicativo. Todas as chamadas interessantes no WDM e todos os métodos abstratos que o desenvolvedor do perfil precisa implementar usam listas de caminhos ou listas de dados codificadas por TLV. Isso sobrecarrega os desenvolvedores de perfil e, na prática, causa muita duplicação de código, depois que o desenvolvedor escreve o mesmo código para compactar e descompactar o TLV e assim por diante. Para facilitar um pouco as coisas, fornecemos um tipo de "kit de ferramentas de gerenciamento de dados".

Essa classe auxiliar fornece suporte para o armazenamento e a recuperação de dados, desde que as subclasses ProfileData concretas necessárias tenham sido fornecidas e adicionadas ao método LookupProfileData() abaixo.

Funções públicas

LookupDataFromProfileDescriptor(nl::Weave::TLV::TLVReader & aDescReader, ProfileData **aProfileData)
Encontre um objeto ProfileData no banco de dados.
LookupProfileData(nl::Weave::TLV::TLVReader & aPathReader, ProfileData **aProfileData)
Encontre um objeto ProfileData no banco de dados.
LookupProfileData(uint32_t aProfileId, nl::Weave::TLV::TLVReader *aInstanceIdRdr, ProfileData **aResult)=0
virtual WEAVE_ERROR
Procure um objeto ProfileData.
Retrieve(ReferencedTLVData & aPathList, ReferencedTLVData & aDataList)
Recupere uma lista de dados com base em uma lista de caminhos.
Retrieve(ReferencedTLVData & aPathList, nl::Weave::TLV::TLVWriter & aWriter)
Escreva uma lista de dados com base em uma lista de caminhos.
Store(ReferencedTLVData & aDataList)
Armazenar uma lista de dados.

Funções protegidas

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

Classes

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

A classe interna auxiliar ProfileData abstrata.

Funções públicas

LookupDataFromProfileDescriptor

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

Encontre um objeto ProfileData no banco de dados.

Esse método de utilitário é usado para localizar objetos ProfileData em um determinado ProfileDatabase. Ela depende em grande parte dos métodos de pesquisa fornecidos pelo implementador da subclasse ProfileDatabase concreta.

Detalhes
Parâmetros
[in] aDescReader
Uma referência a um leitor TLV posicionado em um caminho WDM, ou seja, um caminho TLV que tem, como primeiro elemento, uma descrição de perfil.
[out] aProfileData
Um ponteiro destinado a retornar um ponteiro para o objeto de interesse ProfileData.
Retornos
WEAVE_NO_ERROR em caso de sucesso. Caso contrário, retorna WEAVE_ERROR, indicando uma falha ao procurar um objeto ProfileData correspondente.

LookupProfileData

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

Encontre um objeto ProfileData no banco de dados.

Esse método de utilitário é usado para localizar objetos ProfileData em um determinado ProfileDatabase. Ela depende em grande parte dos métodos de pesquisa fornecidos pelo implementador da subclasse ProfileDatabase concreta.

Detalhes
Parâmetros
[in] aPathReader
Uma referência a um leitor TLV posicionado em um caminho WDM, ou seja, um caminho TLV que tem, como primeiro elemento, uma descrição de perfil.
[out] aProfileData
Um ponteiro destinado a retornar um ponteiro para o objeto de interesse ProfileData.
Retornos
WEAVE_NO_ERROR em caso de sucesso. Caso contrário, retorna WEAVE_ERROR, indicando uma falha ao procurar um objeto ProfileData correspondente.

LookupProfileData

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

Procure um objeto ProfileData.

Procure um objeto ProfileData específico considerando um ID de perfil e um ID de instância (opcional)< fornecido como um leitor TLV.

Detalhes
Parâmetros
[in] aProfileId
O número do perfil de 32 bits do perfil de interesse.
[in] aInstanceIdRdr
Um ponteiro para um leitor TLV posicionado nos dados do identificador da instância. Se nenhum identificador de instância tiver sido fornecido, o valor será NULL.
[out] aResult
Um ponteiro destinado a retornar um ponteiro para o objeto de interesse ProfileData.
Retornos
WEAVE_NO_ERROR Se tiver êxito. Caso contrário, retorna um WEAVE_ERROR que reflete uma incapacidade de encontrar um objeto ProfileData.

Recuperar

WEAVE_ERROR Retrieve(
  ReferencedTLVData & aPathList,
  ReferencedTLVData & aDataList
)

Recupere uma lista de dados com base em uma lista de caminhos.

Dada uma lista de caminhos, recupere uma lista de dados contendo elementos da lista de dados para cada caminho na lista de caminhos, e os dados que são o terminal desse caminho.

Detalhes
Parâmetros
[in] aPathList
Uma referência a um objeto ReferencedTLVData contendo uma lista codificada em TLV de caminhos que representam os dados a serem recuperados. Esse parâmetro é mantido constante durante a execução da função.
[out] aDataList
Uma referência a um objeto ReferencedTLVData em que os resultados recuperados são gravados. O tamanho dos dados é ajustado somente após a execução bem-sucedida dessa função.
Retornos
WEAVE_NO_ERROR Se tiver êxito. Caso contrário, retorne um WEAVE_ERROR que indique uma falha na recuperação da lista de dados de interesse.

Recuperar

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

Escreva uma lista de dados com base em uma lista de caminhos.

Com uma lista de caminhos e um gravador TLV, crie uma lista de dados contendo elementos da lista de dados para cada caminho e os dados que são o terminal desse caminho.

Detalhes
Parâmetros
[in] aPathList
Uma referência a um objeto ReferencedTLVData contendo uma lista de caminhos TLV que representam os dados a serem recuperados. Esse parâmetro é mantido constante durante a execução da função.
[in] aWriter
Uma referência ao gravador TLV para usar para gravar a lista de caminhos recuperada. O estado interno do gravador pode ser irrecuperável em caso de erro.
Retornos
WEAVE_NO_ERROR Se tiver êxito. Caso contrário, retorne um WEAVE_ERROR que indique uma falha ao recuperar os dados ou gravar a lista de dados de interesse.

Loja

WEAVE_ERROR Store(
  ReferencedTLVData & aDataList
)

Armazenar uma lista de dados.

Com uma lista de dados codificada em TLV, esse método passa pelo processo de análise da lista e de chamada aos métodos concretos fornecidos pelos implementadores de subclasse ProfileDatabase para colocar os dados referenciados onde eles pertencem.

Detalhes
Parâmetros
[in] aDataList
Uma referência a um objeto ReferencedTLVData contendo os dados de interesse no formato codificado pelo TLV.
Retornos
WEAVE_NO_ERROR Se tiver êxito. Caso contrário, retorne um WEAVE_ERROR que indique uma falha no armazenamento dos dados de interesse.

Funções protegidas

StoreInternal

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