From 36cae596db8114e8eb573e71c087bb52eb3f0624 Mon Sep 17 00:00:00 2001 From: Peter Thorson Date: Sun, 30 Jun 2013 18:32:37 -0500 Subject: [PATCH] update documentation --- .../extensions/permessage_deflate/enabled.hpp | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/websocketpp/extensions/permessage_deflate/enabled.hpp b/websocketpp/extensions/permessage_deflate/enabled.hpp index 117c2946b6..aeba9291c3 100644 --- a/websocketpp/extensions/permessage_deflate/enabled.hpp +++ b/websocketpp/extensions/permessage_deflate/enabled.hpp @@ -284,12 +284,10 @@ public: /// Limit server LZ77 sliding window size /** - * - * - * The bits setting is the base 2 logarithm of the window size to use to - * compress outgoing messages. The permitted range is 8 to 15 inclusive. - * 8 represents a 256 byte window and 15 a 32KiB window. The default - * setting is 15. + * The bits setting is the base 2 logarithm of the maximum window size that + * the server must use to compress outgoing messages. The permitted range + * is 8 to 15 inclusive. 8 represents a 256 byte window and 15 a 32KiB + * window. The default setting is 15. * * Mode Options: * - accept: Accept whatever the remote endpoint offers. @@ -297,6 +295,11 @@ public: * - largest: Accept largest window size acceptable to both endpoints * - smallest: Accept smallest window size acceptiable to both endpoints * + * This setting is dependent on server support. A client requesting this + * setting may be rejected by the server or have the exact value used + * adjusted by the server. A server may unilaterally set this value without + * client support. + * * @param bits The size to request for the outgoing window size * @param mode The mode to use for negotiating this parameter * @return A status code