Update copyright dates

[src/app-framework-binder.git] / src / afb-wsj1.h

diff --git a/src/afb-wsj1.h b/src/afb-wsj1.h
index ad73496..762e6eb 100644 (file)
--- a/src/afb-wsj1.h
+++ b/src/afb-wsj1.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2016 "IoT.bzh"
+ * Copyright (C) 2015-2020 "IoT.bzh"
  * Author: José Bollo <jose.bollo@iot.bzh>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,6 +21,7 @@ struct afb_wsj1;
 struct afb_wsj1_msg;
 
 struct json_object;
+struct fdev;
 
 /*
  * Interface for callback functions.
@@ -47,11 +48,11 @@ struct afb_wsj1_itf {
 };
 
 /*
- * Creates the afb_wsj1 socket connected to the file descriptor 'fd'
+ * Creates the afb_wsj1 socket connected to the file descriptor 'fdev'
  * and having the callback interface defined by 'itf' for the 'closure'.
  * Returns the created wsj1 websocket or NULL in case of error.
  */
-extern struct afb_wsj1 *afb_wsj1_create(int fd, struct afb_wsj1_itf *itf, void *closure);
+extern struct afb_wsj1 *afb_wsj1_create(struct fdev *fdev, struct afb_wsj1_itf *itf, void *closure);
 
 /*
  * Increases by one the count of reference to 'wsj1'
@@ -65,6 +66,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,13 +85,14 @@ 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);
 
 /*
  * Sends on 'wsj1' a call to the method of 'api'/'verb' with arguments
- * given by 'object'. If not NULL, 'object' should be a valid JSON string.  
+ * given by 'object'. If not NULL, 'object' should be a valid JSON string.
  * 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.
@@ -92,6 +102,7 @@ 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.
@@ -110,13 +121,11 @@ extern int afb_wsj1_reply_s(struct afb_wsj1_msg *msg, const char *object, const
  * 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.
@@ -130,6 +139,7 @@ static inline int afb_wsj1_reply_ok_s(struct afb_wsj1_msg *msg, const char *obje
 /*
  * 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.
  */
 static inline int afb_wsj1_reply_ok_j(struct afb_wsj1_msg *msg, struct json_object *object, const char *token)
@@ -150,6 +160,7 @@ static inline int afb_wsj1_reply_error_s(struct afb_wsj1_msg *msg, const char *o
 /*
  * 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.
  */
 static inline int afb_wsj1_reply_error_j(struct afb_wsj1_msg *msg, struct json_object *object, const char *token)