En Google, luchamos por la equidad racial de la comunidad negra. Más información
Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

nl::Weave::Profiles::BDX_Development::

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

Esta estructura contiene miembros de datos que representan una transferencia BDX activa.

Resumen

BdxProtocol usa estos objetos para mantener el estado del protocolo. Los administra el BdxServer, que administra la creación y la inicialización de nuevas transferencias, incluida la administración de conexiones y de intercambios de contexto.

Atributos públicos

mAmInitiator
bool
mAmSender
bool
mAppState
void *
mBlockCounter
uint32_t
El siguiente número de bloque que se espera que reciba una BlockQuery o BlockACK para cuando se realice el envío (una vez que la transferencia haya comenzado oficialmente).
mBytesSent
uint64_t
mExchangeContext
mFileDesignator
archivo/bloquear miembros de datos relacionados ACTIVIDAD: ¿Desea quitar esta información? ¿Deberíamos establecer un contrato con la apariencia que podría tener esta string y cómo se usará? Específicamente, ¿está respaldado por un PacketBuffer? Si es así, probablemente no debería quedarse en toda la XFER, ya que ocupará un pbuf.
mFirstQuery
bool
mHandlers
mIsAccepted
bool
mIsCompletedSuccessfully
bool
mIsInitiated
bool
mIsWideRange
bool
mLength
uint64_t
mMaxBlockSize
uint16_t
mNext)(BDXTransfer &)
mStartOffset
uint64_t
mTransferMode
uint8_t
mVersion
uint8_t

Funciones públicas

DispatchErrorHandler(WEAVE_ERROR anErrorCode)
void
Si el controlador de errores se configuró, llámalo.
DispatchGetBlockHandler(uint64_t *aLength, uint8_t **aDataBlock, bool *aLastBlock)
void
Si se configuró el controlador get get, llámalo.
DispatchPutBlockHandler(uint64_t aLength, uint8_t *aDataBlock, bool aLastBlock)
void
Si se estableció el controlador para bloqueo de bloqueo, llámalo.
DispatchReceiveAccept(ReceiveAccept *aReceiveAcceptMsg)
Los despachadores solo verifican si se configuró un controlador y luego lo llaman si es así.
DispatchRejectHandler(StatusReport *aReport)
void
Si se configuró el controlador de rechazo, llámalo.
DispatchSendAccept(SendAccept *aSendAcceptMsg)
Si se configuró el controlador de aceptación de envíos, llámalo.
DispatchXferDoneHandler(void)
void
Si se configuró el controlador de transferencia, llámalo.
DispatchXferErrorHandler(StatusReport *aXferError)
void
Si el controlador de errores de transferencia se configuró, llámalo.
GetDefaultFlags(bool aExpectResponse)
uint16_t
Esta función muestra las marcas predeterminadas que se enviarán con un mensaje.
IsAsync(void)
bool
 Returns true if this transfer is asynchronous, false otherwise.
IsDriver(void)
bool
 Returns true if this entity (node) is the driver for this transfer, false otherwise.
Reset(void)
void
 Sets all pointers to NULL, resets counters, etc.
SetHandlers(BDXHandlers aHandlers)
void
Esta función establece los controladores en este objeto BDXTransfer.
Shutdown(void)
void
 Shuts down the current transfer, including closing any open ExchangeContext.

Atributos públicos

Mamitador

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::mAmInitiator

Administrador de dispositivos móviles

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::mAmSender

Estado de las apps para dispositivos móviles

void * nl::Weave::Profiles::BDX_Development::BDXTransfer::mAppState

Contador móvil

uint32_t nl::Weave::Profiles::BDX_Development::BDXTransfer::mBlockCounter

El siguiente número de bloque que se espera que reciba una BlockQuery o BlockACK para cuando se realice el envío (una vez que la transferencia haya comenzado oficialmente).

Al momento de recibir, es el siguiente BlockSend que esperamos recibir o el último BlockQuery que enviamos (después de que la transferencia se inició oficialmente y la primera consulta enviada).

mBytes enviados

uint64_t nl::Weave::Profiles::BDX_Development::BDXTransfer::mBytesSent

Contexto de intercambio

ExchangeContext * nl::Weave::Profiles::BDX_Development::BDXTransfer::mExchangeContext

MFileDesignator

ReferencedString nl::Weave::Profiles::BDX_Development::BDXTransfer::mFileDesignator

archivo/bloquear miembros de datos relacionados ACTIVIDAD: ¿Desea quitar esta información? ¿Deberíamos establecer un contrato con la apariencia que podría tener esta string y cómo se usará? Específicamente, ¿está respaldado por un PacketBuffer? Si es así, probablemente no debería quedarse en toda la XFER, ya que ocupará un pbuf.

mFirstQuery

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::mFirstQuery

mHandlers

BDXHandlers nl::Weave::Profiles::BDX_Development::BDXTransfer::mHandlers

mISe acepta

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::mIsAccepted

Se completó correctamente

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::mIsCompletedSuccessfully

Inicio mínimo

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::mIsInitiated

Rango de imagen amplio de mIsWide

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::mIsWideRange

longitud m

uint64_t nl::Weave::Profiles::BDX_Development::BDXTransfer::mLength

tamaño máximo de bloque

uint16_t nl::Weave::Profiles::BDX_Development::BDXTransfer::mMaxBlockSize

mNext

WEAVE_ERROR(* nl::Weave::Profiles::BDX_Development::BDXTransfer::mNext)(BDXTransfer &)

mStartOffset

uint64_t nl::Weave::Profiles::BDX_Development::BDXTransfer::mStartOffset

Modo de transferencia

uint8_t nl::Weave::Profiles::BDX_Development::BDXTransfer::mTransferMode

Versión para dispositivos móviles

uint8_t nl::Weave::Profiles::BDX_Development::BDXTransfer::mVersion

Funciones públicas

DispatchErrorHandler

void nl::Weave::Profiles::BDX_Development::BDXTransfer::DispatchErrorHandler(
  WEAVE_ERROR anErrorCode
)

Si el controlador de errores se configuró, llámalo.

Si no la estableces, también cierra la transferencia como un comportamiento predeterminado.

Detalles
Parámetros
[in] anErrorCode
Se procesará el código de error

DispatchGetBlockHandler

void nl::Weave::Profiles::BDX_Development::BDXTransfer::DispatchGetBlockHandler(
  uint64_t *aLength,
  uint8_t **aDataBlock,
  bool *aLastBlock
)

Si se configuró el controlador get get, llámalo.

Detalles
Parámetros
[in] aLength
Longitud del bloque
[in] aDataBlock
Puntero al bloque de datos
[in] aLastBlock
Verdadero si este es el último bloque de la transferencia.

Despachadorparabloquear

void nl::Weave::Profiles::BDX_Development::BDXTransfer::DispatchPutBlockHandler(
  uint64_t aLength,
  uint8_t *aDataBlock,
  bool aLastBlock
)

Si se estableció el controlador para bloqueo de bloqueo, llámalo.

Detalles
Parámetros
[in] aLength
Longitud del bloque
[in] aDataBlock
Puntero al bloque de datos
[in] aLastBlock
Verdadero si este es el último bloque de la transferencia.

DispatchReceiveAccept

WEAVE_ERROR nl::Weave::Profiles::BDX_Development::BDXTransfer::DispatchReceiveAccept(
  ReceiveAccept *aReceiveAcceptMsg
)

Los despachadores solo verifican si se configuró un controlador y luego lo llaman si es así.

Si se configuró el controlador de aceptación de llamadas, llámalo.

Por lo tanto, deben usarse como la interfaz pública para llamar a devoluciones de llamada, que nunca deben ser tocadas directamente por aplicaciones externas. Es posible que una revisión futura de BDXTransfer use un objeto delegado en lugar de almacenar punteros individuales en cada una de las devoluciones de llamada.

Detalles
Parámetros
[in] aReceiveAcceptMsg
Mensaje ReceiveAccept para procesar
Qué muestra
un valor de error

DispatchRejectedHandler

void nl::Weave::Profiles::BDX_Development::BDXTransfer::DispatchRejectHandler(
  StatusReport *aReport
)

Si se configuró el controlador de rechazo, llámalo.

Si no la estableces, también cierra la transferencia como un comportamiento predeterminado.

Detalles
Parámetros
[in] aReport
Mensaje de StatusReport que se procesará

DespacharEnviar

WEAVE_ERROR nl::Weave::Profiles::BDX_Development::BDXTransfer::DispatchSendAccept(
  SendAccept *aSendAcceptMsg
)

Si se configuró el controlador de aceptación de envíos, llámalo.

Detalles
Parámetros
[in] aSendAcceptMsg
Mensaje SendAccept que se procesará
Qué muestra
un valor de error

DispatchXferDoneHandler

void nl::Weave::Profiles::BDX_Development::BDXTransfer::DispatchXferDoneHandler(
  void
)

Si se configuró el controlador de transferencia, llámalo.

Si no la estableces, también cierra la transferencia como un comportamiento predeterminado.

DispatchXferErrorHandler

void nl::Weave::Profiles::BDX_Development::BDXTransfer::DispatchXferErrorHandler(
  StatusReport *aXferError
)

Si el controlador de errores de transferencia se configuró, llámalo.

Si no la estableces, también cierra la transferencia como un comportamiento predeterminado.

Detalles
Parámetros
[in] aXferError
Informe de estado de un error que se procesará

GetDefaultFlags

uint16_t nl::Weave::Profiles::BDX_Development::BDXTransfer::GetDefaultFlags(
  bool aExpectResponse
)

Esta función muestra las marcas predeterminadas que se enviarán con un mensaje.

Detalles
Parámetros
[in] aExpectResponse
Si esperamos una respuesta a este mensaje
Qué muestra
Las marcas que se enviarán

IsAsync

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::IsAsync(
  void
)

 Returns true if this transfer is asynchronous, false otherwise.

Detalles
Qué muestra
Verdadero si la transferencia es asíncrona

IsDriver

bool nl::Weave::Profiles::BDX_Development::BDXTransfer::IsDriver(
  void
)

 Returns true if this entity (node) is the driver for this transfer, false otherwise.

Detalles
Qué muestra
Verdadero si esta entidad es la que impulsa esta transferencia

Restablecer

void nl::Weave::Profiles::BDX_Development::BDXTransfer::Reset(
  void
)

 Sets all pointers to NULL, resets counters, etc.

Se llama cuando se apaga.

SetHandlers

void nl::Weave::Profiles::BDX_Development::BDXTransfer::SetHandlers(
  BDXHandlers aHandlers
)

Esta función establece los controladores en este objeto BDXTransfer.

Siempre debes usar este método en lugar de intentar configurarlos de forma manual, ya que la implementación subyacente de la forma en que se almacenan los punteros de la función del controlador no forma parte de la API pública.

.

Detalles
Parámetros
[in] aHandlers
Estructura de los controladores de devolución de llamada que se llamará

Cierre

void nl::Weave::Profiles::BDX_Development::BDXTransfer::Shutdown(
  void
)

 Shuts down the current transfer, including closing any open ExchangeContext.

Use esta oportunidad para liberar cualquier recurso asociado con esta transferencia y la lógica de su aplicación.