O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.

nl :: Tecer:: Perfis :: BDX_Development :: SendInit

#include <src/lib/profiles/bulk-data-transfer/Development/BDXMessages.h>

O SendInit mensagem é usado para iniciar uma troca quando o remetente é o iniciador.

Resumo

Herança

Dirigir Subclasses 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 uma SendInit com quaisquer metadados que eles querem.

Atributos públicos

mAsynchronousModeSupported
bool
Verdadeiro se pudermos oferecer suporte ao modo assíncrono.
mDefiniteLength
bool
Verdadeiro se o campo de comprimento estiver presente.
mFileDesignator
String contendo informações pré-negociadas.
mLength
uint64_t
Comprimento proposto de dados na transferência, 0 para indefinido.
mMaxBlockSize
uint16_t
Tamanho máximo do bloco proposto para uso na transferência.
mMetaData
Opcional TLV Metadados.
mMetaDataAppState
void *
Estado do aplicativo opcional para TLV Metadados.
mMetaDataWriteCallback
Função opcional para escrever TLV Metadados.
mReceiverDriveSupported
bool
Verdadeiro se pudermos oferecer suporte à unidade do receptor.
mSenderDriveSupported
bool
Verdadeiro se pudermos oferecer suporte à unidade do remetente.
mStartOffset
uint64_t
Deslocamento inicial de dados proposto.
mStartOffsetPresent
bool
Verdadeiro se o campo de deslocamento inicial estiver presente.
mVersion
uint8_t
A versão do protocolo BDX que escolhemos.
mWideRange
bool
Verdadeiro se o deslocamento e o comprimento forem de 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)
Inicializar uma "ampla" SendInit .
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 "não panorâmico" SendInit (32 bit de início offset, 32 bits de comprimento)
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)
Inicializar uma "ampla" SendInit .
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 "não panorâmico" SendInit (32 bit de início offset, 32 bits de comprimento)
operator== (const SendInit &) const
bool
Comparação de igualdade entre SendInit mensagens.
pack (PacketBuffer *aBuffer)
Empacote uma mensagem de inicialização de envio em um PacketBuffer.
packedLength (void)
uint16_t
Retorna o comprimento compactado desta mensagem de inicialização de envio.

Funções estáticas públicas

parse (PacketBuffer *aBuffer, SendInit & aRequest)
Dados de análise de uma PacketBuffer em um SendInit formato de mensagem.

Tipos públicos

MetaDataTLVWriteCallback

WEAVE_ERROR(* MetaDataTLVWriteCallback)(uint8_t *aBuffer, uint16_t aBufferLength, uint16_t &aNumBytesWritten, void *aAppState)

MetaDataTLVWriteCallback fornece um meio pelo qual um cliente pode fornecer uma SendInit com quaisquer metadados que eles querem.

O cliente é livre para fornecer pré-codificado TLV (mais rápido), codificar on-the-fly (usa menos memória), lazy-codificar (a littl mais rápido na inicialização), etc. como entenderem.

Em todos os casos, presume-se que os dados produzidos pelo retorno de chamada é constante para um dado SendInit , ou seja, não muda, não importa quando é chamado. Isto é porque a chamada de retorno também é utilizado para calcular o comprimento de qualquer escrito-out TLV , que podem ser solicitados a qualquer momento.

Detalhes
Parâmetros
[in] aBuffer
O buffer de destino, no qual alguns TLV pode ser escrito
[in] aBufferLength
O comprimento (em bytes) do buffer de destino
[in,out] aNumBytesWritten
O número de bytes gravados no buffer de destino
[in] aAppState
Estado do aplicativo fornecido pelo usuário
Valores Retornados
WEAVE_ERROR
Qualquer erro encontrado.

Atributos públicos

mAsynchronousModeSupported

bool mAsynchronousModeSupported

Verdadeiro se pudermos suportar o modo assíncrono.

mDefiniteLength

bool mDefiniteLength

Verdadeiro se o campo de comprimento estiver presente.

mFileDesignator

ReferencedString mFileDesignator

String contendo informações pré-negociadas.

mLength

uint64_t mLength

Comprimento proposto de dados na transferência, 0 para indefinido.

mMaxBlockSize

uint16_t mMaxBlockSize

Tamanho máximo do bloco proposto para uso na transferência.

mMetaData

ReferencedTLVData mMetaData

Opcional TLV Metadados.

mMetaDataAppState

void * mMetaDataAppState

Estado do aplicativo opcional para TLV Metadados.

mMetaDataWriteCallback

MetaDataTLVWriteCallback mMetaDataWriteCallback

Função opcional para escrever TLV Metadados.

mReceiverDriveSupported

bool mReceiverDriveSupported

Verdadeiro se pudermos oferecer suporte à unidade do receptor.

mSenderDriveSupported

bool mSenderDriveSupported

Verdadeiro se pudermos oferecer suporte à unidade do remetente.

mStartOffset

uint64_t mStartOffset

Deslocamento inicial de dados proposto.

mStartOffsetPresent

bool mStartOffsetPresent

Verdadeiro se o campo de deslocamento inicial estiver presente.

mVersion

uint8_t mVersion

A versão do protocolo BDX que escolhemos.

mWideRange

bool mWideRange

Verdadeiro se o deslocamento e o comprimento forem de 64 bits.

Funções públicas

SendInit

 SendInit(
  void
)

iniciar

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
)

Inicializar uma "ampla" SendInit .

Detalhes
Parâmetros
[in] aVersion
Versão do BDX que estamos usando
[in] aSenderDrive
Verdadeiro se o remetente estiver dirigindo
[in] aReceiverDrive
Verdadeiro se o receptor estiver dirigindo
[in] aAsynchMode
Verdadeiro se o dispositivo for compatível com o modo assíncrono
[in] aMaxBlockSize
Proposta para um tamanho máximo de bloco para esta transferência
[in] aStartOffset
Comece a compensação no arquivo em que devemos começar
[in] aLength
Comprimento do arquivo a ser transferido - 0 significa que tem comprimento indefinido
[in] aFileDesignator
Uma string que identifica os dados a serem transferidos
[in] aMetaData
(opcional) Dados adicionais em TLV formato
Devoluções
WEAVE_NO_ERROR se bem sucedida

iniciar

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 "não panorâmico" SendInit (32 bit de início offset, 32 bits de comprimento)

Detalhes
Parâmetros
[in] aVersion
Versão do BDX que estamos usando
[in] aSenderDrive
Verdadeiro se o remetente estiver dirigindo
[in] aReceiverDrive
Verdadeiro se o receptor estiver dirigindo
[in] aAsynchMode
Verdadeiro se o dispositivo for compatível com o modo assíncrono
[in] aMaxBlockSize
Proposta para um tamanho máximo de bloco para esta transferência
[in] aStartOffset
Comece a compensação no arquivo em que devemos começar
[in] aLength
Comprimento do arquivo a ser transferido - 0 significa que tem comprimento indefinido
[in] aFileDesignator
Uma string que identifica os dados a serem transferidos
[in] aMetaData
(opcional) Dados adicionais em TLV formato
Devoluções
WEAVE_NO_ERROR se bem sucedida

iniciar

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
)

Inicializar uma "ampla" SendInit .

Detalhes
Parâmetros
[in] aVersion
Versão do BDX que estamos usando
[in] aSenderDrive
Verdadeiro se o remetente estiver dirigindo
[in] aReceiverDrive
Verdadeiro se o receptor estiver dirigindo
[in] aAsynchMode
Verdadeiro se o dispositivo for compatível com o modo assíncrono
[in] aMaxBlockSize
Proposta para um tamanho máximo de bloco para esta transferência
[in] aStartOffset
Comece o deslocamento no arquivo em que devemos começar
[in] aLength
Comprimento do arquivo a ser transferido - 0 significa que tem comprimento indefinido
[in] aFileDesignator
Uma string que identifica os dados a serem transferidos
[in] aMetaDataWriteCallback
(opcional) A função para escrever dados adicionais no TLV formato
[in] aMetaDataAppState
Um contexto opcional a ser passado para aMetaDataWriteCallback
Devoluções
WEAVE_NO_ERROR se bem sucedida

iniciar

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 "não panorâmico" SendInit (32 bit de início offset, 32 bits de comprimento)

Detalhes
Parâmetros
[in] aVersion
Versão do BDX que estamos usando
[in] aSenderDrive
Verdadeiro se o remetente estiver dirigindo
[in] aReceiverDrive
Verdadeiro se o receptor estiver dirigindo
[in] aAsynchMode
Verdadeiro se o dispositivo for compatível com o modo assíncrono
[in] aMaxBlockSize
Proposta para um tamanho máximo de bloco para esta transferência
[in] aStartOffset
Comece o deslocamento no arquivo em que devemos começar
[in] aLength
Comprimento do arquivo a ser transferido - 0 significa que tem comprimento indefinido
[in] aFileDesignator
Uma string que identifica os dados a serem transferidos
[in] aMetaDataWriteCallback
(opcional) A função para escrever dados adicionais no TLV formato
[in] aMetaDataAppState
(opcional) Um contexto a ser passado de volta para a função de retorno de chamada
Devoluções
WEAVE_NO_ERROR se bem sucedida

operador ==

bool operator==(
  const SendInit &
) const 

Comparação de igualdade entre SendInit mensagens.

Detalhes
Parâmetros
[in] another
Outra SendInit mensagem para comparar este a
Devoluções
verdadeiro se eles tiverem todos os mesmos campos.

pacote

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

Empacote uma mensagem de inicialização de envio em um PacketBuffer.

Detalhes
Parâmetros
[out] aBuffer
Um PacketBuffer para embalar o SendInit mensagem
Valores Retornados
WEAVE_NO_ERROR
Se for bem sucedido
WEAVE_ERROR_BUFFER_TOO_SMALL
Se o buffer for muito pequeno

PackedLength

uint16_t packedLength(
  void
)

Retorna o comprimento compactado desta mensagem de inicialização de envio.

Detalhes
Devoluções
comprimento da mensagem quando embalada

Funções estáticas públicas

analisar

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  SendInit & aRequest
)

Dados de análise de uma PacketBuffer em um SendInit formato de mensagem.

Detalhes
Parâmetros
[in] aBuffer
Ponteiro para um PacketBuffer que tem os dados que queremos analisar
[out] aRequest
Ponteiro para um SendInit objeto onde devemos armazenar os resultados
Valores Retornados
WEAVE_NO_ERROR
Se for bem sucedido
WEAVE_ERROR_BUFFER_TOO_SMALL
Se o buffer for muito pequeno