nl:: Weave:: Profiles:: BDX_Development:: SendInit
#include <src/lib/profiles/bulk-data-transfer/Development/BDXMessages.h>
A mensagem SendInit é usada para iniciar uma troca quando o remetente é o iniciador.
Resumo
Herança
Subclasses conhecidas conhecidas: nl::Weave::Profiles::BDX_Development::ReceiveInit
Construtores e destruidores |
|
---|---|
SendInit(void)
|
Tipos públicos |
|
---|---|
MetaDataTLVWriteCallback)(uint8_t *aBuffer, uint16_t aBufferLength, uint16_t &aNumBytesWritten, void *aAppState)
|
typedef MetaDataTLVWriteCallback fornece um meio pelo qual um cliente pode fornecer um SendInit com todos os metadados que ele quiser. |
Atributos públicos |
|
---|---|
mAsynchronousModeSupported
|
bool
Verdadeiro se for compatível com o modo assíncrono.
|
mDefiniteLength
|
bool
Verdadeiro se o campo de comprimento estiver presente.
|
mFileDesignator
|
String que contém informações pré-negociadas.
|
mLength
|
uint64_t
Comprimento proposto dos dados na transferência, 0 para um valor indefinido.
|
mMaxBlockSize
|
uint16_t
É o tamanho máximo do bloco proposto para uso na transferência.
|
mMetaData
|
Metadados TLV opcionais.
|
mMetaDataAppState
|
void *
Estado opcional do app para metadados TLV.
|
mMetaDataWriteCallback
|
Função opcional para gravar os metadados TLV.
|
mReceiverDriveSupported
|
bool
Verdadeiro se for compatível com o drive receptor.
|
mSenderDriveSupported
|
bool
Verdadeiro se for possível fazer isso.
|
mStartOffset
|
uint64_t
Deslocamento inicial proposto de dados.
|
mStartOffsetPresent
|
bool
Verdadeiro se o campo de deslocamento inicial estiver presente.
|
mVersion
|
uint8_t
Versão do protocolo BDX que decidimos.
|
mWideRange
|
bool
Verdadeiro se o deslocamento e o comprimento forem 64 bits.
|
Funções públicas |
|
---|---|
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
|
Inicialize um SendInit "wide"
|
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint32_t aStartOffset, uint32_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
|
Inicializar um SendInit "sem largura (compensação de 32 bits, comprimento de 32 bits)
|
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, MetaDataTLVWriteCallback aMetaDataWriteCallback, void *aMetaDataAppState)
|
Inicialize um SendInit "wide"
|
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint32_t aStartOffset, uint32_t aLength, ReferencedString & aFileDesignator, MetaDataTLVWriteCallback aMetaDataWriteCallback, void *aMetaDataAppState)
|
Inicializar um SendInit "sem largura (compensação de 32 bits, comprimento de 32 bits)
|
operator==(const SendInit &) const
|
bool
Comparação de igualdade entre mensagens SendInit.
|
pack(PacketBuffer *aBuffer)
|
Empacotar uma mensagem de envio de init em um PackageBuffer.
|
packedLength(void)
|
uint16_t
Retorna o tamanho compactado desta mensagem init de envio.
|
Funções estáticas públicas |
|
---|---|
parse(PacketBuffer *aBuffer, SendInit & aRequest)
|
Analisar dados de um PackageBuffer em um formato de mensagem SendInit.
|
Tipos públicos
CallbackDataTLVWriteCallback
WEAVE_ERROR(* MetaDataTLVWriteCallback)(uint8_t *aBuffer, uint16_t aBufferLength, uint16_t &aNumBytesWritten, void *aAppState)
MetaDataTLVWriteCallback fornece um meio pelo qual um cliente pode fornecer um SendInit com todos os metadados que ele quiser.
O cliente é livre para fornecer o TLV (mais rápido) codificado, mais rápido na codificação (usa menos memória), codificação lenta (uma velocidade mais rápida na inicialização) etc. quando achar adequado.
Em todos os casos, presume-se que os dados produzidos pelo callback sejam constantes para um determinado SendInit, ou seja, que não muda quando é chamado. Isso ocorre porque o callback também é usado para calcular o tamanho de qualquer TLV gravado, que pode ser solicitado a qualquer momento.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
Atributos públicos
mAsyncModeSupported
bool mAsynchronousModeSupported
Verdadeiro se for compatível com o modo assíncrono.
mDefiniteLength
bool mDefiniteLength
Verdadeiro se o campo de comprimento estiver presente.
mComprimento
uint64_t mLength
Comprimento proposto dos dados na transferência, 0 para um valor indefinido.
mMaxBlockSize
uint16_t mMaxBlockSize
É o tamanho máximo do bloco proposto para uso na transferência.
mMetaDataWriteCallback
MetaDataTLVWriteCallback mMetaDataWriteCallback
Função opcional para gravar os metadados TLV.
mReceiverDriveSupported
bool mReceiverDriveSupported
Verdadeiro se for compatível com o drive receptor.
mSenderDriveSupported
bool mSenderDriveSupported
Verdadeiro se for possível fazer isso.
mStartOffset
uint64_t mStartOffset
Deslocamento inicial proposto de dados.
mStartOffsetPresent
bool mStartOffsetPresent
Verdadeiro se o campo de deslocamento inicial estiver presente.
Versão m
uint8_t mVersion
Versão do protocolo BDX que decidimos.
mWideRange
bool mWideRange
Verdadeiro se o deslocamento e o comprimento forem 64 bits.
Funções públicas
SendInit.
SendInit( void )
init
WEAVE_ERROR init( uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData )
Inicialize um SendInit "wide"
Detalhes | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||||||||
Retorna |
WEAVE_NO_ERROR em caso de sucesso
|
init
WEAVE_ERROR init( uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint32_t aStartOffset, uint32_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData )
Inicializar um SendInit "sem largura (compensação de 32 bits, comprimento de 32 bits)
Detalhes | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||||||||
Retorna |
WEAVE_NO_ERROR em caso de sucesso
|
init
WEAVE_ERROR init( uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, MetaDataTLVWriteCallback aMetaDataWriteCallback, void *aMetaDataAppState )
Inicialize um SendInit "wide"
Detalhes | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||||||||||
Retorna |
WEAVE_NO_ERROR em caso de sucesso
|
init
WEAVE_ERROR init( uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint32_t aStartOffset, uint32_t aLength, ReferencedString & aFileDesignator, MetaDataTLVWriteCallback aMetaDataWriteCallback, void *aMetaDataAppState )
Inicializar um SendInit "sem largura (compensação de 32 bits, comprimento de 32 bits)
Detalhes | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||||||||||||||
Retorna |
WEAVE_NO_ERROR em caso de sucesso
|
operador==
bool operator==( const SendInit & ) const
pacote
WEAVE_ERROR pack( PacketBuffer *aBuffer )
Empacotar uma mensagem de envio de init em um PackageBuffer.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|
LengthLength
uint16_t packedLength( void )
Retorna o tamanho compactado desta mensagem init de envio.
Detalhes | |
---|---|
Retorna |
tamanho da mensagem quando ela está cheia;
|
Funções estáticas públicas
parse
WEAVE_ERROR parse( PacketBuffer *aBuffer, SendInit & aRequest )
Analisar dados de um PackageBuffer em um formato de mensagem SendInit.
Detalhes | |||||
---|---|---|---|---|---|
Parâmetros |
|
||||
Valores de retorno |
|