mirrors/wayland
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/wayland.git synced 2025-10-29 05:40:16 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: Clarify position of file descriptors in the stream

Browse source 
The specification left the position and order of file
descriptors unspecified. Specify that

- order of file descriptors is maintained
- position of file descriptors is bounded, but loose

Signed-off-by: Mikhail Gusarov <dottedmag@dottedmag.net>
This commit is contained in:
Mikhail Gusarov 2021-12-10 12:44:44 +01:00
parent 75c1a93e20
commit 971a0a8b84
1 changed files with 15 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

15
doc/publican/sources/Protocol.xml
View file

@ -194,6 +194,21 @@
</varlistentry>
</variablelist>
</para>
<para>
The protocol does not specify the exact position of the ancillary data
in the stream, except that the order of file descriptors is the same as
the order of messages and <code>fd</code> arguments within messages on
the wire.
</para>
<para>
In particular, it means that any byte of the stream, even the message
header, may carry the ancillary data with file descriptors.
</para>
<para>
Clients and compositors should queue incoming data until they have
whole messages to process, as file descriptors may arrive earlier
or later than the corresponding data bytes.
</para>
</section>
<xi:include href="ProtocolInterfaces.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<section id="sect-Protocol-Versioning">