nl :: Tecer:: Perfis :: DataManagement_Current :: NotificationEngine :: NotifyRequestBuilder
#include <src/lib/profiles/data-management/Current/NotificationEngine.h>
Isso fornece uma classe auxiliar para redigir notificações e abstrair a construção e a estrutura da mensagem de seus consumidores.
Resumo
Esta é uma versão mais compacta de uma classe semelhante fornecida em MessageDef.cpp que visa ser sensível às necessidades de flash e RAM do dispositivo.
Funções públicas | |
---|---|
Checkpoint (TLV::TLVWriter & aPoint) | Faça checkpoint do estado da solicitação em um TLVWriter. |
EndDataList () | Termine a construção da matriz da lista de dados. |
EndEventList () | Termine a construção da lista de eventos. |
EndNotifyRequest () | Fim da construção do notificar. |
GetWriter (void) | |
Init (PacketBuffer *aBuf,TLV::TLVWriter *aWriter, SubscriptionHandler *aSubHandler, uint32_t aMaxPayloadSize) | Inicializa o construtor. |
MoveToState ( NotifyRequestBuilderState aDesiredState) | A principal função de transição de estado. |
Rollback (TLV::TLVWriter & aPoint) | Reverta o estado da solicitação para o TLVWriter com checkpoint. |
StartDataList (void) | Inicia a construção da matriz da lista de dados. |
StartEventList () | Inicia a construção da lista de eventos. |
StartNotifyRequest () | Inicie a construção da notificação. |
WriteDataElement (TraitDataHandle aTraitDataHandle, PropertyPathHandle aPropertyPathHandle, SchemaVersion aSchemaVersion, PropertyPathHandle *aMergeDataHandleSet, uint32_t aNumMergeDataHandles, PropertyPathHandle *aDeleteHandleSet, uint32_t aNumDeleteHandles) | Dado um caminho de característica, escreva o elemento de dados associado a esse caminho. |
Funções públicas
Checkpoint
WEAVE_ERROR Checkpoint( TLV::TLVWriter & aPoint )
Ponto de verificação do estado da solicitação em um TLVWriter.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Valores Retornados |
|
EndDataList
WEAVE_ERROR EndDataList()
Termine a construção da matriz da lista de dados.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Valores Retornados |
|
EndEventList
WEAVE_ERROR EndEventList()
Termine a construção da lista de eventos.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Valores Retornados |
|
EndNotifyRequest
WEAVE_ERROR EndNotifyRequest()
Fim da construção da notificação.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Valores Retornados |
|
GetWriter
TLV::TLVWriter * GetWriter( void )
Iniciar
WEAVE_ERROR Init( PacketBuffer *aBuf, TLV::TLVWriter *aWriter, SubscriptionHandler *aSubHandler, uint32_t aMaxPayloadSize )
Inicializa o construtor.
Deve ser chamado apenas uma vez.
Detalhes | |||||
---|---|---|---|---|---|
Valores Retornados |
|
MoveToState
WEAVE_ERROR MoveToState( NotifyRequestBuilderState aDesiredState )
A principal função de transição de estado.
A função assume o estado desejado (ou seja, a fase do construtor de solicitação de notificação que gostaríamos de alcançar) e faz a transição da solicitação para esse estado. Se o estado desejado for igual ao estado atual, a função não fará nada. Caso contrário, um PacketBuffer é alocado (se necessário); a função primeiro faz a transição da solicitação para a solicitação de notificação de nível superior (abrindo a estrutura TLV da solicitação de notificação ou fechando o contêiner de dados TLV atual, conforme necessário) e, em seguida, faz a transição da solicitação Notify abrindo o contêiner de dados TLV apropriado ou fechando o abrangente Notifique o pedido.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
| ||||||||
Valores Retornados |
|
Rollback
WEAVE_ERROR Rollback( TLV::TLVWriter & aPoint )
Reverta o estado da solicitação para o TLVWriter com checkpoint.
Detalhes | |||
---|---|---|---|
Parâmetros |
| ||
Valores Retornados |
|
StartDataList
WEAVE_ERROR StartDataList( void )
Inicia a construção da matriz da lista de dados.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Valores Retornados |
|
StartEventList
WEAVE_ERROR StartEventList()
Inicia a construção da lista de eventos.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Valores Retornados |
|
StartNotifyRequest
WEAVE_ERROR StartNotifyRequest()
Inicie a construção da notificação.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Valores Retornados |
|
WriteDataElement
WEAVE_ERROR WriteDataElement( TraitDataHandle aTraitDataHandle, PropertyPathHandle aPropertyPathHandle, SchemaVersion aSchemaVersion, PropertyPathHandle *aMergeDataHandleSet, uint32_t aNumMergeDataHandles, PropertyPathHandle *aDeleteHandleSet, uint32_t aNumDeleteHandles )
Dado um caminho de característica, escreva o elemento de dados associado a esse caminho.
O chamador também pode, opcionalmente, passar um conjunto de identificadores que permite alavancar a operação de mesclagem com um conjunto mais estreito de nós filho imediatos do identificador de caminho de propriedade pai.
Detalhes | |||||
---|---|---|---|---|---|
Valores Retornados |
|