nl::Weave::Profiles::DataManagement_Current::NotificationEngine

Summary

Public types
`NotifyRequestBuilderState{ kNotifyRequestBuilder_Idle = 0, kNotifyRequestBuilder_Ready, kNotifyRequestBuilder_BuildDataList, kNotifyRequestBuilder_BuildEventList }`	enum

Public functions
`DeleteKey(TraitDataSource *aDataSource, PropertyPathHandle aPropertyHandle)`	`WEAVE_ERROR`
`Init(void)`	`WEAVE_ERROR` Initializes the engine.
`Run(void)`	`void` Main work-horse function that executes the run-loop.
`ScheduleRun(void)`	`void` Main work-horse function that executes the run-loop asynchronously on the Weave thread.
`SetDirty(TraitDataSource *aDataSource, PropertyPathHandle aPropertyHandle)`	`WEAVE_ERROR` Marks a handle associated with a data source as being dirty.

Classes
nl::Weave::Profiles::DataManagement_Current::NotificationEngine::BasicGraphSolver
nl::Weave::Profiles::DataManagement_Current::NotificationEngine::IntermediateGraphSolver
nl::Weave::Profiles::DataManagement_Current::NotificationEngine::NotifyRequestBuilder	This provides a helper class to compose notifies and abstract away the construction and structure of the message from its consumers.

 NotifyRequestBuilderState

Properties
`kNotifyRequestBuilder_BuildDataList`	The request is building the DataList portion of the structure.
`kNotifyRequestBuilder_BuildEventList`	The request is building the EventList portion of the structure.
`kNotifyRequestBuilder_Idle`	The request has not been opened or has been closed and finalized.
`kNotifyRequestBuilder_Ready`	The request has been initialized and is ready for any optional toplevel elements.

WEAVE_ERROR DeleteKey(
  TraitDataSource *aDataSource,
  PropertyPathHandle aPropertyHandle
)

WEAVE_ERROR Init(
  void
)

Initializes the engine.

Should only be called once.

Details

Return Values

`WEAVE_NO_ERROR`	On success.
`other`	Was unable to retrieve data and write it into the writer.

void Run(
  void
)

Main work-horse function that executes the run-loop.

void ScheduleRun(
  void
)

Main work-horse function that executes the run-loop asynchronously on the Weave thread.

WEAVE_ERROR SetDirty(
  TraitDataSource *aDataSource,
  PropertyPathHandle aPropertyHandle
)

Marks a handle associated with a data source as being dirty.

Details

Return Values

`WEAVE_NO_ERROR`	On success.
`other`	Was unable to retrieve data and write it into the writer.