Google se compromete a impulsar la igualdad racial para las comunidades afrodescendientes. Obtén información al respecto.
Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

nl::Weave::Perfiles::BDX_Desarrollo:SendInit

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

El mensaje SendInit se usa para iniciar un intercambio cuando el remitente es el iniciador.

Resumen

Herencia

Subclases conocidas directas: nl::Weave::Profiles::BDX_Development::ReceiveInit

Constructores y destructores

SendInit(void)

Tipos públicos

MetaDataTLVWriteCallback)(uint8_t *aBuffer, uint16_t aBufferLength, uint16_t &aNumBytesWritten, void *aAppState) typedef
MetaDataTLVWriteCallback proporciona un medio por el cual un cliente puede proporcionar un SendInit con los metadatos que desee.

Atributos públicos

mAsynchronousModeSupported
bool
Se asigna el valor true si se admite el modo asíncrono.
mDefiniteLength
bool
Verdadero si el campo de longitud está presente.
mFileDesignator
Es una string que contiene información negociada previamente.
mLength
uint64_t
Longitud propuesta de datos en transferencia, 0 por tiempo indefinido.
mMaxBlockSize
uint16_t
Tamaño de bloque máximo propuesto para la transferencia.
mMetaData
Metadatos opcionales de TLV.
mMetaDataAppState
void *
Estado opcional de la app para los metadatos de TLV.
mMetaDataWriteCallback
Es una función opcional para escribir metadatos TLV.
mReceiverDriveSupported
bool
Se asigna el valor true si se admite la unidad del receptor.
mSenderDriveSupported
bool
Verdadero si podemos admitir la unidad de remitente.
mStartOffset
uint64_t
Compensación de inicio propuesta de datos.
mStartOffsetPresent
bool
Verdadero si está presente el campo de compensación inicial.
mVersion
uint8_t
Versión del protocolo BDX que decidimos.
mWideRange
bool
Verdadero si la compensación y la longitud son de 64 bits.

Funciones 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 un 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 un SendInit (ancho de 32 bits, longitud 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)
Inicializar un 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 un SendInit (ancho de 32 bits, longitud de 32 bits)
operator==(const SendInit &) const
bool
Comparación de igualdad entre mensajes SendInit
pack(PacketBuffer *aBuffer)
Empaqueta un mensaje de inicio de envío en un PacketBuffer.
packedLength(void)
uint16_t
Muestra la longitud empaquetada de este mensaje de envío de init.

Funciones estáticas públicas

parse(PacketBuffer *aBuffer, SendInit & aRequest)
Analiza datos de un PacketBuffer en un formato de mensaje SendInit.

Tipos públicos

MetaDataTLVWriteCallback

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

MetaDataTLVWriteCallback proporciona un medio por el cual un cliente puede proporcionar un SendInit con los metadatos que desee.

El cliente es libre de proporcionar TLV codificado previamente (más rápido), codificar sobre la marcha (usa menos memoria), codificar de forma diferida (una vez más rápido durante el inicio), etc. según su criterio.

En todos los casos, se supone que los datos generados por la devolución de llamada son constantes para un SendInit determinado; es decir, no cambia sin importar cuándo se los llame. Esto se debe a que la devolución de llamada también se usa para calcular la longitud de cualquier TLV escrito que pueda solicitarse en cualquier momento.

Detalles
Parámetros
[in] aBuffer
El búfer de destino, en el que se puede escribir una TLV
[in] aBufferLength
La longitud (en bytes) del búfer de destino
[in,out] aNumBytesWritten
La cantidad de bytes escritos en el búfer de destino
[in] aAppState
Estado de la app proporcionado por el usuario
Valores que se muestran
WEAVE_ERROR
Se produjo un error.

Atributos públicos

mAasyncModeSupported

bool mAsynchronousModeSupported

Se asigna el valor true si se admite el modo asíncrono.

longitud_definida

bool mDefiniteLength

Verdadero si el campo de longitud está presente.

MFileDesignator

ReferencedString mFileDesignator

Es una string que contiene información negociada previamente.

longitud m

uint64_t mLength

Longitud propuesta de datos en transferencia, 0 por tiempo indefinido.

tamaño máximo de bloque

uint16_t mMaxBlockSize

Tamaño de bloque máximo propuesto para la transferencia.

mMetaData

ReferencedTLVData mMetaData

Metadatos opcionales de TLV.

Estado de la aplicación de metadatos

void * mMetaDataAppState

Estado opcional de la app para los metadatos de TLV.

Devolución de llamada de metadatos de datos

MetaDataTLVWriteCallback mMetaDataWriteCallback

Es una función opcional para escribir metadatos TLV.

mReceiverDrive compatible

bool mReceiverDriveSupported

Se asigna el valor true si se admite la unidad del receptor.

Compatible con mSenderDrive

bool mSenderDriveSupported

Verdadero si podemos admitir la unidad de remitente.

mStartOffset

uint64_t mStartOffset

Compensación de inicio propuesta de datos.

mStartOffsetPresent

bool mStartOffsetPresent

Verdadero si está presente el campo de compensación inicial.

Versión para dispositivos móviles

uint8_t mVersion

Versión del protocolo BDX que decidimos.

mWideRange

bool mWideRange

Verdadero si la compensación y la longitud son de 64 bits.

Funciones públicas

EnviarInit

 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
)

Inicializar un SendInit

Detalles
Parámetros
[in] aVersion
Versión de BDX que estamos usando
[in] aSenderDrive
Verdadero si el remitente está conduciendo
[in] aReceiverDrive
Verdadero si el receptor está conduciendo
[in] aAsynchMode
Verdadero si el dispositivo admite el modo asíncrono.
[in] aMaxBlockSize
Propuesta de un tamaño máximo de bloque para esta transferencia
[in] aStartOffset
Inicio del desplazamiento en el archivo que debería comenzar
[in] aLength
Longitud del archivo que se transferirá: 0 significa que tiene una duración indefinida.
[in] aFileDesignator
Una string que identifica los datos que se transferirán
[in] aMetaData
(Opcional) Datos adicionales en formato TLV
Qué muestra
WEAVE_NO_ERROR si se ejecuta correctamente

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 un SendInit (ancho de 32 bits, longitud de 32 bits)

Detalles
Parámetros
[in] aVersion
Versión de BDX que estamos usando
[in] aSenderDrive
Verdadero si el remitente está conduciendo
[in] aReceiverDrive
Verdadero si el receptor está conduciendo
[in] aAsynchMode
Verdadero si el dispositivo admite el modo asíncrono.
[in] aMaxBlockSize
Propuesta de un tamaño máximo de bloque para esta transferencia
[in] aStartOffset
Inicio del desplazamiento en el archivo que debería comenzar
[in] aLength
Longitud del archivo que se transferirá: 0 significa que tiene una duración indefinida.
[in] aFileDesignator
Una string que identifica los datos que se transferirán
[in] aMetaData
(Opcional) Datos adicionales en formato TLV
Qué muestra
WEAVE_NO_ERROR si se ejecuta correctamente

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
)

Inicializar un SendInit

Detalles
Parámetros
[in] aVersion
Versión de BDX que estamos usando
[in] aSenderDrive
Verdadero si el remitente está conduciendo
[in] aReceiverDrive
Verdadero si el receptor está conduciendo
[in] aAsynchMode
Verdadero si el dispositivo admite el modo asíncrono.
[in] aMaxBlockSize
Propuesta de un tamaño máximo de bloque para esta transferencia
[in] aStartOffset
Inicio del desplazamiento en el archivo que debería comenzar
[in] aLength
Longitud del archivo que se transferirá: 0 significa que tiene una duración indefinida.
[in] aFileDesignator
Una string que identifica los datos que se transferirán
[in] aMetaDataWriteCallback
(Opcional) Una función para escribir datos adicionales en formato TLV
[in] aMetaDataAppState
Un contexto opcional para pasar al aMetaDataWriteCallback
Qué muestra
WEAVE_NO_ERROR si se ejecuta correctamente

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 un SendInit (ancho de 32 bits, longitud de 32 bits)

Detalles
Parámetros
[in] aVersion
Versión de BDX que estamos usando
[in] aSenderDrive
Verdadero si el remitente está conduciendo
[in] aReceiverDrive
Verdadero si el receptor está conduciendo
[in] aAsynchMode
Verdadero si el dispositivo admite el modo asíncrono.
[in] aMaxBlockSize
Propuesta de un tamaño máximo de bloque para esta transferencia
[in] aStartOffset
Inicio del desplazamiento en el archivo que debería comenzar
[in] aLength
Longitud del archivo que se transferirá: 0 significa que tiene una duración indefinida.
[in] aFileDesignator
Una string que identifica los datos que se transferirán
[in] aMetaDataWriteCallback
(Opcional) Una función para escribir datos adicionales en formato TLV
[in] aMetaDataAppState
Un contexto para volver a la función de devolución de llamada (opcional)
Qué muestra
WEAVE_NO_ERROR si se ejecuta correctamente

operador==

bool operator==(
  const SendInit &
) const 

Comparación de igualdad entre mensajes SendInit

Detalles
Parámetros
[in] another
Otro mensaje de SendInit para comparar este mensaje
Qué muestra
true si tiene los mismos campos.

paquete

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

Empaqueta un mensaje de inicio de envío en un PacketBuffer.

Detalles
Parámetros
[out] aBuffer
Un PacketBuffer para empaquetar el mensaje SendInit
Valores que se muestran
WEAVE_NO_ERROR
Si tiene éxito
WEAVE_ERROR_BUFFER_TOO_SMALL
Si el búfer es demasiado pequeño

Longitud del paquete

uint16_t packedLength(
  void
)

Muestra la longitud empaquetada de este mensaje de envío de init.

Detalles
Qué muestra
longitud del mensaje cuando se empaqueta

Funciones estáticas públicas

parse

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  SendInit & aRequest
)

Analiza datos de un PacketBuffer en un formato de mensaje SendInit.

Detalles
Parámetros
[in] aBuffer
Es un puntero a un PacketBuffer que tiene los datos que queremos analizar.
[out] aRequest
Es el puntero a un objeto SendInit en el que deberíamos almacenar los resultados.
Valores que se muestran
WEAVE_NO_ERROR
Si tiene éxito
WEAVE_ERROR_BUFFER_TOO_SMALL
Si el búfer es demasiado pequeño