[couchdb-ioq] branch allow-for-dynamic-ioq-classes updated: Add dynamic IOQ class documentation

[ch...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

chewbranca pushed a commit to branch allow-for-dynamic-ioq-classes
in repository https://gitbox.apache.org/repos/asf/couchdb-ioq.git


The following commit(s) were added to refs/heads/allow-for-dynamic-ioq-classes by this push:
     new c0ce268  Add dynamic IOQ class documentation
c0ce268 is described below

commit c0ce268060a5974928e891192613c8895f16414f
Author: Russell Branca <ch...@apache.org>
AuthorDate: Thu Apr 18 21:18:28 2019 +0000

    Add dynamic IOQ class documentation
---
 IOQ2.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/IOQ2.md b/IOQ2.md
index ddf8d22..849fbe2 100644
--- a/IOQ2.md
+++ b/IOQ2.md
@@ -611,6 +611,16 @@ You can see the proper names for all registered IOQ classes with the following:
 ```
 
 
+### Dynamic IOQ classes
+
+To support 3rd party IO channels for things like search/geo/cache/etc, you can
+manually set a config priority for the desired class, and then it will be
+picked up by `ioq_config:is_valid_class/1`. Because the `ioq_config:set_*`
+setters depend on `is_valid_class`, you must manually define the priority
+initially, for example with `config:set("ioq.classes", "search", "1.0").`.
+Afterwards, you'll be able to utilize the setters as expected.
+
+
 ## ioq_server2:get_state
 
 You can see a human readable representation of the IOQ2 server state with the