Update copyright dates

[src/app-framework-binder.git] / include / afb / afb-req-x1.h

diff --git a/include/afb/afb-req-x1.h b/include/afb/afb-req-x1.h
index cea17d0..88337b9 100644 (file)
--- a/include/afb/afb-req-x1.h
+++ b/include/afb/afb-req-x1.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2016, 2017, 2018 "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");
@@ -20,6 +20,9 @@
 #include "afb-req-x1-itf.h"
 #include "afb-event-x1.h"
 
+/** @addtogroup AFB_REQ
+ *  @{ */
+
 /**
  * @deprecated use bindings version 3
  *
@@ -271,6 +274,7 @@ static inline int afb_req_x1_session_set_LOA(struct afb_req_x1 req, unsigned lev
  *
  * Establishes for the client link identified by 'req' a subscription
  * to the 'event'.
+ * Establishing subscriptions MUST be called BEFORE replying to the request.
  * Returns 0 in case of successful subscription or -1 in case of error.
  */
 static inline int afb_req_x1_subscribe(struct afb_req_x1 req, struct afb_event_x1 event)
@@ -283,6 +287,7 @@ static inline int afb_req_x1_subscribe(struct afb_req_x1 req, struct afb_event_x
  *
  * Revokes the subscription established to the 'event' for the client
  * link identified by 'req'.
+ * Revoking subscription MUST be called BEFORE replying to the request.
  * Returns 0 in case of successful subscription or -1 in case of error.
  */
 static inline int afb_req_x1_unsubscribe(struct afb_req_x1 req, struct afb_event_x1 event)
@@ -451,3 +456,5 @@ static inline struct json_object *afb_req_x1_get_client_info(struct afb_req_x1 r
 }
 
 
+
+/** @} */