summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorBenjamin Dauvergne <bdauvergne@entrouvert.com>2014-07-02 11:01:34 (GMT)
committerBenjamin Dauvergne <bdauvergne@entrouvert.com>2014-07-02 11:01:34 (GMT)
commitdf232a7c20a540921073cc2805200e9a10221554 (patch)
treefaa7bfcd718979661e160faf45a5bf82b62acd8e /README
parent4b468104b7fd854b6e3091488d9f514065da5563 (diff)
downloadcmsplugin-blurp-df232a7c20a540921073cc2805200e9a10221554.zip
cmsplugin-blurp-df232a7c20a540921073cc2805200e9a10221554.tar.gz
cmsplugin-blurp-df232a7c20a540921073cc2805200e9a10221554.tar.bz2
README: describe the async options of the data_source renderer
Diffstat (limited to 'README')
-rw-r--r--README5
1 files changed, 5 insertions, 0 deletions
diff --git a/README b/README
index 77b37f8..bfbc760 100644
--- a/README
+++ b/README
@@ -134,6 +134,11 @@ A source definition is a dictionnary containing the following keys:
retrieved for the current user,
- `signature_key`, when using the HMAC authentication mechanism it
holds the secret key used to sign the exchanges,
+ - `async`, if True make refreshing the cache asynchronous (using a thread),
+ beware that if the cache is currently empty a synchronous update will be
+ done, lock are used to limit update thread to one by URL, but it you use
+ a worker engine their could be multiple thread trying to update the same
+ cache in different workers, value is optional and its default is False,
- `timeout`, a timeout for making the HTTP request, it is optional
and it default to 10 seconds,
- `refresh`, how long to cache the parsed value of the source, it