nl :: Tecer:: Perfis :: BDX_Development :: BdxProtocol

Resumo

Funções
`HandleConnectionClosed ( ExchangeContext anEc, WeaveConnection aCon, WEAVE_ERROR aConErr)`	`void` Manipulador para quando a própria conexão é fechada.
`HandleKeyError ( ExchangeContext *anEc, WEAVE_ERROR aKeyErr)`	`void` Manipulador para quando a chave usada para criptografar e autenticar mensagens do Weave não puder mais ser usada.
`HandleResponse ( ExchangeContext anEc, const IPPacketInfo aPktInfo, const WeaveMessageInfo aWeaveMsgInfo, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer aPacketBuffer)`	`void` O manipulador principal de mensagens que chegam na troca BDX.
`HandleResponseNotAccepted ( BDXTransfer & aXfer, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer *aPacketBuffer)`	`WEAVE_ERROR`
`HandleResponseReceive ( BDXTransfer & aXfer, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer *aPacketBuffer)`	`WEAVE_ERROR`
`HandleResponseTimeout ( ExchangeContext *anEc)`	`void` Manipulador para quando atingimos o tempo limite à espera de uma resposta.
`HandleResponseTransmit ( BDXTransfer & aXfer, uint32_t aProfileId, uint8_t aMessageType, PacketBuffer *aPacketBuffer)`	`WEAVE_ERROR`
`HandleSendError ( ExchangeContext anEc, WEAVE_ERROR aSendErr, void aMsgCtxt)`	`void` Manipulador para quando a mensagem WRMP que enviamos não foi confirmada.
`InitBdxReceive ( BDXTransfer & aXfer, bool aICanDrive, bool aUCanDrive, bool aAsyncOk, ReferencedTLVData *aMetaData)`	`WEAVE_ERROR`
`InitBdxSend ( BDXTransfer & aXfer, bool aICanDrive, bool aUCanDrive, bool aAsyncOk, ReferencedTLVData *aMetaData)`	`WEAVE_ERROR`
`InitBdxSend ( BDXTransfer & aXfer, bool aICanDrive, bool aUCanDrive, bool aAsyncOk, SendInit::MetaDataTLVWriteCallback aMetaDataWriteCallback, void *aMetaDataAppState)`	`WEAVE_ERROR`
`SendBadBlockCounterStatusReport ( BDXTransfer & aXfer)`	`WEAVE_ERROR`
`SendBlockAckV1 ( BDXTransfer & aXfer)`	`WEAVE_ERROR` Esta função envia uma mensagem BlockAckV1 para o BDXTransfer fornecido.
`SendBlockEOFAckV1 ( BDXTransfer & aXfer)`	`WEAVE_ERROR` Esta função envia uma mensagem BlockEOFAckV1 para o BDXTransfer fornecido.
`SendBlockQuery ( BDXTransfer & aXfer)`	`WEAVE_ERROR`
`SendBlockQueryV1 ( BDXTransfer & aXfer)`	`WEAVE_ERROR` Esta função envia uma mensagem BlockQueryV1 para o BDXTransfer fornecido.
`SendNextBlock ( BDXTransfer & aXfer)`	`WEAVE_ERROR`
`SendNextBlockV1 ( BDXTransfer & aXfer)`	`WEAVE_ERROR` Esta função envia o próximo BlockSendV1 recuperado chamando GetBlockHandler do BDXTransfer .
`SendStatusReport ( ExchangeContext *anEc, uint32_t aProfileId, uint16_t aStatusCode)`	`void` Envia uma mensagem de relatório de status com o ID de perfil associado, código de status e contexto de troca.
`SendTransferError ( ExchangeContext *anEc, uint32_t aProfileId, uint16_t aStatusCode)`	`void`

Funções

HandleConnectionClosed

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

Manipulador para quando a própria conexão é fechada.

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

Detalhes

Parâmetros

`[in] anEc`	Contexto do Exchange que detectou uma conexão fechada Podemos encontrar o BDXTransfer associado a partir deste
`[in] aCon`	A conexão Weave, não utilizada na função real
`[in] aConErr`	Erro associado ao fechamento da conexão

HandleKeyError

void HandleKeyError(
  ExchangeContext *anEc,
  WEAVE_ERROR aKeyErr
)

Manipulador para quando a chave usada para criptografar e autenticar mensagens do Weave não puder mais ser usada.

Detalhes

Parâmetros

`[in] anEc`	Contexto do Exchange que detectou um erro de chave Podemos encontrar o BDXTransfer associado a partir deste
`[in] aKeyErr`	Erro associado ao fato de a chave não ser mais utilizável

HandleResponse

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

O manipulador principal de mensagens que chegam na troca BDX.

Ele atua essencialmente como um roteador para extrair as informações e dados do cabeçalho BDX apropriado, despachando o manipulador apropriado para agir neste objeto.

Detalhes

Parâmetros

`[in] anEc`	O contexto de troca, caso seja necessário
`[in] aPktInfo`	Não utilizado, mas precisa corresponder ao protótipo da função
`[in] aWeaveMsgInfo`	Tecer informações da mensagem para a mensagem
`[in] aProfileId`	ID do perfil sob o qual a mensagem é definida
`[in] aMessageType`	O tipo de mensagem desse perfil
`[in] aPacketBuffer`	A própria mensagem embalada

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
)

Manipulador para quando atingimos o tempo limite à espera de uma resposta.

Encerra a transferência que atingiu o tempo limite e chama o manipulador de erros dessa transferência.

Detalhes

Parâmetros

[in] anEc

Contexto de troca do qual 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
)

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

Detalhes

Parâmetros

`[in] anEc`	Contexto de troca que tinha uma mensagem não reconhecida Podemos encontrar o BDXTransfer associado a partir deste
`[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 o BDXTransfer fornecido.

O número do bloco reconhecido é igual a aXfer.mBlockCounter - 1, pois esta função só pode ser chamada após o estado de transferência avançar para o próximo contador.

Detalhes

Parâmetros

[in] aXfer

O BDXTransfer para o qual estamos enviando um BlockAck .

Valores Retornados

`WEAVE_NO_ERROR`	Se enviarmos a mensagem com sucesso.
`WEAVE_ERROR_NO_MEMORY`	Se nenhum PacketBuffers estiver disponível.

SendBlockEOFAckV1

WEAVE_ERROR SendBlockEOFAckV1(
  BDXTransfer & aXfer
)

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

O número do bloco reconhecido é igual a aXfer.mBlockCounter.

Detalhes

Parâmetros

[in] aXfer

O BDXTransfer para o qual estamos enviando um BlockEOFAck .

Valores Retornados

`WEAVE_NO_ERROR`	Se enviarmos a mensagem com sucesso.
`WEAVE_ERROR_NO_MEMORY`	Se nenhum PacketBuffers estiver disponível.

SendBlockQuery

WEAVE_ERROR SendBlockQuery(
  BDXTransfer & aXfer
)

SendBlockQueryV1

WEAVE_ERROR SendBlockQueryV1(
  BDXTransfer & aXfer
)

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

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

Detalhes

Parâmetros

[in] aXfer

O BDXTransfer para o qual estamos enviando um BlockQuery .

Valores Retornados

`WEAVE_NO_ERROR`	Se enviarmos a mensagem com sucesso.
`WEAVE_ERROR_NO_MEMORY`	Se nenhum PacketBuffers estiver disponível.

SendNextBlock

WEAVE_ERROR SendNextBlock(
  BDXTransfer & aXfer
)

SendNextBlockV1

WEAVE_ERROR SendNextBlockV1(
  BDXTransfer & aXfer
)

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

Detalhes

Parâmetros

[in] aXfer

O BDXTransfer cujo GetBlockHandler é chamado para obter o próximo bloco antes de enviá-lo usando o ExchangeContext associado

Valores Retornados

WEAVE_ERROR_INCORRECT_STATE

Se o GetBlockHandler for NULL

SendStatusReport

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

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

Detalhes

Parâmetros

`[in] anEc`	O contexto de troca para onde devemos enviar a mensagem de 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
)