En Google, luchamos por la equidad racial de la comunidad negra. Más información

nl :: Tejido:: Perfiles: BDX_Development :: SendInit

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

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

Resumen

Herencia

Las subclases dirigir conocidos: nl :: Armadura :: Perfiles :: :: 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 suministrar una SendInit con los metadatos que quieren.

Atributos públicos

mAsynchronousModeSupported
bool
Es cierto si podemos admitir el modo asíncrono.
mDefiniteLength
bool
Verdadero si el campo de longitud está presente.
mFileDesignator
Cadena que contiene información negociada previamente.
mLength
uint64_t
Longitud propuesta de los datos en transferencia, 0 para indefinidos.
mMaxBlockSize
uint16_t
Tamaño de bloque máximo propuesto para usar en la transferencia.
mMetaData
Opcional TLV metadatos.
mMetaDataAppState
void *
Estado de la aplicación opcional para TLV de metadatos.
mMetaDataWriteCallback
Función opcional para escribir TLV metadatos.
mReceiverDriveSupported
bool
Es cierto si podemos admitir la unidad del receptor.
mSenderDriveSupported
bool
Es cierto si podemos admitir la unidad del remitente.
mStartOffset
uint64_t
Desplazamiento de inicio propuesto de los datos.
mStartOffsetPresent
bool
Verdadero si el campo de compensación inicial está presente.
mVersion
uint8_t
Versión del protocolo BDX que decidimos.
mWideRange
bool
Verdadero si el desplazamiento y la longitud son de 64 bits.

Funciones publicas

init (uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
Iniciar una "amplia" 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 "no-amplia" SendInit (32 bits desplazamiento inicial, 32 bits de longitud)
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)
Iniciar una "amplia" 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 "no-amplia" SendInit (32 bits desplazamiento inicial, 32 bits de longitud)
operator== (const SendInit &) const
bool
Comparación de igualdad entre SendInit mensajes.
pack (PacketBuffer *aBuffer)
Empaquete un mensaje de inicio de envío en un PacketBuffer.
packedLength (void)
uint16_t
Devuelve la longitud empaquetada de este mensaje de inicio de envío.

Funciones estáticas públicas

parse (PacketBuffer *aBuffer, SendInit & aRequest)
Los datos de análisis sintáctico de un PacketBuffer en un SendInit formato de mensaje.

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 suministrar una SendInit con los metadatos que quieren.

El cliente es libre de suministrar pre-codificada TLV (más rápido), codificación de la marcha (usa menos memoria), perezoso a codificar (un peq más rápido en el arranque), etc., como mejor les parezca.

En todos los casos, se supone que los datos producidos por la devolución de llamada es constante para un determinado SendInit , es decir, no cambia no importa cuando se le llama. Esto se debe a que la devolución de llamada también se utiliza para calcular la longitud de cualquiera de tales escritos a cabo TLV , lo que podría ser solicitada en cualquier momento.

Detalles
Parámetros
[in] aBuffer
El búfer de destino, en el que algunos TLV puede escribirse
[in] aBufferLength
La longitud (en bytes) del búfer de destino
[in,out] aNumBytesWritten
El número de bytes escritos en el búfer de destino.
[in] aAppState
Estado de la aplicación proporcionada por el usuario
Valores devueltos
WEAVE_ERROR
Cualquier error encontrado.

Atributos públicos

mAsynchronousModeSupported

bool mAsynchronousModeSupported

Es cierto si podemos admitir el modo asíncrono.

mDefiniteLength

bool mDefiniteLength

Verdadero si el campo de longitud está presente.

mFileDesignator

ReferencedString mFileDesignator

Cadena que contiene información negociada previamente.

mLength

uint64_t mLength

Longitud propuesta de los datos en transferencia, 0 para indefinidos.

mMaxBlockSize

uint16_t mMaxBlockSize

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

mMetaData

ReferencedTLVData mMetaData

Opcional TLV metadatos.

mMetaDataAppState

void * mMetaDataAppState

Estado de la aplicación opcional para TLV de metadatos.

mMetaDataWriteCallback

MetaDataTLVWriteCallback mMetaDataWriteCallback

Función opcional para escribir TLV metadatos.

mReceiverDriveSupported

bool mReceiverDriveSupported

Es cierto si podemos admitir la unidad del receptor.

mSenderDriveSupported

bool mSenderDriveSupported

Es cierto si podemos admitir la unidad del remitente.

mStartOffset

uint64_t mStartOffset

Desplazamiento de inicio propuesto de los datos.

mStartOffsetPresent

bool mStartOffsetPresent

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

mVersion

uint8_t mVersion

Versión del protocolo BDX que decidimos.

mWideRange

bool mWideRange

Verdadero si el desplazamiento y la longitud son de 64 bits.

Funciones publicas

SendInit

 SendInit(
  void
)

en eso

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
)

Iniciar una "amplia" 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 asincrónico
[in] aMaxBlockSize
Propuesta de un tamaño de bloque máximo para esta transferencia
[in] aStartOffset
Comience offset en el archivo en el que deberíamos comenzar
[in] aLength
Longitud del archivo que se va a transferir: 0 significa que tiene una longitud indefinida
[in] aFileDesignator
Una cadena que identifica los datos que se van a transferir.
[in] aMetaData
(opcional) de datos adicional en TLV formato
Devoluciones
WEAVE_NO_ERROR si tiene éxito

en eso

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 "no-amplia" SendInit (32 bits desplazamiento inicial, 32 bits de longitud)

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 asincrónico
[in] aMaxBlockSize
Propuesta de un tamaño de bloque máximo para esta transferencia
[in] aStartOffset
Comience offset en el archivo en el que deberíamos comenzar
[in] aLength
Longitud del archivo que se va a transferir: 0 significa que tiene una longitud indefinida
[in] aFileDesignator
Una cadena que identifica los datos que se van a transferir.
[in] aMetaData
(opcional) de datos adicional en TLV formato
Devoluciones
WEAVE_NO_ERROR si tiene éxito

en eso

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
)

Iniciar una "amplia" 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 asincrónico
[in] aMaxBlockSize
Propuesta de un tamaño de bloque máximo para esta transferencia
[in] aStartOffset
Comience offset en el archivo en el que deberíamos comenzar
[in] aLength
Longitud del archivo que se va a transferir: 0 significa que tiene una longitud indefinida
[in] aFileDesignator
Una cadena que identifica los datos que se van a transferir.
[in] aMetaDataWriteCallback
(opcional) Una función para escribir datos adicionales en TLV formato
[in] aMetaDataAppState
Un contexto opcional que se pasará a aMetaDataWriteCallback
Devoluciones
WEAVE_NO_ERROR si tiene éxito

en eso

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 "no-amplia" SendInit (32 bits desplazamiento inicial, 32 bits de longitud)

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 asincrónico
[in] aMaxBlockSize
Propuesta de un tamaño de bloque máximo para esta transferencia
[in] aStartOffset
Comience offset en el archivo en el que deberíamos comenzar
[in] aLength
Longitud del archivo que se va a transferir: 0 significa que tiene una longitud indefinida
[in] aFileDesignator
Una cadena que identifica los datos que se van a transferir.
[in] aMetaDataWriteCallback
(opcional) Una función para escribir datos adicionales en TLV formato
[in] aMetaDataAppState
(opcional) Un contexto para volver a pasar a la función de devolución de llamada
Devoluciones
WEAVE_NO_ERROR si tiene éxito

operador ==

bool operator==(
  const SendInit &
) const 

Comparación de igualdad entre SendInit mensajes.

Detalles
Parámetros
[in] another
Otra SendInit mensaje a comparar a éste
Devoluciones
Es cierto si tienen todos los mismos campos.

paquete

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

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

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

PackagingLength

uint16_t packedLength(
  void
)

Devuelve la longitud empaquetada de este mensaje de inicio de envío.

Detalles
Devoluciones
longitud del mensaje cuando está empaquetado

Funciones estáticas públicas

analizar gramaticalmente

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  SendInit & aRequest
)

Los datos de análisis sintáctico de un PacketBuffer en un SendInit formato de mensaje.

Detalles
Parámetros
[in] aBuffer
Puntero a un PacketBuffer que tiene los datos que queremos analizar
[out] aRequest
Puntero a una SendInit objeto donde debemos almacenar los resultados
Valores devueltos
WEAVE_NO_ERROR
Si tiene éxito
WEAVE_ERROR_BUFFER_TOO_SMALL
Si el búfer es demasiado pequeño