Skip to content

Rework callback mechanism #1

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
ethan-duckett-brill wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Rework callback mechanism #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cafa37c
Rework callback mechanism
ethan-duckett-brill Sep 26, 2024
d94f52e
Merge branch 'garethpotter:main' into userbranch/ethan/callback_rework
ethan-duckett-brill Sep 27, 2024
959f7a0
Add error code to error response
ethan-duckett-brill Oct 2, 2024
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: 2 additions & 2 deletions include/thingset.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1365,10 +1365,10 @@ enum thingset_callback_reason
};

/** Function to be called before/after read/write operations to groups. */
typedef void (*thingset_group_callback_t)(enum thingset_callback_reason cb_reason);
typedef int (*thingset_group_callback_t)(enum thingset_callback_reason cb_reason);
Copy link
Copy Markdown
Owner

@garethpotter garethpotter Oct 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be useful to add the thingset_data_object as a parameter. You can then call this inside the first deserialize_child loop (where some validation is done already).

Copy link
Copy Markdown
Author

@ethan-duckett-brill ethan-duckett-brill Oct 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should probably have more of a think about value validation tbh. The more important part right now is state checking (which this MR should now allow), and I guess the idea in my head was to permit specific ranges for specific values (I'm thinking imposing the limits from the BQ reference manual on the corresponding values etc) but that functionality likely wouldn't be elegant when calling a group callback.

Copy link
Copy Markdown
Author

@ethan-duckett-brill ethan-duckett-brill Oct 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ultimately, that can probably be added separately regardless IMO as it's nice to have, but not absolutely required right now


/** Function to be called before/after read/write operations to records. */
typedef void (*thingset_records_callback_t)(enum thingset_callback_reason cb_reason, int index);
typedef int (*thingset_records_callback_t)(enum thingset_callback_reason cb_reason, int index);

/** @cond INTERNAL_HIDDEN */

Expand Down
10 changes: 8 additions & 2 deletions src/thingset_common.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,10 @@ int thingset_common_update(struct thingset_context *ts)
ts->api->deserialize_map_start(ts);

if (ts->endpoint.object->data.group_callback != NULL) {
ts->endpoint.object->data.group_callback(THINGSET_CALLBACK_PRE_WRITE);
int ret = ts->endpoint.object->data.group_callback(THINGSET_CALLBACK_PRE_WRITE);
if (ret < 0) {
return ts->api->serialize_response(ts, THINGSET_ERR_BAD_REQUEST, "Callback error %i", ret);
}
}

/* actually write data */
Expand All @@ -364,7 +367,10 @@ int thingset_common_update(struct thingset_context *ts)
}

if (ts->endpoint.object->data.group_callback != NULL) {
ts->endpoint.object->data.group_callback(THINGSET_CALLBACK_POST_WRITE);
int ret = ts->endpoint.object->data.group_callback(THINGSET_CALLBACK_POST_WRITE);
if (ret < 0) {
return ts->api->serialize_response(ts, THINGSET_ERR_BAD_REQUEST, "Callback error %i", ret);
}
}

/*
Expand Down