Changes between Version 31 and Version 32 of PacketEncoding

Timestamp:

01/12/17 11:38:27 (4 years ago)

Author:

Antoine Martin

Comment:

--

PacketEncoding

@@ -18 +18 @@
 * one byte for protocol flags (stream encoder used, encryption, etc)
 * one byte for compression level hint (0 for uncompressed)
-* one byte for the chunk index (0 for main chunk)
+* one byte for the chunk index (0 for the main chunk)
 * one long (4 bytes) for the size of the data that follows
 
 [[BR]]
 The main chunk containing the message uses index 0 and it is encoded (see bencode / rencode below).
+
 The main message consists of a list of values, the first item is the packet type (see [/wiki/NetworkProtocol]).
+
 The other chunks replace the item found at the specified index in the main chunk. (which should be empty)
+The main chunk always comes last.
 [[BR]]
 
@@ -32 +35 @@
 == Bencode vs Rencode ==
 The main chunk is encoded using one of those stream encoders:
-* The old [/browser/xpra/trunk/src/xpra/net/bencode.py bencode] mode (see [http://en.wikipedia.org/wiki/Bencode Bencode on wikipedia]): a modified bencoder which supports non string keys in dictionaries, non ordered keys, and support for unicode
+* The old [/browser/xpra/trunk/src/xpra/net/bencode.py bencode] mode (see [http://en.wikipedia.org/wiki/Bencode Bencode on wikipedia]): a modified bencoder which supports non string keys in dictionaries, non ordered keys, and support for unicode values
 * The newer/faster [/browser/xpra/trunk/src/rencode rencode] mode, based on [https://code.google.com/p/rencode/ this version] with minor tweaks/fixes (packaging info: #683)
 * YAML (see r6934) which is much slower, but more widely available
 [[BR]]
 This allows various languages to implement the xpra protocol, specifying which encoder they want to use (bencode is more widely available than rencode).
-We also include a faster bencoder implemented in Cython, which is roughly twice as fast as the pure Python version and does make a difference to the overall performance of the system: [http://xpra.org/stats/bencode/ Cython vs Python bencoder], but rencode is 3 times faster than that still!
+We also include a faster bencoder implemented in Cython, which is roughly twice as fast as the pure Python version and does make a difference to the overall performance of the system: [http://xpra.org/stats/bencode/ Cython vs Python bencoder], but rencode is 3 times faster than that still.
 
 The python client and server can specify which packet encoders should be enabled using the switch {{{--packet-encoders=}}} (or via the config file).
@@ -47 +50 @@
 == Pixels and Icons ==
 
-'''Note''': all window pixels, icons and cursors are sent in their own chunk using dedicated [/wiki/Encodings picture encodings] and bypass the stream encoder completely (for efficiency). Pixel compression is done in its own thread, to improve responsiveness.
+'''Note''': all window pixels, icons and cursors are usually sent in their own chunk using dedicated [/wiki/Encodings picture encodings] and bypass the stream encoder completely (for efficiency). Pixel compression is done in its own thread, to improve responsiveness.
 
 The only exception to this rule is the `RGB` encoding, which will use the stream compression on the raw pixels (but it is still called from the pixel compression thread to preserve responsiveness).
@@ -55 +58 @@
 {{{#!div class="box"
 == Compression ==
-There are up to 3 compressors supported:
-* [http://www.zlib.net/ zlib] - which is always available
+There are up to 3 types of compressors supported:
+* [http://www.zlib.net/ zlib] - which is always available but very inefficient
 * [https://code.google.com/p/lz4/ lz4] - available on most systems, used by default if present (more information here: #443)
 * [http://www.oberhumer.com/opensource/lzo/ lzo] (version 0.14.0 onwards): not as efficient as lz4, but still much faster than zlib.
 
-In version 0.14.0, you can select which compressors are enabled using the {{{--compressors=}}} switch (or the configuration file).
+You can select which compressors are enabled using the {{{--compressors=}}} switch (or the equivalent entry in the [/wiki/Configuration configuration] file).
 
 [[BR]]