nl::Weave::TLV::TLVReader

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

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

Retorna o tipo de contêiner em que 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 elemento ou depois do elemento TLV mais 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 apenas a implementação interna do TLV tenha acesso a ele. Mas, no entanto, ter acesso ao byte de controle é útil para fins de depuração pelos utilitários TLVDebug (que tentam decodificar o byte de controle da tag ao exibir o conteúdo do buffer TLV).

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

Esse método retorna um ponteiro direto do 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 torna o método de uso limitado ao ler dados de vários buffers descontínuos.

Retorna o comprimento dos dados associados ao elemento TLV atual.

O tamanho dos dados só se aplica a elementos do tipo string UTF8 ou 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 a inicialização do leitor.

Extrai 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.

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

Para determinar o tamanho necessário do buffer de entrada, chame o método GetLength() antes de chamar GetBytes(). O buffer de entrada precisa 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 utilitárias de tag (IsProfileTag(), IsContextTag(), ProfileIdFromTag() etc.) para determinar o tipo de tag e extrair vários valores de campos de tags.

Retorna o tipo do elemento TLV atual.

Inicializa um objeto TLVReader de outro objeto TLVReader.

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

Inicializa um objeto TLVReader 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 bytes maxLen foram analisados.

Inicializa um objeto TLVReader para ler um ou mais pacotesBuffers.

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 pelos ponteiros Next(). A análise continua até que todos os dados na cadeia do buffer sejam consumidos (conforme indicado por buf->Datalen()) ou até que os bytes de maxLen sejam analisados.

avança o objeto TLVReader para o próximo elemento TLV a ser lido.

O método Next() posiciona o objeto de leitura no próximo elemento em uma codificação TLV que reside no mesmo contexto de contenção. Particularmente, se o leitor estiver posicionado no nível mais externo de uma codificação TLV, chamar Next() vai avançar o leitor para o próximo elemento no topo. Se o leitor estiver posicionado em um elemento de contêiner TLV (uma estrutura, matriz ou caminho), chamar Next() vai 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 estiver posicionado em um elemento de contêiner avançará sobre o contêiner, pulando os elementos membros (e os membros de qualquer contêiner aninhado) até alcançar o primeiro elemento após o contêiner.

Quando não houver outros elementos em um contexto de contenção específico, o método Next() retornará um erro WEAVE_END_OF_TLV e a posição do leitor permanecerá 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 um contêiner TLV (uma estrutura, matriz ou caminho). Quando OpenContainer() é chamado, o objeto TLVReader atual precisa ser posicionado no elemento do contêiner a ser lido. O método usa 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 em que OpenContainer() é chamado é conhecido como leitor pai.

Quando o método OpenContainer() retorna, o leitor de contêiner é posicionado imediatamente antes do primeiro membro. Chamar Next() no leitor de contêiner avançará pelos membros da coleção até chegar ao fim. Nesse momento, o leitor retornará WEAVE_END_OF_TLV.

Enquanto o leitor de contêiner estiver aberto, os aplicativos não poderão fazer chamadas nem alterar o estado do leitor pai. Depois que um aplicativo terminar de usar o leitor de contêiner, ele precisará 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 é fechado, os aplicativos podem continuar usando o leitor pai.

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

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

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

O método Skip() posiciona o objeto leitor imediatamente após o elemento TLV atual, de modo que uma chamada subsequente para Next() avance o leitor para o elemento seguinte. Como em Next(), se o leitor estiver posicionado em um elemento de 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 vai permanecer inalterada.

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

O método VerifyEndOfContainer() verifica se não há outros elementos TLV a serem lidos no contêiner TLV atual. Esse método prático é equivalente a chamar Next() e verificar um 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 TLVs ou após o último TLV.

Esse é um método particular que retorna o TLVElementType do 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
)