oysteikt
/
mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

doc/protocol.rst: improve binary chunk description

This commit is contained in:
Max Kellermann 2019-08-12 20:23:29 +02:00
parent 4f61cd0b93
commit b717ab0383
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/protocol.rst
View File

@ -66,7 +66,16 @@ Binary Responses
Some commands can return binary data. This is initiated by a line Some commands can return binary data. This is initiated by a line
containing ``binary: 1234`` (followed as usual by a newline). After containing ``binary: 1234`` (followed as usual by a newline). After
that, the specified number of bytes of binary data follows, then a that, the specified number of bytes of binary data follows, then a
newline, and finally the ``OK`` line. Example:: newline, and finally the ``OK`` line.
If the object to be transmitted is large, the server may choose a
reasonable chunk size and transmit only a portion. Usually, the
response also contains a ``size`` line which specifies the total
(uncropped) size, and the command usually has a way to specify an
offset into the object; this way, the client can copy the whole file
without blocking the connection for too long.
Example::
foo: bar foo: bar
binary: 42 binary: 42