nl :: Tecer:: TLV :: TLVReader

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

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

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

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

Retorna o byte de controle associado ao elemento TLV atual.

Idealmente, ninguém precisa saber sobre o byte de controle e apenas a implementação interna do TLV deve ter acesso a ele. Mas, no entanto, ter acesso ao byte de controle é útil para fins de depuração pelos utilitários de depuração TLV (que tentam decodificar o byte de controle de tag ao imprimir o conteúdo do buffer TLV ).

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

Este método retorna um ponteiro direto para o valor da string codificada no buffer de entrada subjacente. Para ter sucesso, o método requer que todo o valor da string esteja presente em um único buffer. Caso contrário, o método retorna WEAVE_ERROR_TLV_UNDERRUN . Isso torna o método de uso limitado ao ler dados de vários buffers descontíguos.

Retorna o comprimento dos dados associados ao elemento TLV atual.

O comprimento de dados só se aplica 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.

Obtém 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 comprimento máximo de leitura seja atingido.

Obtenha o valor do byte atual ou elemento de string UTF8 como uma string terminada em nulo.

Para determinar o tamanho do buffer de entrada necessário, chame o método GetLength () antes de chamar GetBytes () . O buffer de entrada deve ser pelo menos um byte maior que o comprimento 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 de tag.

Retorna o tipo do elemento TLV atual.

Inicializa um objetoTLVReader a partir de outro objetoTLVReader .

Inicializa um objetoTLVReader para ler de um único buffer de entrada.

Inicializa um objetoTLVReader para ler de um único PacketBuffer.

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

Inicializa um objetoTLVReader para ler um ou mais PacketBuffers.

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

Avança o objetoTLVReader para o próximo elemento TLV a ser lido.

O método Next () posiciona o objeto leitor no próximo elemento em uma codificação TLV que reside no mesmo contexto de contenção. Em particular, se o leitor estiver posicionado no nível mais externo de uma codificação TLV , chamar Next () avançará o leitor para o próximo elemento superior. Se o leitor estiver posicionado dentro de um elemento de contêiner TLV (uma estrutura, matriz ou caminho), chamar Next () avançará o leitor para o próximo elemento membro do contêiner.

Como Next () restringe o movimento do leitor ao contexto de contenção atual, chamar Next () quando o leitor está posicionado em um elemento de contêiner avançará sobre o contêiner, ignorando seus elementos de membro (e os membros de quaisquer contêineres aninhados) até atingir o primeiro elemento após o contêiner.

Quando não há mais elementos dentro de um contexto de contenção particular, o método Next () retornará um erro WEAVE_END_OF_TLV e a posição do leitor permanecerá inalterada.

Avança o objetoTLVReader para o próximo elemento TLV a ser lido, afirmando o tipo e a tag do novo elemento.

O método Next (TLVType expectedType, uint64_t expectedTag) é 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 objetoTLVReader para ler os membros de um elemento de contêiner TLV .

O método OpenContainer () inicializa um novo objetoTLVReader para ler os elementos membros de um contêiner TLV (uma estrutura, array ou caminho). Quando OpenContainer () é chamado, o objetoTLVReader atual deve ser posicionado no elemento contêiner a ser lido. O método tem como único argumento uma referência a um novo leitor que será inicializado para ler o contêiner. Esse leitor é conhecido como leitor de contêiner, enquanto 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çará pelos membros da coleção até que o fim seja alcançado, ponto no qual o leitor retornará WEAVE_END_OF_TLV.

Enquanto o leitor de contêiner estiver aberto, os aplicativos não devem fazer chamadas ou alterar o estado do leitor pai. Depois que um aplicativo terminar de usar o leitor de contêiner, ele deve fechá-lo chamando CloseContainer () no leitor pai, passando o leitor de contêiner como um argumento. Os aplicativos podem fechar o leitor de contêiner a qualquer momento, com ou sem ler todos os elementos contidos no contêiner subjacente. Depois que o leitor de contêiner é fechado, os aplicativos podem continuar a usar o leitor pai.

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

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

Advances theTLVReader object to immediately after the current TLV element.

The Skip() method positions the reader object immediately after the current TLV element, such that a subsequent call to Next() will advance the reader to the following element. Like Next() , if the reader is positioned on a container element at the time of the call, the members of the container will be skipped. If the reader is not positioned on any element, its position remains unchanged.

Verifies that the TVLReader object is at the end of a TLV container.

The VerifyEndOfContainer() method verifies that there are no further TLV elements to be read within the current TLV container. This is a convenience method that is equivalent to calling Next() and checking for a return value of WEAVE_END_OF_TLV.

Clear the state of theTLVReader .

This method is used to position the reader before the first TLV , between TLVs or after the last TLV .

This is a private method that returns the TLVElementType from 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
)