https://github.com/mjpieters/plone.app.async

Integration package for zc.async allowing asynchronous operations in Plone.
https://github.com/mjpieters/plone.app.async

Last synced: 20 days ago
JSON representation

Integration package for zc.async allowing asynchronous operations in Plone.

• Host: GitHub
• URL: https://github.com/mjpieters/plone.app.async
• Owner: mjpieters
• Created: 2010-10-14T09:33:34.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2010-10-14T14:31:38.000Z (about 14 years ago)
• Last Synced: 2024-11-14T16:46:45.106Z (about 2 months ago)
• Language: Python
• Homepage:
• Size: 199 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.txt

Awesome Lists containing this project

README

        
===============

plone.app.async

===============

Introduction

============

This package provides `zc.async`_  integration to Plone for performing

asynchronous job operations.

Installation

============

You will be typically running plone.app.async in a ZEO environment where you

will be having one or more *worker* instances that will be acting as

dispatchers polling and carrying out jobs queued by your main zope instances.

For the sake of simplicity it is assumed that you have one instance that can

queue new jobs, and one worker instance that consumes them both operating on a

single database. In this case, your buildout configuration will look similar

to::

  [zeo]

  ...

  recipe = plone.recipe.zope2zeoserver

  file-storage = ${buildout:directory}/var/filestorage/Data.fs

  [instance]

  ...

  recipe = plone.recipe.zope2instance

  eggs = Plone

      plone.app.async

  zcml-additional =

      

  environment-vars =

      ZC_ASYNC_UUID ${buildout:directory}/var/instance-uuid.txt

  [worker]

  ...

  recipe = plone.recipe.zope2instance

  zserver-threads = 2

  eggs = ${instance:eggs}

  zcml = ${instance:zcml}

  zcml-additional =

      

  environment-vars =

      ZC_ASYNC_UUID ${buildout:directory}/var/worker-uuid.txt

  zope-conf-additional =

      enable-product-installation off

There are two important stanzas above:

* Each instance has to have the `ZC_ASYNC_UUID` environmental variable to

integrate properly with `zc.async`.

* The worker instance loads the `single_db.zcml` zcml configuration in order

to setup the queue and setup itself as a dispatcher. Also, if the optional

`zc.z3monitor` product configuration is present in the buildout it will be

started.

For more details please look at the buildout configuration included in the package.

Credits

=======

Code from Enfold's `plone.async.core`_ package has been used for setting up the queues.

References

==========

* `zc.async`_ at pypi

* `plone.async.core`_ svn repository

  .. _zc.async: http://pypi.python.org/pypi/zc.async/

  .. _plone.core.async: https://svn.enfoldsystems.com/public/plone.async.core/