nl:: Weave:: Profiles:: DataManagement_Current:: CommandSender
#include <src/lib/profiles/data-management/Current/CommandSender.h>
Resumo
Observação: essa classe encapsula os detalhes do protocolo de envio de comandos, simplificando a mecânica envolvida nos aplicativos. O aplicativo fornece um PackageBuffer que contém o payload do comando, bem como um conjunto opcional de argumentos que alteram o conteúdo do cabeçalho do comando, bem como o comportamento do comando. A utilidade desse wrapper para a manipulação de comandos é realmente limitada, principalmente devido à complexidade/flexibilidade envolvida na validação da segurança e serialização/desserialização de dados.
Os detalhes da validação do comando ainda não foram definidos
Essa classe também ajuda os aplicativos a inferir se os dados em um TraitDataSink associado completaram os efeitos colaterais do comando (com base na versão fornecida na resposta do comando). O aplicativo é responsável por gerenciar o armazenamento desse objeto.
Um objeto dessa classe pode ser inicializado com uma Binding de Weave, que servirá como a Binding padrão a ser usada para enviar comandos. O usuário também pode fornecer um Binding para cada chamada deSendCommand(), que substituirá o Binding padrão. Não é necessário fornecer um Binding padrão, mas qualquer vinculação fornecida ao CommandSender já precisa ter sido inicializada.
EventCallback
O usuário precisa definir uma função desse tipo se quiser receber informações sobre eventos que acontecem após o envio do comando (consulte "Eventos de API" abaixo). Ele pode ser NULL se o usuário não se importar com o que acontece depois que o comando é enviado.
Eventos da API
Os eventos a seguir são os possíveis resultados após o envio de um Command:
CommunicationError
Ocorreu um erro ao formar ou enviar o Command ou ao aguardar uma resposta. Exemplos de erros que podem ocorrer durante a espera por uma resposta são erros de chave ou fechamento inesperado de uma conexão. O motivo do erro estará no argumento InEventParam do manipulador EventCallback.
InProgressReceived
O destinatário pode enviar uma mensagem "em andamento", que significa que o comando Command foi recebido, mas não concluído. Quando o processo for concluído, o destinatário enviará um Response ou StatusReport. O envio de uma mensagem 'em andamento' não é necessário.
StatusReportReceived
O recebimento de um StatusReport implica que houve um erro no processamento de Command. O StatusReport pode ser acessado por meio do InEventParam.
ResponseReceived
Receber uma resposta significa que o destinatário de Command processou o Command. A resposta pode conter um payload ou não. Se o aplicativo quiser manter o buffer do pacote, ele poderá chamar ExchangeContext::AddRef() para incrementar a contagem de referência.
Tipos públicos |
|
---|---|
EventCallback)(void *const aAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutEventParam)
|
typedefvoid(*
|
EventType
|
enum |
Atributos públicos |
|
---|---|
mAppState = NULL
|
void *
|
mSyncronizedTraitState = NULL
|
Funções estáticas públicas |
|
---|---|
DefaultEventHandler(void *aAppState, EventType aEvent, const InEventParam & aInParam, OutEventParam & aOutParam)
|
void
|
Funções públicas |
|
---|---|
Close(bool aAbortNow)
|
void
|
Init(nl::Weave::Binding *aBinding, const EventCallback aEventCallback, void *const aAppState)
|
|
SendCommand(nl::Weave::PacketBuffer *aPayload, nl::Weave::Binding *aBinding, ResourceIdentifier & aResourceId, uint32_t aProfileId, uint32_t aCommandType)
|
|
SendCommand(nl::Weave::PacketBuffer *aPayload, nl::Weave::Binding *aBinding, SendParams & aSendParams)
|
|
SetSynchronizedTraitState(SynchronizedTraitState *aTraitState)
|
void
|
Estruturas |
|
---|---|
nl:: |
Dados retornados ao remetente pelo destinatário do comando personalizado. |
nl:: |
Os dados retornados para um objeto CommandSender de uma função EventCallback. |
nl:: |
Encapsula os argumentos a serem transmitidos para EnviarCommand(). |
nl:: |
Tipos públicos
EventCallback
void(* EventCallback)(void *const aAppState, EventType aEvent, const InEventParam &aInParam, OutEventParam &aOutEventParam)
EventType
EventType
Atributos públicos
mAppState
void * mAppState = NULL
mSyncronizedTraitState
SynchronizedTraitState * mSyncronizedTraitState = NULL
Funções estáticas públicas
DefaultEventHandler
void DefaultEventHandler( void *aAppState, EventType aEvent, const InEventParam & aInParam, OutEventParam & aOutParam )
Funções públicas
Fechar
void Close( bool aAbortNow )
Init
WEAVE_ERROR Init( nl::Weave::Binding *aBinding, const EventCallback aEventCallback, void *const aAppState )
SendCommand
WEAVE_ERROR SendCommand( nl::Weave::PacketBuffer *aPayload, nl::Weave::Binding *aBinding, ResourceIdentifier & aResourceId, uint32_t aProfileId, uint32_t aCommandType )
SendCommand
WEAVE_ERROR SendCommand( nl::Weave::PacketBuffer *aPayload, nl::Weave::Binding *aBinding, SendParams & aSendParams )