From: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Date: Sun, 5 Jun 2005 20:39:36 +0000 (+0000)
Subject: Documentation clarified re. config socket listener protocol
X-Git-Tag: v2.5a0~1739
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=4c1423bb7a3bce158776d23e8de804f058950061;p=thirdparty%2FPython%2Fcpython.git

Documentation clarified re. config socket listener protocol
---

diff --git a/Doc/lib/liblogging.tex b/Doc/lib/liblogging.tex
index 8146059cceb7..cca83ca501be 100644
--- a/Doc/lib/liblogging.tex
+++ b/Doc/lib/liblogging.tex
@@ -1396,7 +1396,10 @@ configurations. If no port is specified, the module's default
 will be sent as a file suitable for processing by \function{fileConfig()}.
 Returns a \class{Thread} instance on which you can call \method{start()}
 to start the server, and which you can \method{join()} when appropriate.
-To stop the server, call \function{stopListening()}.
+To stop the server, call \function{stopListening()}. To send a configuration
+to the socket, read in the configuration file and send it to the socket
+as a string of bytes preceded by a four-byte length packed in binary using
+struct.\code{pack(">L", n)}.
 \end{funcdesc}
 
 \begin{funcdesc}{stopListening}{}
diff --git a/Lib/logging/config.py b/Lib/logging/config.py
index ea157db5bfc5..22132b167689 100644
--- a/Lib/logging/config.py
+++ b/Lib/logging/config.py
@@ -225,9 +225,9 @@ def listen(port=DEFAULT_LOGGING_CONFIG_PORT):
             """
             Handle a request.
 
-            Each request is expected to be a 4-byte length,
-            followed by the config file. Uses fileConfig() to do the
-            grunt work.
+            Each request is expected to be a 4-byte length, packed using
+            struct.pack(">L", n), followed by the config file.
+            Uses fileConfig() to do the grunt work.
             """
             import tempfile
             try: