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

Resumen

Funciones
HandleConnectionClosed(ExchangeContext *anEc, WeaveConnection *aCon, WEAVE_ERROR aConErr)
void
Controlador para cuando se cierra la conexión.
HandleKeyError(ExchangeContext *anEc, WEAVE_ERROR aKeyErr)
void
Controlador para cuando la clave que se usa para encriptar y autenticar mensajes de Weave ya no se puede usar.
HandleResponse(ExchangeContext *anEc, const IPPacketInfo *aPktInfo, const WeaveMessageInfo *aWeaveMsgInfo, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer *aPacketBuffer)
void
Es el controlador principal de los mensajes que llegan al intercambio de BDX.
HandleResponseNotAccepted(BDXTransfer & aXfer, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer *aPacketBuffer)
HandleResponseReceive(BDXTransfer & aXfer, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer *aPacketBuffer)
HandleResponseTimeout(ExchangeContext *anEc)
void
Controlador para cuando se agota el tiempo de espera de una respuesta.
HandleResponseTransmit(BDXTransfer & aXfer, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer *aPacketBuffer)
HandleSendError(ExchangeContext *anEc, WEAVE_ERROR aSendErr, void *aMsgCtxt)
void
Controlador para cuando no se confirmó el mensaje WRMP que enviamos.
InitBdxReceive(BDXTransfer & aXfer, bool aICanDrive, bool aUCanDrive, bool aAsyncOk, ReferencedTLVData *aMetaData)
InitBdxSend(BDXTransfer & aXfer, bool aICanDrive, bool aUCanDrive, bool aAsyncOk, ReferencedTLVData *aMetaData)
InitBdxSend(BDXTransfer & aXfer, bool aICanDrive, bool aUCanDrive, bool aAsyncOk, SendInit::MetaDataTLVWriteCallback aMetaDataWriteCallback, void *aMetaDataAppState)
SendBadBlockCounterStatusReport(BDXTransfer & aXfer)
SendBlockAckV1(BDXTransfer & aXfer)
Esta función envía un mensaje BlockAckV1 para la BDXTransfer determinada.
SendBlockEOFAckV1(BDXTransfer & aXfer)
Esta función envía un mensaje BlockEOFAckV1 para la BDXTransfer determinada.
SendBlockQuery(BDXTransfer & aXfer)
SendBlockQueryV1(BDXTransfer & aXfer)
Esta función envía un mensaje BlockQueryV1 para la BDXTransfer determinada.
SendNextBlock(BDXTransfer & aXfer)
SendNextBlockV1(BDXTransfer & aXfer)
Esta función envía el siguiente elemento BlockSendV1 que se recupera mediante una llamada al GetBlockHandler de BDXTransfer.
SendStatusReport(ExchangeContext *anEc, uint32_t aProfileId, uint16_t aStatusCode)
void
Envía un mensaje de informe de estado con el ID de perfil asociado, el código de estado y el contexto de intercambio.
SendTransferError(ExchangeContext *anEc, uint32_t aProfileId, uint16_t aStatusCode)
void

Funciones

HandleConnectionClosed

void HandleConnectionClosed(
  ExchangeContext *anEc,
  WeaveConnection *aCon,
  WEAVE_ERROR aConErr
)

Controlador para cuando se cierra la conexión.

Llama al controlador de errores de la transferencia asociada y cierra la transferencia.

Detalles
Parámetros
[in] anEc
Contexto de Exchange que detectó una conexión cerrada. Podemos encontrar el BDXTransfer asociado en esta
[in] aCon
La conexión de Weave, sin usar en la función real
[in] aConErr
Error asociado con el cierre de la conexión

HandleKeyError

void HandleKeyError(
  ExchangeContext *anEc,
  WEAVE_ERROR aKeyErr
)

Controlador que sirve cuando la clave que se usa para encriptar y autenticar mensajes de Weave ya no se puede usar.

Detalles
Parámetros
[in] anEc
Contexto de Exchange que detectó un error de clave. Podemos encontrar el BDXTransfer asociado de este
[in] aKeyErr
Error asociado con la clave que ya no se puede usar

HandleResponse

void HandleResponse(
  ExchangeContext *anEc,
  const IPPacketInfo *aPktInfo,
  const WeaveMessageInfo *aWeaveMsgInfo,
  uint32_t aProfileId,
  uint8_t aMessageType,
  PacketBuffer *aPacketBuffer
)

Es el controlador principal de los mensajes que llegan al intercambio de BDX.

En esencia, actúa como un router para extraer la información y los datos del encabezado de BDX adecuados y despachar el controlador adecuado para que actúe sobre este objeto.

Detalles
Parámetros
[in] anEc
El contexto del intercambio por si lo necesitamos
[in] aPktInfo
No se usa, pero debe coincidir con el prototipo de la función
[in] aWeaveMsgInfo
Información del mensaje de Weave para el mensaje
[in] aProfileId
ID del perfil en el que se define el mensaje
[in] aMessageType
El tipo de mensaje de ese perfil
[in] aPacketBuffer
El mensaje empaquetado en sí

HandleResponseNotAccepted

WEAVE_ERROR HandleResponseNotAccepted(
  BDXTransfer & aXfer,
  uint32_t aProfileId,
  uint8_t aMessageType,
  PacketBuffer *aPacketBuffer
)

HandleResponseReceive

WEAVE_ERROR HandleResponseReceive(
  BDXTransfer & aXfer,
  uint32_t aProfileId,
  uint8_t aMessageType,
  PacketBuffer *aPacketBuffer
)

HandleResponseTimeout

void HandleResponseTimeout(
  ExchangeContext *anEc
)

Controlador para cuando se agota el tiempo de espera de una respuesta.

Cierra la transferencia que se agotó el tiempo de espera y llama al controlador de errores de esa transferencia.

Detalles
Parámetros
[in] anEc
Contexto de intercambio del que podemos encontrar BDXTransfer

HandleResponseTransmit

WEAVE_ERROR HandleResponseTransmit(
  BDXTransfer & aXfer,
  uint32_t aProfileId,
  uint8_t aMessageType,
  PacketBuffer *aPacketBuffer
)

HandleSendError

void HandleSendError(
  ExchangeContext *anEc,
  WEAVE_ERROR aSendErr,
  void *aMsgCtxt
)

Controlador para cuando no se confirmó el mensaje WRMP que enviamos.

Detalles
Parámetros
[in] anEc
Contexto de intercambio que tenía un mensaje no reconocido. Podemos encontrar el BDXTransfer asociado desde este
[in] aSendErr
Error asociado con el error de envío del mensaje
[in] aMsgCtxt
Un contexto de mensaje arbitrario que se asoció con el mensaje no confirmado.

InitBdxReceive

WEAVE_ERROR InitBdxReceive(
  BDXTransfer & aXfer,
  bool aICanDrive,
  bool aUCanDrive,
  bool aAsyncOk,
  ReferencedTLVData *aMetaData
)

InitBdxSend

WEAVE_ERROR InitBdxSend(
  BDXTransfer & aXfer,
  bool aICanDrive,
  bool aUCanDrive,
  bool aAsyncOk,
  ReferencedTLVData *aMetaData
)

InitBdxSend

WEAVE_ERROR InitBdxSend(
  BDXTransfer & aXfer,
  bool aICanDrive,
  bool aUCanDrive,
  bool aAsyncOk,
  SendInit::MetaDataTLVWriteCallback aMetaDataWriteCallback,
  void *aMetaDataAppState
)

SendBadBlockCounterStatusReport

WEAVE_ERROR SendBadBlockCounterStatusReport(
  BDXTransfer & aXfer
)

SendBlockAckV1

WEAVE_ERROR SendBlockAckV1(
  BDXTransfer & aXfer
)

Esta función envía un mensaje BlockAckV1 para la BDXTransfer determinada.

El número de bloque confirmado es igual a aXfer.mBlockCounter - 1, ya que esta función solo se puede llamar después de que el estado de transferencia avance al siguiente contador.

Detalles
Parámetros
[in] aXfer
El BDXTransfer para el que enviamos un elemento BlockAck,
Valores de retorno
WEAVE_NO_ERROR
Si el mensaje se envió correctamente.
WEAVE_ERROR_NO_MEMORY
Si no hay PackageBuffers disponibles.

SendBlockEOFAckV1

WEAVE_ERROR SendBlockEOFAckV1(
  BDXTransfer & aXfer
)

Esta función envía un mensaje BlockEOFAckV1 para la BDXTransfer determinada.

El número de bloque confirmado es igual a aXfer.mBlockCounter.

Detalles
Parámetros
[in] aXfer
Es el elemento BDXTransfer para el que enviamos un elemento BlockEOFAck.
Valores de retorno
WEAVE_NO_ERROR
Si el mensaje se envió correctamente.
WEAVE_ERROR_NO_MEMORY
Si no hay PackageBuffers disponibles.

SendBlockQuery

WEAVE_ERROR SendBlockQuery(
  BDXTransfer & aXfer
)

SendBlockQueryV1

WEAVE_ERROR SendBlockQueryV1(
  BDXTransfer & aXfer
)

Esta función envía un mensaje BlockQueryV1 para la BDXTransfer determinada.

El número de bloque solicitado es igual a aXfer.mBlockCounter.

Detalles
Parámetros
[in] aXfer
El BDXTransfer para el que enviamos una BlockQuery
Valores de retorno
WEAVE_NO_ERROR
Si el mensaje se envió correctamente.
WEAVE_ERROR_NO_MEMORY
Si no hay PackageBuffers disponibles.

SendNextBlock

WEAVE_ERROR SendNextBlock(
  BDXTransfer & aXfer
)

SendNextBlockV1

WEAVE_ERROR SendNextBlockV1(
  BDXTransfer & aXfer
)

Esta función envía el siguiente BlockSendV1 que se recupera mediante una llamada al GetBlockHandler de BDXTransfer.

Detalles
Parámetros
[in] aXfer
Es el BDXTransfer cuyo GetBlockHandler se llama para obtener el siguiente bloque antes de enviarlo con el ExchangeContext asociado.
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Si el objeto GetBlockHandler es NULL,

SendStatusReport

void SendStatusReport(
  ExchangeContext *anEc,
  uint32_t aProfileId,
  uint16_t aStatusCode
)

Envía un mensaje de informe de estado con el ID de perfil asociado, el código de estado y el contexto de intercambio.

Detalles
Parámetros
[in] anEc
El contexto de intercambio en el que deberíamos enviar el mensaje del informe de estado
[in] aProfileId
ID del perfil
[in] aStatusCode
Código asociado con el error de transferencia

SendTransferError

void SendTransferError(
  ExchangeContext *anEc,
  uint32_t aProfileId,
  uint16_t aStatusCode
)