afb-xreq: Forbids (un)subscribes after reply
[src/app-framework-binder.git] / docs / reference-v3 / func-req.md
index bdec581..fb61575 100644 (file)
@@ -1,4 +1,4 @@
-Functions of class afb_req_t
+Functions of class **afb_req_t**
 ============================
 
 ## General function
@@ -528,6 +528,8 @@ int afb_req_subcall_sync(
  * Establishes for the client link identified by 'req' a subscription
  * to the 'event'.
  *
+ * Establishing subscription MUST be called BEFORE replying to the request.
+ *
  * @param req the request
  * @param event the event to subscribe
  *
@@ -546,6 +548,8 @@ int afb_req_subscribe(
  * link identified by 'req'.
  * Returns 0 in case of successful subscription or -1 in case of error.
  *
+ * Revoking subscription MUST be called BEFORE replying to the request.
+ *
  * @param req the request
  * @param event the event to revoke
  *
@@ -805,7 +809,7 @@ void afb_req_subcall_legacy(
  *
  * Makes a call to the method of name 'api' / 'verb' with the object 'args'.
  * This call is made in the context of the request 'req'.
- * This call is synchronous, it waits untill completion of the request.
+ * This call is synchronous, it waits until completion of the request.
  * It returns 0 on success or a negative value on error answer.
  * The object pointed by 'result' is filled and must be released by the caller
  * after its use by calling 'json_object_put'.