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, chamar o GetLength () método antes de chamar GetBytes () .

Retorna o tipo do recipiente dentro do qual oTLVReader está lendo atualmente.

O GetContainerType () retorna o tipo do TLV recipiente dentro do qual aTLVReader é a leitura. Se oTLVReader está posicionado ao nível mais externa de um TLV de codificação (ou seja, antes, em ou depois de o-mais exterior TLV elemento), o método irá retornar kTLVType_NotSpecified.

Retorna o byte de controle associado com o atual TLV elemento.

Idealmente, ninguém precisa de saber sobre o byte de controle e só a implementação interna do TLV deve ter acesso a ele. Mas, no entanto, de acesso para o byte de controlo é útil para fins de depuração pelo TLV de depuração Utilidades (que tentativa para descodificar o byte de controle etiqueta quando muito imprimir o TLV tampão conteúdos).

Obter um ponteiro para o byte codificado inicial de um TLV byte ou UTF8 elemento cadeia.

Este método retorna um ponteiro direto do valor da string codificada dentro do 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 de dados associados com o atual TLV elemento.

O comprimento dos 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 alcançado.

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, chamar o GetLength () método 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 a atual TLV elemento.

O valor devolvido por gettag () pode ser usado com as funções utilitárias tag ( IsProfileTag () , IsContextTag () , ProfileIdFromTag () , etc.) para determinar o tipo de etiqueta e para extrair vários valores de campo de etiqueta.

Retorna o tipo do atual TLV elemento.

Inicializa umTLVReader objeto de outroTLVReader objeto.

Inicializa umaTLVReader objecto para ler a partir de um único buffer de entrada.

Inicializa umTLVReader objeto para ler a partir 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 denotado por buf-> Datalen ()), ou os bytes maxLen foram analisados.

Inicializa umTLVReader objeto para ler a partir de um ou mais PacketBuffers.

A análise começa na posição inicial do buffer inicial (buf-> DataStart ()). Se allowDiscontiguousBuffers é verdade, o leitor vai avançar através da cadeia de buffers ligados por suas next () ponteiros. 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ços doTLVReader objeto para o próximo TLV elemento a ser lido.

Os Próximo () as posições do método do objecto leitor no elemento seguinte, em um TLV codificando que reside no mesmo contexto de contenção. Em particular, se o leitor está posicionado ao nível mais externa de uma TLV codificação, chamando Próximo () irá avançar o leitor para o próximo, mais alto elemento. Se o leitor está posicionado dentro de um TLV elemento de recipiente (uma estrutura, matriz ou caminho), chamando Próximo () irá avançar o leitor para o próximo elemento de membro do recipiente.

Desde Próximo () constrange leitor de movimento para o contexto de contenção corrente, chamando Próximo () quando o leitor está posicionado sobre um elemento de recipiente irá avançar ao longo do recipiente, ignorando os seus elementos de membro (e os membros de quaisquer recipientes aninhados) até que atinge o primeiro elemento após o contêiner.

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

Avanços doTLVReader objeto para o próximo TLV elemento a ser lido, afirmando o tipo ea marca do novo elemento.

O Next (TLVType expectedType, uint64_t expectedTag) método é um método de conveniência que tem o mesmo comportamento como Next () , mas também verifica se o tipo ea marca do novo TLV elemento correspondem os argumentos fornecidos.

Inicializa uma novaTLVReader objeto para ler os membros de um TLV elemento recipiente.

O OpenContainer () método inicializa uma novaTLVReader objecto para a leitura dos elementos de membro de uma TLV recipiente (uma estrutura, de matriz ou de caminho). Quando OpenContainer () é chamado, o actualTLVReader objecto tem de ser posicionado no elemento de recipiente 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. Este leitor é conhecido como o leitor recipiente enquanto o leitor sobre a qual OpenContainer () é chamado é conhecido como o leitor-mãe.

Quando os OpenContainer () método retorna, o leitor recipiente é posicionado imediatamente antes do primeiro membro do recipiente. Chamando Next () no leitor recipiente irá avançar através dos membros da coleção até o fim é alcançado, altura em que o leitor irá 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 tiver terminado de usar o leitor recipiente que deve fechá-lo chamando CloseContainer () no leitor pai, passando o leitor recipiente 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. Estes são:

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

Avança oTLVReader objeto para imediatamente após a corrente TLV elemento.

Os Ir () as posições do método do objecto leitor imediatamente após a corrente TLV elemento, de tal modo que uma chamada subsequente a seguir () irá avançar o leitor para o elemento seguinte. Como Next () , se o leitor está posicionado em um elemento de recipiente no momento da chamada, os membros do recipiente será ignorado. Se o leitor não estiver posicionado em nenhum elemento, sua posição permanece inalterada.

Verifica se o objecto TVLReader é no final de um TLV recipiente.

Os VerifyEndOfContainer () verifica método que não há mais TLV elementos a ser lidos dentro da corrente TLV recipiente. Este é um método de conveniência que é equivalente a chamar Next () e verificação de um valor de retorno de 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
)