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

Resumo

Funções

HandleConnectionClosed(ExchangeContext *anEc, WeaveConnection *aCon, WEAVE_ERROR aConErr)
void
Gerenciador para quando a conexão em si é fechada.
HandleKeyError(ExchangeContext *anEc, WEAVE_ERROR aKeyErr)
void
Gerenciador para quando a chave usada para criptografar e autenticar mensagens do Weave não é mais utilizável.
HandleResponse(ExchangeContext *anEc, const IPPacketInfo *aPktInfo, const WeaveMessageInfo *aWeaveMsgInfo, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer *aPacketBuffer)
void
O gerenciador principal de mensagens que chegam na troca 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
Gerenciador para quando atingirmos o tempo limite à espera de uma resposta.
HandleResponseTransmit(BDXTransfer & aXfer, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer *aPacketBuffer)
HandleSendError(ExchangeContext *anEc, WEAVE_ERROR aSendErr, void *aMsgCtxt)
void
Gerenciador para quando a mensagem WRMP que enviamos não foi confirmada.
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 função envia uma mensagem BlockAckV1 para a BDXTransfer determinada.
SendBlockEOFAckV1(BDXTransfer & aXfer)
Esta função envia uma mensagem BlockEOFAckV1 para a BDXTransfer determinada.
SendBlockQuery(BDXTransfer & aXfer)
SendBlockQueryV1(BDXTransfer & aXfer)
Esta função envia uma mensagem BlockQueryV1 para a BDXTransfer determinada.
SendNextBlock(BDXTransfer & aXfer)
SendNextBlockV1(BDXTransfer & aXfer)
Essa função envia o próximo BlockSendV1 recuperado chamando o GetBlockHandler do BDXTransfer.
SendStatusReport(ExchangeContext *anEc, uint32_t aProfileId, uint16_t aStatusCode)
void
Envia uma mensagem do relatório de status com o ID do perfil, o código de status e o contexto da troca associados.
SendTransferError(ExchangeContext *anEc, uint32_t aProfileId, uint16_t aStatusCode)
void

Funções

HandleConnectionClosed

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

Gerenciador para quando a conexão em si é fechada.

Chama o gerenciador de erros da transferência associada e a encerra.

Detalhes
Parâmetros
[in] anEc
Contexto da troca que detectou uma conexão encerrada. Podemos encontrar o BDXTransfer associado neste
[in] aCon
A conexão do Weave, não utilizada na função real
[in] aConErr
Erro associado ao encerramento da conexão

HandleKeyError

void HandleKeyError(
  ExchangeContext *anEc,
  WEAVE_ERROR aKeyErr
)

Gerenciador para quando a chave usada para criptografar e autenticar mensagens do Weave não é mais utilizável.

Detalhes
Parâmetros
[in] anEc
Contexto da troca que detectou um erro de chave. Podemos encontrar o BDXTransfer associado neste
[in] aKeyErr
Erro associado à chave que não pode mais ser utilizada

HandleResponse

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

O gerenciador principal de mensagens que chegam na troca BDX.

Essencialmente, ele atua como um roteador para extrair as informações e os dados apropriados do cabeçalho BDX, enviando o manipulador apropriado para agir nesse objeto.

Detalhes
Parâmetros
[in] anEc
O contexto da troca, caso precisemos
[in] aPktInfo
Não usado, mas precisa corresponder ao protótipo de função
[in] aWeaveMsgInfo
Informações da mensagem do Weave para a mensagem
[in] aProfileId
ID do perfil no qual a mensagem é definida
[in] aMessageType
O tipo de mensagem do perfil
[in] aPacketBuffer
A própria mensagem empacotada

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
)

Gerenciador para quando atingirmos o tempo limite à espera de uma resposta.

Encerra a transferência que expirou e chama o gerenciador de erros dessa transferência.

Detalhes
Parâmetros
[in] anEc
Contexto do Exchange em que podemos encontrar o BDXTransfer de

HandleResponseTransmit

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

HandleSendError

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

Gerenciador para quando a mensagem WRMP que enviamos não foi confirmada.

Detalhes
Parâmetros
[in] anEc
Contexto de troca que teve uma mensagem não reconhecida. Podemos encontrar a BDXTransfer associada neste
[in] aSendErr
Erro associado à falha no envio da mensagem
[in] aMsgCtxt
Um contexto de mensagem arbitrário que foi associado à mensagem não confirmada.

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 função envia uma mensagem BlockAckV1 para a BDXTransfer determinada.

O número de bloco reconhecido é igual a aXfer.mBlockCounter - 1, já que essa função só pode ser chamada depois que o estado de transferência avança para o próximo contador.

Detalhes
Parâmetros
[in] aXfer
A BDXTransfer para a qual estamos enviando um BlockAck.
Valores de retorno
WEAVE_NO_ERROR
Se a mensagem foi enviada corretamente.
WEAVE_ERROR_NO_MEMORY
Se não houver PackageBuffers disponíveis.

SendBlockEOFAckV1

WEAVE_ERROR SendBlockEOFAckV1(
  BDXTransfer & aXfer
)

Esta função envia uma mensagem BlockEOFAckV1 para a BDXTransfer determinada.

O número de bloco confirmado é igual a aXfer.mBlockCounter.

Detalhes
Parâmetros
[in] aXfer
A BDXTransfer para a qual vamos enviar um BlockEOFAck.
Valores de retorno
WEAVE_NO_ERROR
Se a mensagem foi enviada corretamente.
WEAVE_ERROR_NO_MEMORY
Se não houver PackageBuffers disponíveis.

SendBlockQuery

WEAVE_ERROR SendBlockQuery(
  BDXTransfer & aXfer
)

SendBlockQueryV1

WEAVE_ERROR SendBlockQueryV1(
  BDXTransfer & aXfer
)

Esta função envia uma mensagem BlockQueryV1 para a BDXTransfer determinada.

O número de bloco solicitado é igual a aXfer.mBlockCounter.

Detalhes
Parâmetros
[in] aXfer
A BDXTransfer para a qual estamos enviando uma BlockQuery.
Valores de retorno
WEAVE_NO_ERROR
Se a mensagem foi enviada corretamente.
WEAVE_ERROR_NO_MEMORY
Se não houver PackageBuffers disponíveis.

SendNextBlock

WEAVE_ERROR SendNextBlock(
  BDXTransfer & aXfer
)

SendNextBlockV1

WEAVE_ERROR SendNextBlockV1(
  BDXTransfer & aXfer
)

Essa função envia o próximo BlockSendV1 recuperado chamando o GetBlockHandler do BDXTransfer.

Detalhes
Parâmetros
[in] aXfer
O BDXTransfer em que GetBlockHandler é chamado para receber o próximo bloco antes de enviá-lo usando o ExchangeContext associado
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Se o GetBlockHandler for NULL

SendStatusReport

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

Envia uma mensagem do relatório de status com o ID do perfil, o código de status e o contexto da troca associados.

Detalhes
Parâmetros
[in] anEc
Contexto da troca para onde devemos enviar a mensagem do relatório de status
[in] aProfileId
ID do perfil
[in] aStatusCode
Código associado ao erro de transferência

SendTransferError

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