En Google, luchamos por la equidad racial de la comunidad negra. Más información
Se usó la API de Cloud Translation para traducir esta página.
Switch to English

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

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

El mensaje SendInit se utiliza 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 a SendInit los metadatos que desee.

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
Metadatos TLV opcionales.
mMetaDataAppState
void *
Estado de la aplicación opcional para metadatos TLV .
mMetaDataWriteCallback
Función opcional para escribir metadatos TLV .
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)
Inicialice un SendInit "ancho".
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 "no ancho" (desplazamiento de inicio 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)
Inicialice un SendInit "ancho".
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 "no ancho" (desplazamiento de inicio de 32 bits, longitud de 32 bits)
operator== (const SendInit &) const
bool
Comparación de igualdad entre mensajes SendInit .
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)
Analizar 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 a SendInit los metadatos que desee.

El cliente es libre de suministrar TLV precodificado (más rápido), codificar sobre la marcha (usa menos memoria), codificar en forma diferida (un poco más rápido en el inicio), etc., como mejor le parezca.

En todos los casos, se supone que los datos producidos por la devolución de llamada son constantes para un SendInit dado, es decir, no cambian independientemente de cuándo se llame. Esto se debe a que la devolución de llamada también se utiliza para calcular la longitud de dicho TLV escrito, que podría solicitarse en cualquier momento.

Detalles
Parámetros
[in] aBuffer
El búfer de destino, en el que se pueden escribir algunos TLV
[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

Metadatos TLV opcionales.

mMetaDataAppState

void * mMetaDataAppState

Estado de la aplicación opcional para metadatos TLV .

mMetaDataWriteCallback

MetaDataTLVWriteCallback mMetaDataWriteCallback

Función opcional para escribir metadatos TLV .

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
)

Inicialice un SendInit "ancho".

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) Datos adicionales en formato TLV
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 SendInit "no ancho" (desplazamiento de inicio 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 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) Datos adicionales en formato TLV
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
)

Inicialice un SendInit "ancho".

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 formato TLV
[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 SendInit "no ancho" (desplazamiento de inicio 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 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 formato TLV
[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 mensajes SendInit .

Detalles
Parámetros
[in] another
Otro mensaje SendInit para comparar este con
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 empaquetar el mensaje SendInit 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
)

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

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