X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=include%2Fafb%2Fafb-event-itf.h;h=5f7b8370cd6d94fd1a1b8d493ed0dd66dcceb180;hb=399d235e33b55922f15570f0ee0076529c518efc;hp=47ffa387b96519ea35fe9f721f267ef7e50e9a46;hpb=7e0abe76db7b90369429bf387d7aad0fb5a42328;p=src%2Fapp-framework-binder.git diff --git a/include/afb/afb-event-itf.h b/include/afb/afb-event-itf.h index 47ffa387..5f7b8370 100644 --- a/include/afb/afb-event-itf.h +++ b/include/afb/afb-event-itf.h @@ -25,7 +25,7 @@ struct json_object; * It records the functions to be called for the request. * Don't use this structure directly. * Use the helper functions documented below. - */ + */ struct afb_event_itf { /* CAUTION: respect the order, add at the end */ @@ -35,18 +35,28 @@ struct afb_event_itf { }; /* - * Describes the request by plugins from afb-daemon + * Describes the request of afb-daemon for bindings */ struct afb_event { const struct afb_event_itf *itf; /* the interface to use */ void *closure; /* the closure argument for functions of 'itf' */ }; +/* + * Checks wether the 'event' is valid or not. + * + * Returns 0 if not valid or 1 if valid. + */ +static inline int afb_event_is_valid(struct afb_event event) +{ + return event.itf != NULL; +} + /* * Broadcasts widely the 'event' with the data 'object'. * 'object' can be NULL. * - * For conveniency, the function calls 'json_object_put' for 'object'. + * For convenience, the function calls 'json_object_put' for 'object'. * Thus, in the case where 'object' should remain available after * the function returns, the function 'json_object_get' shall be used. * @@ -58,10 +68,10 @@ static inline int afb_event_broadcast(struct afb_event event, struct json_object } /* - * Pushes the 'event' with the data 'object' to its obeservers. + * Pushes the 'event' with the data 'object' to its observers. * 'object' can be NULL. * - * For conveniency, the function calls 'json_object_put' for 'object'. + * For convenience, the function calls 'json_object_put' for 'object'. * Thus, in the case where 'object' should remain available after * the function returns, the function 'json_object_get' shall be used. *