aboutsummaryrefslogtreecommitdiffstats
path: root/docs/afb-binding-references.md
diff options
context:
space:
mode:
authorJosé Bollo <jose.bollo@iot.bzh>2017-09-04 11:37:39 +0200
committerJosé Bollo <jose.bollo@iot.bzh>2017-09-07 09:43:13 +0200
commit85bca06fe0ee2923421f013da3e9f53abbfff673 (patch)
tree9760887748d9250f90e5ad068413f0d4f913e015 /docs/afb-binding-references.md
parent91c12808e08fb30e58a3d2e008569933f409d6db (diff)
Implement afb_req_has_permission
This new verb is available in bindings to check whether the client identified by a request has a given permission or not. Change-Id: I5eaa0892d8260d26bd76f37123251c103c981e10 Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'docs/afb-binding-references.md')
-rw-r--r--docs/afb-binding-references.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/afb-binding-references.md b/docs/afb-binding-references.md
index d0a9a6d0..e340d6b5 100644
--- a/docs/afb-binding-references.md
+++ b/docs/afb-binding-references.md
@@ -677,6 +677,20 @@ Instead, you should use the macros:
void afb_req_verbose(struct afb_req req, int level, const char *file, int line, const char * func, const char *fmt, ...);
```
+The function below allows a binding to check whether a client
+has a permission of not.
+
+```C
+
+/*
+ * Check whether the 'permission' is granted or not to the client
+ * identified by 'req'.
+ *
+ * Returns 1 if the permission is granted or 0 otherwise.
+ */
+int afb_req_has_permission(struct afb_req req, const char *permission);
+```
+
## Logging macros
The following macros must be used for logging: