archive/blender-cloud-addon
Archived
1
3
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity

Updated the README with the new asyncio loop management stuff.

Browse Source 
Also added some more installation instructions.
This commit is contained in:
Sybren A. Stüvel 2016-03-23 13:54:23 +01:00
parent 0974c460e8
commit 41e8f871f9
1 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -24,6 +24,16 @@ and [lockfile](https://pypi.python.org/pypi/lockfile) to be placed in
`blender_cloud/wheels`, or installed somewhere where Blender can find `blender_cloud/wheels`, or installed somewhere where Blender can find
them. them.
The addon requires HTTPS connections, and thus is dependent on
[D1845](https://developer.blender.org/D1845). You can do either of
these:
* Build Blender yourself
* Get a recent copy from the buildbot
* Copy certificate authority certificate PEM file to
`blender/2.77/python/lib/python3.5/site-packages/requests/cacert.pem`.
You can use the same file from your local requests installation, or
use `/etc/ssl/certs/ca-certificates.crt`.
Design Design
------ ------
@ -61,20 +71,14 @@ thread would break motivation 3 described above. For integration with
Blender this default behaviour is unwanted, which is solved in the Blender this default behaviour is unwanted, which is solved in the
`blender_cloud.async_loop` module as follows: `blender_cloud.async_loop` module as follows:
1. `ensure_async_loop()` installs `kick_async_loop()` as a 1. `ensure_async_loop()` starts `AsyncLoopModalOperator`.
`scene_update_pre` handler. This ensures that the 2. `AsyncLoopModalOperator` registers a timer, and performs a single
`kick_async_loop()` function is called on a regular basis from iteration of the event loop on each timer tick.
Blender. It also makes sure the function is registered only once. As only a single iteration is performed per timer tick, this only
2. `kick_async_loop()` performs a single iteration of the event loop. blocks for a very short time -- sockets and file descriptors are
It monitors the task scheduler to determine whether all scheduled inspected to see whether a reading task can continue without
tasks are done; if that is the case, it calls `stop_async_loop()`. blocking.
As only a single iteration is performed, this only blocks for a very 3. The modal operator stops automatically when all tasks are done.
short time -- sockets and file descriptors are inspected to see
whether a reading task can continue without blocking.
3. `stop_async_loop()` removes the `scene_update_pre` handler. This is
done by name, instead of object identify, such that it survives a
reload of the addon code between installation and removal of the
handler.
### Recommended workflow ### Recommended workflow