Skip to content

Commit

Permalink
declare the 'buffers' name in the messaging doc
Browse files Browse the repository at this point in the history
  • Loading branch information
minrk committed Oct 7, 2016
1 parent 439981a commit 2bf9602
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/messaging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,10 @@ A message is defined by the following four-dictionary structure::
# The actual content of the message must be a dict, whose structure
# depends on the message type.
'content' : dict,

# optional: buffers is a list of binary data buffers for implementations
# that support binary extensions to the protocol.
'buffers': list,
}

.. versionchanged:: 5.0
Expand Down Expand Up @@ -170,7 +174,7 @@ Every message is serialized to a sequence of at least six blobs of bytes:
b'{parent_header}', # serialized parent header dict
b'{metadata}', # serialized metadata dict
b'{content}', # serialized content dict
b'blob', # extra raw data buffer(s)
b'0x1234', # extra raw data buffer(s)
...
]

Expand Down

0 comments on commit 2bf9602

Please sign in to comment.