nl :: Tecer:: Perfis :: ReferencedTLVData

#include <src/lib/profiles/common/WeaveMessage.h>

Da mesma forma, precisamos ser capazes de representar um grande e antigo blob de dados TLV .

Resumo

Herança

Herda de: nl :: Weave :: Profiles :: RetainedPacketBuffer

Construtores e Destruidores
`ReferencedTLVData (void)` -------------- definições para dados TLV --------------

Tipos públicos
`TLVWriteCallback )(TLV::TLVWriter &aWriter, void *aAppState)`	typedef `void(*`

Atributos públicos
`theData`	`uint8_t *`
`theLength`	`uint16_t`
`theMaxLength`	`uint16_t`

Funções públicas
`free (void)`	`void` Libere um objeto ReferencedTLVData , ou seja, cancele-o.
`init ( System::PacketBuffer *aBuffer)`	`WEAVE_ERROR` Inicialize o objeto ReferencedTLVData dado um PacketBuffer.
`init ( MessageIterator & i)`	`WEAVE_ERROR` Inicialize um objeto ReferencedTLVData dado um MessageIterator .
`init (uint16_t aLength, uint16_t aMaxLength, uint8_t *aByteString)`	`WEAVE_ERROR` Inicialize um ReferencedTLVObject com uma string de bytes.
`init (TLVWriteCallback aWriteCallback, void *anAppState)`	`WEAVE_ERROR` Inicialize um objeto RefererencedTLVData com uma função de retorno de chamada.
`isEmpty (void)`	`bool` Verifique se um objeto ReferencedTLVData contém algo.
`isFree (void)`	`bool` Verifique se um objeto ReferencedTLVData é "livre", ou seja,
`operator== (const ReferencedTLVData &) const`	`bool` Verifique a igualdade de um objeto ReferencedTLVData em relação a outro.
`pack ( System::PacketBuffer *buff)`	`WEAVE_ERROR` Empacote um objeto ReferencedTLVData diretamente em um PacketBuffer.
`pack ( MessageIterator & i, uint32_t maxLen)`	`WEAVE_ERROR`
`packedLength (void)`	`uint16_t` Retorne o comprimento dos dados assumindo que o objeto foi empacotado em um buffer.

Funções estáticas públicas
`parse ( System::PacketBuffer *buff, ReferencedTLVData & aTarget)`	`WEAVE_ERROR` Analisa um objeto ReferencedTLVData de um PacketBuffer fornecido.
`parse ( MessageIterator & i, ReferencedTLVData & aTarget)`	`WEAVE_ERROR` Analisa um objeto ReferencedTLVData de um MessageIterator fornecido.

Tipos públicos

TLVWriteCallback

void(* TLVWriteCallback)(TLV::TLVWriter &aWriter, void *aAppState)

Atributos públicos

os dados

uint8_t * theData

O comprimento

uint16_t theLength

theMaxLength

uint16_t theMaxLength

Funções públicas

ReferencedTLVData

 ReferencedTLVData(
  void
)

-------------- definições para dados TLV --------------

O construtor sem argumentos para dados TLV . Entrega um objeto livre / não inicializado que deve ser submetido a um dos métodos init () definidos aqui para ser útil.

livre

void free(
  void
)

Libere um objeto ReferencedTLVData , ou seja, cancele-o.

iniciar

WEAVE_ERROR init(
  System::PacketBuffer *aBuffer
)

Inicialize o objeto ReferencedTLVData dado um PacketBuffer.

Inicializa um objeto ReferencedTLVData dado um buffer cheio de TLV . Isso pressupõe que o buffer contém SOMENTE TLV .

Detalhes

Parâmetros

[in] aBuffer

Um buffer de mensagem no qual o TLV reside.

Valores Retornados

WEAVE_NO_ERROR

Incondicionalmente

iniciar

WEAVE_ERROR init(
  MessageIterator & i
)

Inicialize um objeto ReferencedTLVData dado um MessageIterator .

Inicialize um objeto ReferencedTLVData dado um MessageIterator . Nesse caso, o TLV é a última parte do buffer e passamos um iterador de mensagem que aponta para ele.

Detalhes

Parâmetros

[in] i

Um iterador de mensagem apontando para TLV a ser extraído.

Valores Retornados

WEAVE_NO_ERROR

Incondicionalmente

iniciar

WEAVE_ERROR init(
  uint16_t aLength,
  uint16_t aMaxLength,
  uint8_t *aByteString
)

Inicialize um ReferencedTLVObject com uma string de bytes.

Inicialize o objeto ReferencedTLVData com uma string de bytes contendo TLV . Este inicializador é o que usamos se não houver PacketrBuffer porque estamos criando um deles para embalar e enviar.

Detalhes

Parâmetros

`[in] aLength`	Um comprimento para os dados TLV
`[in] aMaxLength`	O comprimento total do buffer
`[in] aByteString`	Um ponteiro para os dados da string

Valores Retornados

WEAVE_NO_ERROR

Incondicionalmente

iniciar

WEAVE_ERROR init(
  TLVWriteCallback aWriteCallback,
  void *anAppState
)

Inicialize um objeto RefererencedTLVData com uma função de retorno de chamada.

Inicialize um objeto ReferencedTLVData . Em vez de fornecer explicitamente os dados, esta versão fornece a função, o callback de gravação e um objeto de referência, que será passado para ela, junto com um objeto TLVWriter, quando os dados referenciados devem ser compactados e enviados. A assinatura desse retorno de chamada é:

typedef void (*TLVWriteCallback)(TLV::TLVWriter &aWriter, void *aAppState);

Detalhes

Parâmetros

`[in] aWriteCallback`	a função a ser chamada na hora de escrever algum TLV .
`[in] anAppState`	um objeto de estado do aplicativo a ser passado para o retorno de chamada junto com o gravador.

Valores Retornados

`WEAVE_NO_ERROR`	Com sucesso.
`WEAVE_ERROR_INVALID_ARGUMENT`	Se o retorno de chamada de gravação não for fornecido.

está vazia

bool isEmpty(
  void
)

Verifique se um objeto ReferencedTLVData contém algo.

Existem duas maneiras possíveis de tal objeto "ter" algo. Ele pode ter comprimento 0 OU não pode ter nenhum retorno de chamada de gravação.

Detalhes
Devoluções	verdadeiro se o conjunto de dados tiver comprimento 0 ou não houver retorno de chamada de gravação disponível, falso caso contrário

é grátis

bool isFree(
  void
)

Verifique se um objeto ReferencedTLVData é "livre", ou seja,

Indefinido.

Detalhes
Devoluções	verdadeiro se o objeto for indefinido, falso caso contrário.

operador ==

bool operator==(
  const ReferencedTLVData &
) const

Verifique a igualdade de um objeto ReferencedTLVData em relação a outro.

Observe que isso só faz sentido no caso de dois objetos que contêm dados reais apoiados por um buffer ou string.

Detalhes

Parâmetros

[in] Another

um objeto para verificar

Valores Retornados

`true`	Os objetos são iguais.
`false`	As strings dos objetos não são iguais.

pacote

WEAVE_ERROR pack(
  System::PacketBuffer *buff
)

Empacote um objeto ReferencedTLVData diretamente em um PacketBuffer.

Detalhes

Parâmetros

[in] buff

o buffer para preencher.

Devoluções

um WEAVE_ERROR refletindo o sucesso da chamada de pacote subjacente.

pacote

WEAVE_ERROR pack(
  MessageIterator & i,
  uint32_t maxLen
)

PackedLength

uint16_t packedLength(
  void
)

Retorne o comprimento dos dados assumindo que o objeto foi empacotado em um buffer.

Detalhes
Devoluções	o comprimento inteiro dos dados compactados.

Funções estáticas públicas

analisar

WEAVE_ERROR parse(
  System::PacketBuffer *buff,
  ReferencedTLVData & aTarget
)

Analisa um objeto ReferencedTLVData de um PacketBuffer fornecido.

Analisa um objeto ReferencedTLVData fora de um buffer inet (assumindo que ele contém apenas TLV ).

Detalhes

Parâmetros

`[in] buff`	o buffer para ler.
`[out] aTarget`	um objeto ReferencedTLVData para "preencher" com o resultado.

Devoluções

um WEAVE_ERROR refletindo o sucesso da chamada de análise subjacente.

analisar

WEAVE_ERROR parse(
  MessageIterator & i,
  ReferencedTLVData & aTarget
)

Analisa um objeto ReferencedTLVData de um MessageIterator fornecido.

Analisa um objeto ReferenceTLVData de um objeto MessageIterator considerado como apontando para a parte TLV de uma mensagem.

Observe que nenhuma "análise" real é feita aqui, pois o TLV é deixado no buffer e não é manipulado de forma alguma. Este método principalmente configura a estrutura ReferencedTLVData para uso posterior.

Detalhes

Parâmetros

`[in] i`	Um iterador sobre a mensagem que está sendo analisada.
`[out] aTarget`	Um local para colocar o resultado da análise.

Valores Retornados

WEAVE_NO_ERROR

Incondicionalmente

nl :: Tecer:: Perfis :: ReferencedTLVData

Resumo

Herança

Construtores e Destruidores

Tipos públicos

Atributos públicos

Funções públicas

Funções estáticas públicas

Tipos públicos

TLVWriteCallback

Atributos públicos

os dados

O comprimento

theMaxLength

Funções públicas

ReferencedTLVData

livre

iniciar

iniciar

iniciar

iniciar

está vazia

é grátis

operador ==

pacote

pacote

PackedLength

Funções estáticas públicas

analisar

analisar