Skip to content

Update header comment for apteryx_watch_tree #443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thomasjwinter wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update header comment for apteryx_watch_tree #443

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion apteryx.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -618,17 +618,19 @@ bool apteryx_unwatch (const char *path, apteryx_watch_callback cb);

/**
* Callback function to be called when a watched tree changes.
* The callback function must call apteryx_free_tree on the passed in root tree.
* @param root pointer to the N-ary tree of nodes representing the changed data
* @return true on success
*/
typedef bool (*apteryx_watch_tree_callback) (GNode *root);

/**
* Watch for changes in the path and pass teh callback a tree of changes
* Watch for changes in the path and pass the callback a tree of changes
* Supports *(wildcard) at the end of path for all children under this path
* Supports /(level) at the end of path for children only under this current path (one level down)
* Whenever a change occurs in a monitor path, cb is called with the
* longest common path to all recent changes
* The callback function must call apteryx_free_tree on the passed in root tree.
* @param path path to the value to be monitored
* @param cb function to call when the value changes
* @param flags to change the watch behaviour
Expand Down