From 229a476aa052c63b5928aa72343c8a398588fcee Mon Sep 17 00:00:00 2001 From: vrde Date: Wed, 9 Aug 2017 17:38:44 +0200 Subject: [PATCH] Fix typos --- .../server/source/events/event-plugin-api.rst | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/server/source/events/event-plugin-api.rst b/docs/server/source/events/event-plugin-api.rst index 725d4c22..d8b4600a 100644 --- a/docs/server/source/events/event-plugin-api.rst +++ b/docs/server/source/events/event-plugin-api.rst @@ -2,7 +2,7 @@ The Event Plugin API [experimental] =================================== .. danger:: - The Event Plugin API is **experimental** and might change in the future. + The Event Plugin API is **experimental** and might change in the future. BigchainDB implements an internal event system that allows different software components to receive updates on specific topics. The WebSocket API, for example, @@ -11,10 +11,10 @@ voted valid, the WebSocket API is notified, and it sends updates to all the clients connected. We decided to make this internal event system public, to allow developers to -integrate BigchainDB with other applications, such as AMPQ systems. +integrate BigchainDB with other applications, such as AMQP systems. -Available events +Available Events ---------------- The event types are listed in the source file ``bigchaindb/events.py``. @@ -34,14 +34,12 @@ The event types are listed in the source file ``bigchaindb/events.py``. - a block has been voted invalid by the network. - Plugin Example ---------------- We developed a minimal plugin that listens to new valid blocks and prints them to the console: - -- https://github.com/bigchaindb/bigchaindb_events_plugin_example +https://github.com/bigchaindb/bigchaindb_events_plugin_example Architecture of an Event Plugin @@ -52,16 +50,18 @@ Creating your own plugin is really easy, and can be summarized in few steps: 1. Create a new Python package that defines the entry point ``bigchaindb.events`` in its ``setup.py``. 2. In your entry point, define two properties: - - ``event_types``: a variable to tell BigchainDB to which events your plugin is interested. + - ``event_types``: a variable to tell BigchainDB which events your plugin is interested in. + A plugin can subscribe to more than one events by combining them using the + **binary or** operator, e.g. in case you want to subscribe to both valid and + invalid blocks your ``event_types`` can be ``1 | 2``. - ``run``: a function that will process the events coming from BigchainDB. -3. Install the newly created Python in the current environment. +3. Install the newly created Python package in the current environment. 4. Add the plugin name to your BigchainDB configuration. -5. (Re)start BigchainDB +5. (Re)start BigchainDB. If the installation was successful, the plugin will be run in a different process. Your plugin will receive events through a ``multiprocessing.Queue`` -object. Remember: it's your plugin responsibility to consume that queue. +object. -A plugin can subscribe to more than one events by combining them using the -**binary or** operator, e.g. in case you want to subscribe to both valid and -invalid blocks your ``event_types`` can be ``1 | 2``. +.. note:: + It's your plugin's responsibility to consume it's queue.