Document how RECEIPTs work. Documentation:

is provided in godoc and in the project wiki.
gmallard · Apr 25, 2015 · 048c068 · 048c068
1 parent 61329eb
commit 048c068
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/doc.go b/doc.go
@@ -80,5 +80,20 @@
 
  For details on Subscribe requirements and behavior, see: https://github.com/gmallard/stompngo/wiki/subscribe-and-messagedata
 
+
+ RECEIPTs
+
+ Receipts are never received on a subscription unique MessageData channel.
+
+ They are always queued to the shared connection level
+ stompgo.Connection.MessageData channel.
+
+ The reason for this behavior is because RECEIPT frames do not contain a subscription Header
+ (per the STOMP specifications). See the:
+
+ https://github.com/gmallard/stompngo_examples
+
+ package for several examples.
+
 */
 package stompngo