nl:: Weave:: Profiles:: DataManagement_Current:: NotificationEngine:: NotifyRequestBuilder
#include <src/lib/profiles/data-management/Current/NotificationEngine.h>
Isso fornece uma classe auxiliar para escrever notificações e abstrair a construção e a estrutura da mensagem dos consumidores.
Resumo
Essa é uma versão mais compacta de uma classe semelhante fornecida em MessageDef.cpp que pretende ser sensível às necessidades de flash e RAM do dispositivo.
Funções públicas |
|
---|---|
Checkpoint(TLV::TLVWriter & aPoint)
|
Checkpoint do estado da solicitação em um TLVWriter.
|
EndDataList()
|
Encerre a construção da matriz da lista de dados.
|
EndEventList()
|
Encerre a construção da lista de eventos.
|
EndNotifyRequest()
|
Encerre a construção da notificação.
|
GetWriter(void)
|
|
Init(PacketBuffer *aBuf, TLV::TLVWriter *aWriter, SubscriptionHandler *aSubHandler, uint32_t aMaxPayloadSize)
|
Inicializa o builder.
|
MoveToState(NotifyRequestBuilderState aDesiredState)
|
A principal função de transição de estado.
|
Rollback(TLV::TLVWriter & aPoint)
|
Reverter o estado da solicitação no 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()
|
Iniciar 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
Check Point
WEAVE_ERROR Checkpoint( TLV::TLVWriter & aPoint )
Checkpoint do estado da solicitação em um TLVWriter.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Valores de retorno |
|
EndDataList
WEAVE_ERROR EndDataList()
Encerre a construção da matriz da lista de dados.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Valores de retorno |
|
EndEventList
WEAVE_ERROR EndEventList()
Encerre a construção da lista de eventos.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Valores de retorno |
|
EndNotifyRequest
WEAVE_ERROR EndNotifyRequest()
Encerre a construção da notificação.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Valores de retorno |
|
GetWriter
TLV::TLVWriter * GetWriter( void )
Init
WEAVE_ERROR Init( PacketBuffer *aBuf, TLV::TLVWriter *aWriter, SubscriptionHandler *aSubHandler, uint32_t aMaxPayloadSize )
Inicializa o builder.
Deve ser chamado apenas uma vez.
Detalhes | |||||
---|---|---|---|---|---|
Valores de retorno |
|
MoveToState
WEAVE_ERROR MoveToState( NotifyRequestBuilderState aDesiredState )
A principal função de transição de estado.
A função usa o estado desejado (ou seja, a fase do criador de solicitações de notificação que queremos alcançar) e transfere a solicitação para esse estado. Se o estado desejado for o mesmo que o atual, a função não fará nada. Caso contrário, um PackageBuffer é 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, transfere a solicitação de Notificar abrindo o contêiner de dados TLV apropriado ou fechando a solicitação abrangente.
Detalhes | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parâmetros |
|
||||||||
Valores de retorno |
|
Reverter
WEAVE_ERROR Rollback( TLV::TLVWriter & aPoint )
Reverter o estado da solicitação no TLVWriter com checkpoint.
Detalhes | |||
---|---|---|---|
Parâmetros |
|
||
Valores de retorno |
|
StartDataList
WEAVE_ERROR StartDataList( void )
Inicia a construção da matriz da lista de dados.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Valores de retorno |
|
StartEventList
WEAVE_ERROR StartEventList()
Inicia a construção da lista de eventos.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Valores de retorno |
|
StartNotifyRequest
WEAVE_ERROR StartNotifyRequest()
Iniciar a construção da notificação.
Detalhes | |||||||
---|---|---|---|---|---|---|---|
Valores de retorno |
|
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 autor da chamada também pode passar um conjunto de identificadores para aproveitar a operação de mesclagem com um conjunto mais restrito de nós filhos imediatos do identificador de caminho da propriedade pai.
Detalhes | |||||
---|---|---|---|---|---|
Valores de retorno |
|