summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2018-05-16 21:46:56 -0700
committerGarrett D'Amore <garrett@damore.org>2018-05-17 09:44:39 -0700
commite490aa3353f05e158a0f1f485f371cd49e70b4f5 (patch)
treeb435b7587b94a3f3d5d8ec127e2d63cc978622bc /docs
parenteab6a4d2d96d11d3926e927c135362fc166895f0 (diff)
downloadnng-e490aa3353f05e158a0f1f485f371cd49e70b4f5.tar.gz
nng-e490aa3353f05e158a0f1f485f371cd49e70b4f5.tar.bz2
nng-e490aa3353f05e158a0f1f485f371cd49e70b4f5.zip
fixes #441 Unintentional semantic in bus protocol
Diffstat (limited to 'docs')
-rw-r--r--docs/man/nng_bus.7.adoc15
1 files changed, 13 insertions, 2 deletions
diff --git a/docs/man/nng_bus.7.adoc b/docs/man/nng_bus.7.adoc
index bb993f7c..98367c3d 100644
--- a/docs/man/nng_bus.7.adoc
+++ b/docs/man/nng_bus.7.adoc
@@ -64,8 +64,19 @@ The _bus_ protocol has no protocol-specific options.
=== Protocol Headers
-The _bus_ protocol has no protocol-specific headers.
-
+When using a "`<<nng.7#raw_mode,raw>>`" _bus_ socket, received messages will
+contain the incoming <<nng_pipe.5#,pipe>> ID as the sole element in the header.
+If a message containing such a header is sent using a raw _bus_ socket, then,
+the message will be delivered to all connected pipes _except_ the one
+identified in the header.
+This behavior is intended for use with <<nng_device.3#device,device>>
+configurations consisting of just a single socket.
+Such configurations are useful in the creation of rebroadcasters, and this
+capaibility prevents a message from being routed back to its source.
+If no header is present, then a message is sent to all connected pipes.
+
+When using "`cooked`" _bus_ sockets, no message headers are present.
+
== SEE ALSO
<<nng_bus_open.3#,nng_bus_open(3)>>,