nl::Weave::TLV::TLVReader

Encontre o valor do byte atual ou do elemento de string UTF8.

Para determinar o tamanho de buffer de entrada necessário, chame o método GetLength() antes de chamar GetBytes().

Retorna o tipo de contêiner no qual o TLVReader está lendo no momento.

O método GetContainerType() retorna o tipo de contêiner TLV em que o TLVReader está lendo. Se o TLVReader for posicionado no nível mais externo de uma codificação TLV, ou seja, antes, no ou depois do elemento TLV externo, o método retornará kTLVType_Notspecified.

Retorna o byte de controle associado ao elemento TLV atual.

O ideal é que ninguém precise saber sobre o byte de controle, e somente a implementação interna do TLV deve ter acesso a ele. No entanto, ter acesso ao byte de controle é útil para fins de depuração pelos utilitários da TLVDebug (que tentam decodificar o byte de controle da tag ao imprimir o conteúdo do buffer TLV).

Receba um ponteiro para o byte codificado inicial de um elemento de string UTF8 ou byte TLV.

Esse método retorna um ponteiro direto para o valor da string codificada dentro do buffer de entrada subjacente. Para ter sucesso, o método exige que todo o valor da string esteja presente em um único buffer. Caso contrário, o método retornará WEAVE_ERROR_TLV_UNDERRUN. Isso faz com que o método de uso seja limitado ao ler dados de vários buffers descontínuos.

Retorna o comprimento dos dados associados ao elemento TLV atual.

O comprimento dos dados se aplica apenas a elementos do tipo string UTF8 ou string de bytes. Para strings UTF8, o valor retornado é o número de bytes na string, não o número de caracteres.

Retorna o número total de bytes lidos desde que o leitor foi inicializado.

Recebe o ponto no buffer de entrada subjacente que corresponde à posição atual do leitor.

Retorna o número total de bytes que podem ser lidos até que o tamanho máximo de leitura seja atingido.

Encontre o valor do byte atual ou do elemento de string UTF8 como uma string encerrada nula.

Para determinar o tamanho de buffer de entrada necessário, chame o método GetLength() antes de chamar GetBytes(). O buffer de entrada precisa ter pelo menos um byte maior que o tamanho da string para acomodar o caractere nulo.

Retorna a tag associada ao elemento TLV atual.

O valor retornado por GetTag() pode ser usado com as funções do utilitário de tag (IsProfileTag(), IsContextTag(), ProfileIdFromTag() etc.) para determinar o tipo de tag e extrair vários valores de campo da tag.

Retorna o tipo do elemento TLV atual.

Inicializa um objeto TLVReader de outro objeto TLVReader.

Inicializa um objeto TLVReader para ler um único buffer de entrada.

Inicializa um objeto TLVReader para ler um único PackageBuffer.

A análise começa na posição inicial de buffer (buf->DataStart()) e continua até o fim dos dados no buffer (conforme indicado por buf->Datalen()) ou os bytes maxLen foram analisados.

Inicializa um objeto TLVReader para ler um ou mais PackageBuffers.

A análise começa na posição inicial de buffer inicial (buf->DataStart()). Se allowDiscontiguousBuffers for verdadeiro, o leitor avançará na cadeia de buffers vinculados pelos ponteiros de Next(). A análise continua até que todos os dados na cadeia de buffer tenham sido consumidos (conforme indicado por buf->Datalen()) ou até que os bytes maxLen sejam analisados.

avança o objeto TLVReader para o próximo elemento TLV que será lido;

O método Next() posiciona o objeto do leitor no próximo elemento em uma codificação TLV que reside no mesmo contexto de contenção. Se o leitor estiver posicionado no nível mais externo de uma codificação TLV, chamar Next() fará com que ele chegue ao próximo elemento na parte superior. Se o leitor for posicionado em um elemento do contêiner de TLV (uma estrutura, uma matriz ou um caminho), chamar Next() adiantará o leitor para o próximo elemento de membro do contêiner.

Como Next() restringe o movimento do leitor ao contexto de contenção atual, chamar Next() quando o leitor é posicionado em um elemento do contêiner avança no contêiner, ignorando os elementos (e membros de contêineres aninhados) até que chegue ao primeiro elemento após o contêiner.

Quando não há mais elementos em um contexto de contenção específico, o método Next() retorna um erro WEAVE_END_OF_TLV e a posição do leitor permanece inalterada.

avança o objeto TLVReader para o próximo elemento TLV a ser lido, declarando o tipo e a tag do novo elemento;

O método Next(TLVTypeExpectedType, uint64_texpectedTag) é um método de conveniência que tem o mesmo comportamento que Next(), mas também verifica se o tipo e a tag do novo elemento TLV correspondem aos argumentos fornecidos.

Inicializa um novo objeto TLVReader para ler os membros de um elemento de contêiner TLV.

O método OpenContainer() inicializa um novo objeto TLVReader para ler os elementos de membro de um contêiner TLV (uma estrutura, matriz ou caminho). Quando OpenContainer() é chamado, o objeto TLVReader atual precisa ser posicionado no elemento do contêiner para ser lido. O método usa como argumento exclusivo uma referência a um novo leitor que será inicializado para ler o contêiner. Esse leitor é conhecido como leitor de contêiner, e o leitor no qual OpenContainer() é chamado é conhecido como leitor pai.

Quando o método OpenContainer() retorna, o leitor de contêiner é posicionado imediatamente antes do primeiro membro do contêiner. Chamar Next() no leitor de contêiner avança com os membros da coleção até que o fim seja atingido, quando o leitor retorna WEAVE_END_OF_TLV.

Enquanto o leitor de contêiner está aberto, os aplicativos não podem fazer chamadas nem alterar o estado do leitor pai. Depois que um aplicativo termina de usar o leitor de contêiner, ele precisa fechá-lo chamando CloseContainer() no leitor pai, transmitindo o leitor de contêiner como um argumento. Os aplicativos podem fechar o leitor de contêiner a qualquer momento, com ou sem a leitura de todos os elementos contidos no contêiner subjacente. Depois que o leitor de contêiner for fechado, os aplicativos continuarão usando o leitor pai.

O leitor de contêiner herda várias propriedades de configuração do leitor pai. Eles são os seguintes:

• O ID de perfil implícito (ImplicitProfileId)
• O ponteiro de dados do aplicativo (AppData)
• O ponteiro da função GetNextBuffer

avança o objeto TLVReader imediatamente após o elemento TLV atual;

O método Skip() posiciona o objeto do leitor imediatamente após o elemento TLV atual, de modo que uma chamada subsequente para Next() avança o leitor para o elemento a seguir. Como Next(), se o leitor for posicionado em um elemento do contêiner no momento da chamada, os membros do contêiner serão ignorados. Se o leitor não estiver posicionado em nenhum elemento, a posição dele permanecerá inalterada.

Verifica se o objeto TVLReader está no final de um contêiner TLV.

O método VerifyEndOfContainer() verifica se não há mais elementos TLV TLV para serem lidos no contêiner TLV atual. Esse é um método de conveniência equivalente a chamar Next() e verificar o valor de retorno de WEAVE_END_OF_TLV.

Limpe o estado do TLVReader.

Esse método é usado para posicionar o leitor antes do primeiro TLV, entre os TLVs ou após o último TLV.

Esse é um método particular que retorna o TLVElementType de mControlByte.

GetElementHeadLength

WEAVE_ERROR GetElementHeadLength(
  uint8_t & elemHeadBytes
) const 

IsContainerOpen

bool IsContainerOpen(
  void
) const 

WEAVE_ERROR ReadData(
  uint8_t *buf,
  uint32_t len
)

WEAVE_ERROR ReadElement(
  void
)

uint64_t ReadTag(
  TLVTagControl tagControl,
  const uint8_t *& p
)

void SetContainerOpen(
  bool aContainerOpen
)

WEAVE_ERROR SkipData(
  void
)

WEAVE_ERROR SkipToEndOfContainer(
  void
)

WEAVE_ERROR VerifyElement(
  void
)

WEAVE_ERROR FailGetNextBuffer(
  TLVReader & reader,
  uintptr_t & bufHandle,
  const uint8_t *& bufStart,
  uint32_t & bufLen
)

WEAVE_ERROR GetNextPacketBuffer(
  TLVReader & reader,
  uintptr_t & bufHandle,
  const uint8_t *& bufStart,
  uint32_t & bufLen
)