nl:: Weave:: TLV:: TLVWriter
#include <src/lib/core/WeaveTLV.h>
Fornece um codificador com eficiência de memória para gravar dados no formato TLV do Weave.
Resumo
O TLVWriter implementa um codificador apenas para encaminhamento em estilo de stream para dados TLV do Weave. Os aplicativos gravam dados em uma codificação chamando um dos métodos Put() do gravador, passando as informações associadas da tag e do valor, conforme necessário. Da mesma forma, os aplicativos podem codificar tipos de contêiner TLV (estruturas, matrizes ou caminhos) chamando os métodos OpenContainer() ou EnterContainer() do gravador.
Um objeto TLVWriter pode gravar dados diretamente em um buffer de saída fixo ou em uma cadeia de um ou mais objetos PackageBuffer. Além disso, os aplicativos podem fornecer as próprias funções GetNewBuffer
e FinalizeBuffer
para direcionar a saída a um destino arbitrário, por exemplo, um soquete ou uma fila de eventos.
Herança
Subclasses conhecidas diretas: nl::Weave::TLV::CircularTLVWriter
Tipos protegidos |
|
---|---|
@72{
|
enum |
Tipos públicos |
|
---|---|
FinalizeBufferFunct)(TLVWriter &writer, uintptr_t bufHandle, uint8_t *bufStart, uint32_t bufLen)
|
WEAVE_ERROR(* Uma função usada para executar a finalização da saída de um objeto TLVWriter. |
GetNewBufferFunct)(TLVWriter &writer, uintptr_t &bufHandle, uint8_t *&bufStart, uint32_t &bufLen)
|
WEAVE_ERROR(* Uma função que fornece um novo espaço do buffer de saída para um TLVWriter. |
Atributos públicos |
|
---|---|
AppData
|
void *
Um campo de ponteiro que pode ser usado para dados específicos do aplicativo.
|
FinalizeBuffer
|
Um ponteiro para uma função que será chamada quando o TLVWriter for finalizado.
|
GetNewBuffer
|
Um ponteiro para uma função que fornecerá um novo espaço de buffer de saída para um TLVWriter.
|
ImplicitProfileId
|
uint32_t
O ID do perfil das tags que devem ser codificadas de forma implícita.
|
Atributos protegidos |
|
---|---|
mBufHandle
|
uintptr_t
|
mBufStart
|
uint8_t *
|
mContainerType
|
|
mLenWritten
|
uint32_t
|
mMaxLen
|
uint32_t
|
mRemainingLen
|
uint32_t
|
mWritePoint
|
uint8_t *
|
Funções públicas |
|
---|---|
CloseContainer(TLVWriter & containerWriter)
|
Realiza a gravação de um contêiner TLV após uma chamada para OpenContainer().
|
ContinuePutBytes(const uint8_t *buf, uint32_t len)
|
Codifica um valor de string de bytes TLV.
|
CopyContainer(TLVReader & container)
|
|
CopyContainer(uint64_t tag, TLVReader & container)
|
Codifica um elemento de contêiner TLV de um conjunto pré-codificado de elementos membros.
|
CopyContainer(uint64_t tag, const uint8_t *encodedContainer, uint16_t encodedContainerLen)
|
Codifica um elemento de contêiner TLV que contém elementos de membro de um contêiner pré-codificado.
|
CopyElement(TLVReader & reader)
|
Copia um elemento TLV de um objeto de leitor para o gravador.
|
CopyElement(uint64_t tag, TLVReader & reader)
|
|
EndContainer(TLVType outerContainerType)
|
Completa a codificação de um elemento de contêiner TLV.
|
Finalize(void)
|
Termine de escrever uma codificação TLV.
|
GetContainerType(void) const
|
Retorna o tipo de contêiner em que o TLVWriter está gravando no momento.
|
GetLengthWritten(void)
|
uint32_t
Retorna o número total de bytes gravados desde a inicialização do gravador.
|
Init(uint8_t *buf, uint32_t maxLen)
|
void
Inicializa um objeto TLVWriter para gravar em um único buffer de saída.
|
Init(PacketBuffer *buf, uint32_t maxLen)
|
void
Inicializa um objeto TLVWriter para gravar em um único PackageBuffer.
|
Init(PacketBuffer *buf, uint32_t maxLen, bool allowDiscontiguousBuffers)
|
void
Inicializa um objeto TLVWriter para gravar em um ou mais pacotesBuffers.
|
InitMalloced(uint8_t *& outBuf, uint32_t initialBufSize, uint32_t maxLen)
|
void
Inicializa um objeto TLVWriter para gravar em um buffer dinâmico.
|
OpenContainer(uint64_t tag, TLVType containerType, TLVWriter & containerWriter)
|
|
Put(uint64_t tag, int8_t v)
|
Codifica um valor inteiro assinado com TLV.
|
Put(uint64_t tag, int8_t v, bool preserveSize)
|
Codifica um valor inteiro assinado com TLV.
|
Put(uint64_t tag, int16_t v)
|
|
Put(uint64_t tag, int16_t v, bool preserveSize)
|
|
Put(uint64_t tag, int32_t v)
|
|
Put(uint64_t tag, int32_t v, bool preserveSize)
|
|
Put(uint64_t tag, int64_t v)
|
|
Put(uint64_t tag, int64_t v, bool preserveSize)
|
|
Put(uint64_t tag, uint8_t v)
|
Codifica um valor inteiro sem sinal de TLV.
|
Put(uint64_t tag, uint8_t v, bool preserveSize)
|
Codifica um valor inteiro sem sinal de TLV.
|
Put(uint64_t tag, uint16_t v)
|
|
Put(uint64_t tag, uint16_t v, bool preserveSize)
|
|
Put(uint64_t tag, uint32_t v)
|
|
Put(uint64_t tag, uint32_t v, bool preserveSize)
|
|
Put(uint64_t tag, uint64_t v)
|
|
Put(uint64_t tag, uint64_t v, bool preserveSize)
|
|
Put(uint64_t tag, float v)
|
|
Put(uint64_t tag, double v)
|
Codifica um valor de ponto flutuante TLV.
|
PutBoolean(uint64_t tag, bool v)
|
Codifica um valor booleano TLV.
|
PutBytes(uint64_t tag, const uint8_t *buf, uint32_t len)
|
Codifica um valor de string de bytes TLV.
|
PutNull(uint64_t tag)
|
Codifica um valor nulo de TLV.
|
PutPreEncodedContainer(uint64_t tag, TLVType containerType, const uint8_t *data, uint32_t dataLen)
|
Codifica um elemento de contêiner TLV de um conjunto pré-codificado de elementos membros.
|
PutString(uint64_t tag, const char *buf)
|
Codifica um valor de string TLV UTF8.
|
PutString(uint64_t tag, const char *buf, uint32_t len)
|
Codifica um valor de string TLV UTF8.
|
PutStringF(uint64_t tag, const char *fmt, ...)
|
Codifique a saída de string formatada de acordo com o formato no elemento TLV.
|
StartContainer(uint64_t tag, TLVType containerType, TLVType & outerContainerType)
|
Começa a codificar um novo elemento de contêiner TLV.
|
StartPutBytes(uint64_t tag, uint32_t totalLen)
|
Codifica uma string de bytes TLV em vários blocos.
|
VPutStringF(uint64_t tag, const char *fmt, va_list ap)
|
Codifique a saída de string formatada de acordo com o formato no elemento TLV.
|
Funções estáticas públicas |
|
---|---|
FinalizePacketBuffer(TLVWriter & writer, uintptr_t bufHandle, uint8_t *bufStart, uint32_t dataLen)
|
Uma implementação de uma função FinalizeBuffer TLVWriter para gravar em uma cadeia de PackageBuffers.
|
GetNewBuffer_Malloced(TLVWriter & writer, uintptr_t & bufHandle, uint8_t *& bufStart, uint32_t & bufLen)
|
Uma implementação de uma função GetNewBuffer TLVWriter para gravar em um buffer dinâmico.
|
GetNewPacketBuffer(TLVWriter & writer, uintptr_t & bufHandle, uint8_t *& bufStart, uint32_t & bufLen)
|
Uma implementação de uma função GetNewBuffer TLVWriter para gravar em uma cadeia de pacotesBuffers.
|
Funções protegidas |
|
---|---|
IsCloseContainerReserved(void) const
|
bool
Determine se o contêiner deve reservar espaço para o símbolo CloseContainer no ponto de partida / abertura dele.
|
IsContainerOpen(void) const
|
bool
|
SetCloseContainerReserved(bool aCloseContainerReserved)
|
void
Defina se o contêiner precisa reservar o espaço para o símbolo "CloseContainer" no ponto de início / abertura dele.
|
SetContainerOpen(bool aContainerOpen)
|
void
|
WriteData(const uint8_t *p, uint32_t len)
|
|
WriteElementHead(TLVElementType elemType, uint64_t tag, uint64_t lenOrVal)
|
|
WriteElementWithData(TLVType type, uint64_t tag, const uint8_t *data, uint32_t dataLen)
|
Tipos protegidos
@72
@72
Tipos públicos
FinalizeBufferFunct
WEAVE_ERROR(* FinalizeBufferFunct)(TLVWriter &writer, uintptr_t bufHandle, uint8_t *bufStart, uint32_t bufLen)
Uma função usada para executar a finalização da saída de um objeto TLVWriter.
As funções desse tipo são chamadas quando o método Finalize() de um TLVWriter é chamado. Espera-se que a função execute qualquer limpeza ou finalização necessária relacionada ao consumo da saída do objeto gravador. Exemplos disso incluem gravar o comprimento final da codificação ou o fechamento de um descritor de arquivo.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
GetNewBufferFunct
WEAVE_ERROR(* GetNewBufferFunct)(TLVWriter &writer, uintptr_t &bufHandle, uint8_t *&bufStart, uint32_t &bufLen)
Uma função que fornece um novo espaço do buffer de saída para um TLVWriter.
As funções desse tipo são usadas para preparar um novo espaço de buffer para que um TLVWriter faça gravações. Quando chamada, a função deve retornar um ponteiro para um local da memória em que novos dados devem ser gravados, junto com um comprimento máximo associado. A função pode fornecer espaço de gravação alocando um novo buffer para armazenar os dados ou limpando dados gravados anteriormente de um buffer existente.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
Atributos públicos
AppData
void * AppData
Um campo de ponteiro que pode ser usado para dados específicos do aplicativo.
FinalizeBuffer
FinalizeBufferFunct FinalizeBuffer
Um ponteiro para uma função que será chamada quando o TLVWriter for finalizado.
Um objeto TLVWriter chamará a função FinalizeBuffer sempre que o método Finalize() dela for chamado. Os aplicativos podem definir o ponteiro da função em qualquer ponto antes de chamar Finalize(). Por padrão, o ponteiro é definido como NULL, o que faz com que o método Finalize() deixe de chamar a função.
Consulte a definição do tipo FinalizeBufferFunct para informações adicionais sobre como implementar uma função FinalizeBuffer.
GetNewBuffer
GetNewBufferFunct GetNewBuffer
Um ponteiro para uma função que fornecerá um novo espaço de buffer de saída para um TLVWriter.
Um objeto TLVWriter chamará a função GetNewBuffer sempre que for feita uma tentativa de gravar dados que excedam o tamanho do buffer de saída atual. Se definido como NULL (o valor padrão), o gravador retornará um WEAVE_ERROR_NO_MEMORY se os dados de saída estourarem o buffer atual.
GetNewBuffer pode ser definido por um aplicativo a qualquer momento, mas normalmente é definido quando o gravador é inicializado.
Consulte a definição do tipo GetNewBufferFunct para obter informações adicionais sobre como implementar uma função GetNewBuffer.
ImplicitProfileId
uint32_t ImplicitProfileId
O ID do perfil das tags que devem ser codificadas de forma implícita.
Quando o editor é solicitado a codificar um novo elemento, se o código de perfil da tag associada ao novo elemento corresponder ao valor do membro ImplicitProfileId
, o editor codificará a tag de forma implícita, omitindo o código do perfil no processo.
Por padrão, a propriedade ImplicitProfileId
é definida como kProfileIdNotSpecified, que instrui o gravador a não emitir tags codificadas implicitamente. Os aplicativos podem definir ImplicitProfileId
a qualquer momento para ativar as tags de codificação de forma implícita, começando no ponto atual da codificação. O ID de perfil apropriado a ser definido geralmente depende do contexto do aplicativo ou protocolo sendo falado.
Atributos protegidos
mBufHandle
uintptr_t mBufHandle
mBufStart
uint8_t * mBufStart
mContainerType
TLVType mContainerType
mLenWritten
uint32_t mLenWritten
mMaxLen
uint32_t mMaxLen
mRemainingLen
uint32_t mRemainingLen
mWritePoint
uint8_t * mWritePoint
Funções públicas
CloseContainer
WEAVE_ERROR CloseContainer( TLVWriter & containerWriter )
Realiza a gravação de um contêiner TLV após uma chamada para OpenContainer().
O método CloseContainer() restaura o estado de um objeto TLVWriter pai após uma chamada para OpenContainer(). A cada chamada para OpenContainer(), os aplicativos precisam fazer uma chamada correspondente para CloseContainer(), transmitindo uma referência ao mesmo gravador de contêiner para os dois métodos.
Quando CloseContainer() retorna, os aplicativos podem continuar usando o gravador pai para escrever outros elementos TLV que aparecem após o elemento do contêiner. Neste ponto, o gravador de contêiner fornecido precisa ser considerado "desinicializado" e não pode ser usado sem a reinicialização.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
ContinuePutBytes
WEAVE_ERROR ContinuePutBytes( const uint8_t *buf, uint32_t len )
Codifica um valor de string de bytes TLV.
Precisa ser usado com StartPutBytes.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
CopyContainer
WEAVE_ERROR CopyContainer( TLVReader & container )
Copia um elemento de contêiner TLV do objeto TLVReader.
O CopyContainer() codifica um novo elemento de contêiner TLV copiando um elemento de contêiner pré-codificado localizado na posição atual de um objeto TLVReader. O método grava todo o novo elemento de contêiner em uma chamada, copiando o tipo, a tag e os elementos do contêiner da codificação de origem. Quando o método retorna, o objeto do gravador pode ser usado para escrever outros elementos TLV após o elemento do contêiner.
Detalhes | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||||||||
Valores de retorno |
|
CopyContainer
WEAVE_ERROR CopyContainer( uint64_t tag, TLVReader & container )
Codifica um elemento de contêiner TLV de um conjunto pré-codificado de elementos membros.
O método CopyContainer() codifica um novo elemento de contêiner TLV (uma estrutura, matriz ou caminho) que contém um conjunto de elementos membro retirados de um objeto TLVReader. Quando o método é chamado, o objeto de leitura fornecido precisa ser posicionado em um elemento de contêiner TLV. O contêiner recém-codificado terá o mesmo tipo e membros que o contêiner de entrada. A tag do novo contêiner é especificada como um parâmetro de entrada.
Quando o método retorna, o objeto do gravador pode ser usado para escrever outros elementos TLV após o elemento do contêiner.
Detalhes | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||||||||
Valores de retorno |
|
CopyContainer
WEAVE_ERROR CopyContainer( uint64_t tag, const uint8_t *encodedContainer, uint16_t encodedContainerLen )
Codifica um elemento de contêiner TLV que contém elementos de membro de um contêiner pré-codificado.
O método CopyContainer() codifica um novo elemento de contêiner TLV (uma estrutura, matriz ou caminho) que contém um conjunto de elementos membro retirados do conteúdo de um contêiner pré-codificado fornecido. Quando o método é chamado, os dados no buffer de entrada fornecido são analisados como um elemento de contêiner TLV. Um contêiner novo é gravado com o mesmo tipo e membros que o contêiner de entrada. A tag do novo contêiner é especificada como um parâmetro de entrada.
Quando o método retorna, o objeto do gravador pode ser usado para escrever outros elementos TLV após o elemento do contêiner.
Detalhes | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||||||
Valores de retorno |
|
CopyElement
WEAVE_ERROR CopyElement( TLVReader & reader )
Copia um elemento TLV de um objeto de leitor para o gravador.
O método CopyElement() codifica um novo elemento TLV cujo tipo, tag e valor são obtidos de um objeto TLVReader. Quando o método é chamado, o objeto leitor fornecido precisa ser posicionado no elemento TLV de origem. O elemento recém-codificado terá o mesmo tipo, tag e conteúdo que o contêiner de entrada. Se o elemento fornecido for um contêiner TLV (estrutura, matriz ou caminho), todo o conteúdo do contêiner será copiado.
Detalhes | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||||||||
Valores de retorno |
|
CopyElement
WEAVE_ERROR CopyElement( uint64_t tag, TLVReader & reader )
EndContainer
WEAVE_ERROR EndContainer( TLVType outerContainerType )
Completa a codificação de um elemento de contêiner TLV.
O método EndContainer() conclui a codificação de um elemento de contêiner TLV e restaura o estado de um objeto TLVWrite após uma chamada anterior para StartContainer(). A cada chamada para StartContainer(), os aplicativos devem fazer uma chamada correspondente para EndContainer(), passando o valor de TLVType retornado pela chamada StartContainer(). Quando EndContainer() retorna, o objeto de gravação pode ser usado para escrever elementos TLV adicionais que seguem o elemento de contêiner.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
Finalizar
WEAVE_ERROR Finalize( void )
Termine de escrever uma codificação TLV.
O método Finalize() conclui o processo de gravação de uma codificação TLV no buffer de saída subjacente. O método precisa ser chamado pelo aplicativo antes de usar o conteúdo do buffer. Finalize() só pode ser chamado quando não há gravadores de contêiner abertos para o gravador atual. Consulte OpenContainer()
.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Valores de retorno |
|
GetContainerType
TLVType GetContainerType( void ) const
Retorna o tipo de contêiner em que o TLVWriter está gravando no momento.
O método GetContainerType() retorna o tipo do contêiner TLV em que o TLVWriter está gravando. Se TLVWriter não estiver gravando elementos dentro de um contêiner (ou seja, se estiver gravando no nível mais externo de uma codificação), o método retornará kTLVType_Notspecified.
Detalhes | |
---|---|
Retorna |
O TLVType do contêiner atual, ou kTLVType_Notspecified se o TLVWriter não estiver gravando elementos em um contêiner.
|
GetLengthWritten
uint32_t GetLengthWritten( void )
Retorna o número total de bytes gravados desde a inicialização do gravador.
Detalhes | |
---|---|
Retorna |
Número total de bytes gravados desde a inicialização do gravador.
|
Init
void Init( uint8_t *buf, uint32_t maxLen )
Init
void Init( PacketBuffer *buf, uint32_t maxLen )
Inicializa um objeto TLVWriter para gravar em um único PackageBuffer.
A gravação começa imediatamente após o último byte de dados no buffer fornecido.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
Init
void Init( PacketBuffer *buf, uint32_t maxLen, bool allowDiscontiguousBuffers )
Inicializa um objeto TLVWriter para gravar em um ou mais pacotesBuffers.
A gravação começa imediatamente após o último byte de dados no buffer especificado. Se allowDiscontiguousBuffers
for verdadeiro, pacotes adicionais de pacotes serão alocados e encadeados ao buffer fornecido conforme necessário para acomodar a quantidade de dados gravados. Se o buffer de saída especificado já for o líder de uma cadeia de buffers, a saída será gravada nos buffers subsequentes na cadeia antes que qualquer novo buffer seja alocado.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
InitMalloced
void InitMalloced( uint8_t *& outBuf, uint32_t initialBufSize, uint32_t maxLen )
Inicializa um objeto TLVWriter para gravar em um buffer dinâmico.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
OpenContainer
WEAVE_ERROR OpenContainer( uint64_t tag, TLVType containerType, TLVWriter & containerWriter )
Inicializa um novo objeto TLVWriter para gravar os membros de um elemento de contêiner TLV.
O método OpenContainer() é usado para gravar elementos do contêiner TLV (estrutura, matrizes ou caminhos) em uma codificação. O método usa o tipo e a tag (se houver) do novo contêiner e uma referência a um novo objeto gravador (o gravador do contêiner) que será inicializado com a finalidade de gravar os elementos do contêiner. Os aplicativos gravam os membros do novo contêiner usando a ferramenta de gravação de contêiner e chamam CloseContainer() para concluir a codificação.
Enquanto o gravador do contêiner estiver aberto, os aplicativos não poderão fazer chamadas nem alterar o estado do gravador pai.
O gravador do contêiner herda várias propriedades de configuração do gravador pai. São estes:
- O ID de perfil implícito (ImplicitProfileId)
- O ponteiro de dados do aplicativo (AppData)
- Os ponteiros das funções GetNewBuffer e FinalizeBuffer
Detalhes | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||||
Valores de retorno |
|
Put
WEAVE_ERROR Put( uint64_t tag, int8_t v )
Codifica um valor inteiro assinado com TLV.
Essa é uma função de membro sobrecarregada, fornecida por conveniência. Ela só difere da função acima em quais argumentos ela aceita.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
Put
WEAVE_ERROR Put( uint64_t tag, int8_t v, bool preserveSize )
Codifica um valor inteiro assinado com TLV.
Essa é uma função de membro sobrecarregada, fornecida por conveniência. Ela só difere da função acima em quais argumentos ela aceita.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
Put
WEAVE_ERROR Put( uint64_t tag, int16_t v )
Put
WEAVE_ERROR Put( uint64_t tag, int16_t v, bool preserveSize )
Put
WEAVE_ERROR Put( uint64_t tag, int32_t v )
Put
WEAVE_ERROR Put( uint64_t tag, int32_t v, bool preserveSize )
Put
WEAVE_ERROR Put( uint64_t tag, int64_t v )
Put
WEAVE_ERROR Put( uint64_t tag, int64_t v, bool preserveSize )
Put
WEAVE_ERROR Put( uint64_t tag, uint8_t v )
Codifica um valor inteiro sem sinal de TLV.
Essa é uma função de membro sobrecarregada, fornecida por conveniência. Ela só difere da função acima em quais argumentos ela aceita.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
Put
WEAVE_ERROR Put( uint64_t tag, uint8_t v, bool preserveSize )
Codifica um valor inteiro sem sinal de TLV.
Essa é uma função de membro sobrecarregada, fornecida por conveniência. Ela só difere da função acima em quais argumentos ela aceita.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
Put
WEAVE_ERROR Put( uint64_t tag, uint16_t v )
Put
WEAVE_ERROR Put( uint64_t tag, uint16_t v, bool preserveSize )
Put
WEAVE_ERROR Put( uint64_t tag, uint32_t v )
Put
WEAVE_ERROR Put( uint64_t tag, uint32_t v, bool preserveSize )
Put
WEAVE_ERROR Put( uint64_t tag, uint64_t v )
Put
WEAVE_ERROR Put( uint64_t tag, uint64_t v, bool preserveSize )
Put
WEAVE_ERROR Put( uint64_t tag, float v )
Put
WEAVE_ERROR Put( uint64_t tag, double v )
Codifica um valor de ponto flutuante TLV.
Essa é uma função de membro sobrecarregada, fornecida por conveniência. Ela só difere da função acima em quais argumentos ela aceita.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
PutBoolean
WEAVE_ERROR PutBoolean( uint64_t tag, bool v )
Codifica um valor booleano TLV.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
PutBytes
WEAVE_ERROR PutBytes( uint64_t tag, const uint8_t *buf, uint32_t len )
Codifica um valor de string de bytes TLV.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
PutNull
WEAVE_ERROR PutNull( uint64_t tag )
Codifica um valor nulo de TLV.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
PutPreEncodedContainer
WEAVE_ERROR PutPreEncodedContainer( uint64_t tag, TLVType containerType, const uint8_t *data, uint32_t dataLen )
Codifica um elemento de contêiner TLV de um conjunto pré-codificado de elementos membros.
O método PutPreEncodedContainer() codifica um novo elemento de contêiner TLV (uma estrutura, matriz ou caminho) que contém um conjunto de elementos de membro retirados de um buffer pré-codificado. Espera-se que o buffer de entrada contenha zero ou mais elementos TLV de codificação completa, com tags que estejam em conformidade com as regras associadas ao tipo de contêiner especificado (por exemplo, os membros da estrutura precisam ter tags, enquanto os membros da matriz não podem).
O método codifica todo o elemento do contêiner em uma chamada. Quando PutPreEncodedContainer() retorna, o objeto de gravação pode ser usado para escrever outros elementos TLV seguindo o elemento de contêiner.
Detalhes | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||||
Valores de retorno |
|
PutString
WEAVE_ERROR PutString( uint64_t tag, const char *buf )
Codifica um valor de string TLV UTF8.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
PutString
WEAVE_ERROR PutString( uint64_t tag, const char *buf, uint32_t len )
Codifica um valor de string TLV UTF8.
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
PutStringF
WEAVE_ERROR PutStringF( uint64_t tag, const char *fmt, ... )
Codifique a saída de string formatada de acordo com o formato no elemento TLV.
PutStringF é análogo a um sprintf, em que a saída é armazenada em um elemento TLV em vez de um buffer de caracteres. Quando a funcionalidade estendida de printf está disponível, a função pode produzir a string de resultados em um armazenamento subjacente não contínuo. A implementação suporta as seguintes melhorias de printf:
A plataforma fornece um vcbprintf
baseado em callback que possibilita chamar um callback personalizado em vez de putchar.
A plataforma fornece uma variante de vsnprintf
chamada vsnprintf_ex
, que se comporta exatamente como vsnprintf, mas tem disposições para omitir os primeiros n
caracteres da saída.
A função baseada em callback pode ser a mais simples e usar a menor quantidade de código, mas a variedade vsprintf_ex
de funções consome menos pilha.
Se nenhuma das opções acima estiver disponível, mas a plataforma fornecer malloc
, a função vai alocar um buffer temporário para armazenar a saída. Quando a plataforma não fornece aprimoramento da família printf nem mapoc, a saída é truncada para se encaixar no estado contínuo no armazenamento TLV atual.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
StartContainer
WEAVE_ERROR StartContainer( uint64_t tag, TLVType containerType, TLVType & outerContainerType )
Começa a codificar um novo elemento de contêiner TLV.
O método StartContainer() é usado para gravar elementos de contêiner TLV (estrutura, matrizes ou caminhos) em uma codificação. O método usa o tipo e a tag (se houver) do novo contêiner e uma referência a um valor TLVType, que será usado para salvar o contexto atual da gravação enquanto ele está sendo usado para criar o contêiner.
Depois que o método StartContainer() for retornado, o aplicativo deverá usar o objeto TLVWriter atual para gravar os elementos do contêiner. Quando terminar, o aplicativo precisará chamar o método EndContainer() para finalizar a codificação do contêiner.
Detalhes | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||||
Valores de retorno |
|
StartPutBytes
WEAVE_ERROR StartPutBytes( uint64_t tag, uint32_t totalLen )
Codifica uma string de bytes TLV em vários blocos.
Deve ser usado com ContinuePutBytes
Detalhes | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||
Valores de retorno |
|
VPutStringF
WEAVE_ERROR VPutStringF( uint64_t tag, const char *fmt, va_list ap )
Codifique a saída de string formatada de acordo com o formato no elemento TLV.
PutStringF é análogo a um sprintf, em que a saída é armazenada em um elemento TLV em vez de um buffer de caracteres. Quando a funcionalidade estendida de printf está disponível, a função pode produzir a string de resultados em um armazenamento subjacente não contínuo. A implementação suporta as seguintes melhorias de printf:
A plataforma fornece um vcbprintf
baseado em callback que possibilita chamar um callback personalizado em vez de putchar.
A plataforma fornece uma variante de vsnprintf
chamada vsnprintf_ex
, que se comporta exatamente como vsnprintf, mas tem disposições para omitir os primeiros n
caracteres da saída.
A função baseada em callback pode ser a mais simples e usar a menor quantidade de código, mas a variedade vsprintf_ex
de funções consome menos pilha.
Se nenhuma das opções acima estiver disponível, mas a plataforma fornecer malloc
, a função vai alocar um buffer temporário para armazenar a saída. Quando a plataforma não fornece aprimoramento da família printf nem mapoc, a saída é truncada para se encaixar no estado contínuo no armazenamento TLV atual.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||
Valores de retorno |
|
Funções estáticas públicas
FinalizePacketBuffer
WEAVE_ERROR FinalizePacketBuffer( TLVWriter & writer, uintptr_t bufHandle, uint8_t *bufStart, uint32_t dataLen )
Uma implementação de uma função FinalizeBuffer TLVWriter para gravar em uma cadeia de PackageBuffers.
A função FinalizePacketBuffer() executa a finalização necessária necessária ao usar um TLVWriter para gravar em uma cadeia de BundlesBuffers. A função foi projetada para ser usada em conjunto com a função GetNewPacketBuffer().
Consulte a definição do tipo FinalizeBufferFunct para mais informações sobre a API da função FinalizePacketBuffer().
GetNewBuffer_Malloced
WEAVE_ERROR GetNewBuffer_Malloced( TLVWriter & writer, uintptr_t & bufHandle, uint8_t *& bufStart, uint32_t & bufLen )
Uma implementação de uma função GetNewBuffer TLVWriter para gravar em um buffer dinâmico.
A função GetNewBuffer_Malloced() fornece um novo espaço de saída a um TLVWriter, dobrando o tamanho do buffer dinâmico subjacente conforme necessário para armazenar a codificação. A função foi projetada para ser atribuída ao ponteiro da função TLVWriter GetNewBuffer.
Consulte a definição do tipo GetNewBufferFunct para ver mais informações sobre a API da função GetNewBuffer_Malloced().
GetNewPacketBuffer
WEAVE_ERROR GetNewPacketBuffer( TLVWriter & writer, uintptr_t & bufHandle, uint8_t *& bufStart, uint32_t & bufLen )
Uma implementação de uma função GetNewBuffer TLVWriter para gravar em uma cadeia de pacotesBuffers.
A função GetNewPacketBuffer() fornece um novo espaço de saída para um TLVWriter, alocando uma cadeia de um ou mais PackageBuffers, conforme necessário, para armazenar a codificação. A função foi projetada para ser atribuída ao ponteiro da função TLVWriter GetNewBuffer.
Ao usar o GetNewPacketBuffer com um TLVWriter, a função FinalizePacketBuffer() correspondente (ou equivalente) também deve ser usada para finalizar a cadeia do buffer.
Consulte a definição do tipo GetNewBufferFunct para ver mais informações sobre a API da função GetNewPacketBuffer().
Funções protegidas
IsCloseContainerReserved
bool IsCloseContainerReserved( void ) const
Determine se o contêiner deve reservar espaço para o símbolo CloseContainer no ponto de partida / abertura dele.
IsContainerOpen
bool IsContainerOpen( void ) const
SetCloseContainerReserved
void SetCloseContainerReserved( bool aCloseContainerReserved )
Defina se o contêiner precisa reservar o espaço para o símbolo "CloseContainer" no ponto de início / abertura dele.
SetContainerOpen
void SetContainerOpen( bool aContainerOpen )
WriteData
WEAVE_ERROR WriteData( const uint8_t *p, uint32_t len )
WriteElementHead
WEAVE_ERROR WriteElementHead( TLVElementType elemType, uint64_t tag, uint64_t lenOrVal )
WriteElementWithData
WEAVE_ERROR WriteElementWithData( TLVType type, uint64_t tag, const uint8_t *data, uint32_t dataLen )