summaryrefslogtreecommitdiff
path: root/doc/zmq_pgm.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/zmq_pgm.txt')
-rw-r--r--doc/zmq_pgm.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/zmq_pgm.txt b/doc/zmq_pgm.txt
index 72ae24f..9a48afd 100644
--- a/doc/zmq_pgm.txt
+++ b/doc/zmq_pgm.txt
@@ -93,6 +93,11 @@ order specifying either the offset of the first message 'frame' in the datagram
or containing the value `0xFFFF` if the datagram contains solely an
intermediate part of a larger message.
+Note that offset specifies where the first message begins rather than the first
+message part. Thus, if there are trailing message parts at the beginning of
+the packet the offset ignores them and points to first initial message part
+in the packet.
+
The following diagram illustrates the layout of a single PGM datagram payload:
....