diff options
author | Jose Bollo <jose.bollo@iot.bzh> | 2019-10-07 17:41:26 +0200 |
---|---|---|
committer | José Bollo <jose.bollo@iot.bzh> | 2019-10-18 16:06:22 +0200 |
commit | 5cb824d4aca7fea9ed58325933e1eb4f1afcb9b3 (patch) | |
tree | 94f182aa40f5f092b0c3653eb29107215e8bdc3a /src/cynagora.h | |
parent | 5179f5d383f99121bf4085af4b9354638e4e168c (diff) |
More documentation and cache access control
Change-Id: Id040ad44f862c212057a854ebaf5798da5b064b9
Signed-off-by: Jose Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'src/cynagora.h')
-rw-r--r-- | src/cynagora.h | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/src/cynagora.h b/src/cynagora.h index aff1720..d5dc80f 100644 --- a/src/cynagora.h +++ b/src/cynagora.h @@ -20,7 +20,9 @@ /* IMPLEMENTATION OF CLIENT PART OF CYNAGORA-PROTOCOL */ /******************************************************************************/ /******************************************************************************/ - +/** + * @file cynagora.h + */ /******************************************************************************/ /* COMMON PART - types and functions common to check/admin/agent clients */ /******************************************************************************/ @@ -216,6 +218,7 @@ cynagora_cache_check( * * @param cynagora the client handler * @param key the key to check + * @param force if not set forbids cache use * * @return 0 if permission forbidden, 1 if permission granted * or if error a negative -errno value @@ -226,7 +229,8 @@ extern int cynagora_check( cynagora_t *cynagora, - const cynagora_key_t *key + const cynagora_key_t *key, + int force ); /** @@ -235,7 +239,10 @@ cynagora_check( * * @param cynagora the client handler * @param key - * @return + * @param force if not set forbids cache use + * + * @return 0 if permission forbidden, 1 if permission granted + * or if error a negative -errno value * * @see cynagora_check */ @@ -243,7 +250,8 @@ extern int cynagora_test( cynagora_t *cynagora, - const cynagora_key_t *key + const cynagora_key_t *key, + int force ); /** @@ -251,6 +259,7 @@ cynagora_test( * * @param cynagora the handler of the client * @param key the key to query + * @param force if not set forbids cache use * @param simple if zero allows agent process else if not 0 forbids it * @param callback the callback to call on reply * @param closure a closure for the callback @@ -262,6 +271,7 @@ int cynagora_async_check( cynagora_t *cynagora, const cynagora_key_t *key, + int force, int simple, cynagora_async_check_cb_t *callback, void *closure |