aboutsummaryrefslogtreecommitdiffhomepage
path: root/backends/loopback.md
diff options
context:
space:
mode:
authorcbdev <cb@cbcdn.com>2019-03-31 09:00:12 +0200
committercbdev <cb@cbcdn.com>2019-03-31 09:00:12 +0200
commit0c333567f599206cb0be6b74f02e59820536e0b2 (patch)
tree23f23e26969103948d433d41762d98e048f4b3ba /backends/loopback.md
parenta2b0728027dd8961ef84220c8c8eaf8a81154c71 (diff)
downloadmidimonster-0c333567f599206cb0be6b74f02e59820536e0b2.tar.gz
midimonster-0c333567f599206cb0be6b74f02e59820536e0b2.tar.bz2
midimonster-0c333567f599206cb0be6b74f02e59820536e0b2.zip
Move backend documentation out of main README
Diffstat (limited to 'backends/loopback.md')
-rw-r--r--backends/loopback.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/backends/loopback.md b/backends/loopback.md
new file mode 100644
index 0000000..a06c768
--- /dev/null
+++ b/backends/loopback.md
@@ -0,0 +1,28 @@
+### The `loopback` backend
+
+This backend allows the user to create logical mapping channels, for example to exchange triggering
+channels easier later. All events that are input are immediately output again on the same channel.
+
+#### Global configuration
+
+All global configuration is ignored.
+
+#### Instance configuration
+
+All instance configuration is ignored
+
+#### Channel specification
+
+A channel may have any string for a name.
+
+Example mapping:
+```
+loop.foo < loop.bar123
+```
+
+#### Known bugs / problems
+
+It is possible (and very easy) to configure loops using this backend. Triggering a loop
+will create a deadlock, preventing any other backends from generating events.
+Be careful with bidirectional channel mappings, as any input will be immediately
+output to the same channel again. \ No newline at end of file