X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=src%2Fafb-wsj1.h;h=49b77828f736e01867e30504f6c22f69c09ebc19;hb=5b5a2e4412eea806451c016da9fb285bc09c17ab;hp=44aa5656c38b722baa8ac9320a4085435e007d53;hpb=6914f7781b42972263a417484bbeb179efe66e78;p=src%2Fapp-framework-binder.git diff --git a/src/afb-wsj1.h b/src/afb-wsj1.h index 44aa5656..49b77828 100644 --- a/src/afb-wsj1.h +++ b/src/afb-wsj1.h @@ -65,6 +65,14 @@ extern void afb_wsj1_addref(struct afb_wsj1 *wsj1); */ extern void afb_wsj1_unref(struct afb_wsj1 *wsj1); +/* + * Sends a close message to the websocket of 'wsj1'. + * The close message is sent with the 'code' and 'text'. + * 'text' can be NULL. + * Return 0 in case of success. Otherwise, returns -1 and set errno. + */ +extern int afb_wsj1_close(struct afb_wsj1 *wsj1, uint16_t code, const char *text); + /* * Sends on 'wsj1' the event of name 'event' with the * data 'object'. If not NULL, 'object' should be a valid @@ -76,6 +84,7 @@ extern int afb_wsj1_send_event_s(struct afb_wsj1 *wsj1, const char *event, const /* * Sends on 'wsj1' the event of name 'event' with the * data 'object'. 'object' can be NULL. + * 'object' is dereferenced using 'json_object_put'. Use 'json_object_get' to keep it. * Return 0 in case of success. Otherwise, returns -1 and set errno. */ extern int afb_wsj1_send_event_j(struct afb_wsj1 *wsj1, const char *event, struct json_object *object); @@ -92,39 +101,71 @@ extern int afb_wsj1_call_s(struct afb_wsj1 *wsj1, const char *api, const char *v /* * Sends on 'wsj1' a call to the method of 'api'/'verb' with arguments * given by 'object'. 'object' can be NULL. + * 'object' is dereferenced using 'json_object_put'. Use 'json_object_get' to keep it. * On receiving the reply, the function 'on_reply' is called with 'closure' * as its first argument and the message of the reply. * Return 0 in case of success. Otherwise, returns -1 and set errno. */ extern int afb_wsj1_call_j(struct afb_wsj1 *wsj1, const char *api, const char *verb, struct json_object *object, void (*on_reply)(void *closure, struct afb_wsj1_msg *msg), void *closure); +/* + * Sends for message 'msg' the reply with the 'object' and, if not NULL, the token. + * When 'iserror' is zero a OK reply is send, otherwise an ERROR reply is sent. + * If not NULL, 'object' should be a valid JSON string. + * Return 0 in case of success. Otherwise, returns -1 and set errno. + */ +extern int afb_wsj1_reply_s(struct afb_wsj1_msg *msg, const char *object, const char *token, int iserror); + +/* + * Sends for message 'msg' the reply with the 'object' and, if not NULL, the token. + * When 'iserror' is zero a OK reply is send, otherwise an ERROR reply is sent. + * 'object' can be NULL. + * 'object' is dereferenced using 'json_object_put'. Use 'json_object_get' to keep it. + * Return 0 in case of success. Otherwise, returns -1 and set errno. + */ +extern int afb_wsj1_reply_j(struct afb_wsj1_msg *msg, struct json_object *object, const char *token, int iserror); + /* * Sends for message 'msg' the OK reply with the 'object' and, if not NULL, the token. * If not NULL, 'object' should be a valid JSON string. * Return 0 in case of success. Otherwise, returns -1 and set errno. */ -extern int afb_wsj1_reply_ok_s(struct afb_wsj1_msg *msg, const char *object, const char *token); +static inline int afb_wsj1_reply_ok_s(struct afb_wsj1_msg *msg, const char *object, const char *token) +{ + return afb_wsj1_reply_s(msg, object, token, 0); +} /* * Sends for message 'msg' the OK reply with the 'object' and, if not NULL, the token. * 'object' can be NULL. + * 'object' is dereferenced using 'json_object_put'. Use 'json_object_get' to keep it. * Return 0 in case of success. Otherwise, returns -1 and set errno. */ -extern int afb_wsj1_reply_ok_j(struct afb_wsj1_msg *msg, struct json_object *object, const char *token); +static inline int afb_wsj1_reply_ok_j(struct afb_wsj1_msg *msg, struct json_object *object, const char *token) +{ + return afb_wsj1_reply_j(msg, object, token, 0); +} /* * Sends for message 'msg' the ERROR reply with the 'object' and, if not NULL, the token. * If not NULL, 'object' should be a valid JSON string. * Return 0 in case of success. Otherwise, returns -1 and set errno. */ -extern int afb_wsj1_reply_error_s(struct afb_wsj1_msg *msg, const char *object, const char *token); +static inline int afb_wsj1_reply_error_s(struct afb_wsj1_msg *msg, const char *object, const char *token) +{ + return afb_wsj1_reply_s(msg, object, token, 1); +} /* * Sends for message 'msg' the ERROR reply with the 'object' and, if not NULL, the token. * 'object' can be NULL. + * 'object' is dereferenced using 'json_object_put'. Use 'json_object_get' to keep it. * Return 0 in case of success. Otherwise, returns -1 and set errno. */ -extern int afb_wsj1_reply_error_j(struct afb_wsj1_msg *msg, struct json_object *object, const char *token); +static inline int afb_wsj1_reply_error_j(struct afb_wsj1_msg *msg, struct json_object *object, const char *token) +{ + return afb_wsj1_reply_j(msg, object, token, 1); +} /* * Increases by one the count of reference to 'msg'.