[svn] commit: r3016 - /branches/trac349/src/lib/python/isc/config/ccsession.py

[BIND 10 source code commits]

Author: vorner
Date: Fri Sep 24 13:58:28 2010
New Revision: 3016

Log:
Code cleanups

Modified:
    branches/trac349/src/lib/python/isc/config/ccsession.py

Modified: branches/trac349/src/lib/python/isc/config/ccsession.py
==============================================================================
--- branches/trac349/src/lib/python/isc/config/ccsession.py (original)
+++ branches/trac349/src/lib/python/isc/config/ccsession.py Fri Sep 24 13:58:28 2010
@@ -175,13 +175,18 @@
         """Close the session to the command channel"""
         self._session.close()
 
-    def check_command(self, nonblock = True):
+    def check_command(self, nonblock=True):
         """Check whether there is a command or configuration update
            on the channel. Call the corresponding callback function if
            there is. This function does a read on the cc session, and
            returns nothing. It will respond to any command by either
            an error or the answer message returned by the callback,
-           unless the latter is None."""
+           unless the latter is None.
+
+           If nonblock is True, it just checks if there's a command
+           and does nothing if there isn't. If nonblock is False, it
+           waits until it arrives. It temporarily sets timeout to infinity,
+           because commands may not come in arbitrary long time."""
         timeout_orig = self._session.get_timeout()
         self._session.set_timeout(0)
         try: