[svn] commit: r2443 - in /branches/trac275/src/lib/config: ccsession.cc ccsession.h

[BIND 10 source code commits]

Author: jinmei
Date: Thu Jul  8 23:15:07 2010
New Revision: 2443

Log:
comment update and a minor cleanup (change the type of string argument
to const string&)

Modified:
    branches/trac275/src/lib/config/ccsession.cc
    branches/trac275/src/lib/config/ccsession.h

Modified: branches/trac275/src/lib/config/ccsession.cc
==============================================================================
--- branches/trac275/src/lib/config/ccsession.cc (original)
+++ branches/trac275/src/lib/config/ccsession.cc Thu Jul  8 23:15:07 2010
@@ -197,7 +197,7 @@
 }
 
 ModuleCCSession::ModuleCCSession(
-    std::string spec_file_name,
+    const std::string& spec_file_name,
     isc::cc::AbstractSession& session,
     isc::data::ElementPtr(*config_handler)(isc::data::ElementPtr new_config),
     isc::data::ElementPtr(*command_handler)(

Modified: branches/trac275/src/lib/config/ccsession.h
==============================================================================
--- branches/trac275/src/lib/config/ccsession.h (original)
+++ branches/trac275/src/lib/config/ccsession.h Thu Jul  8 23:15:07 2010
@@ -108,7 +108,7 @@
 };
 
 ///
-/// \brief This modules keeps a connection to the command channel,
+/// \brief This module keeps a connection to the command channel,
 /// holds configuration information, and handles messages from
 /// the command channel
 ///
@@ -116,13 +116,18 @@
 public:
     /**
      * Initialize a config/command session
-     * @param module_name: The name of this module. This is not a
-     *                     reference because we expect static strings
-     *                     to be passed here.
-     * @param spec_file_name: The name of the file containing the
+     *
+     * @param spec_file_name The name of the file containing the
      *                        module specification.
-     */
-    ModuleCCSession(std::string spec_file_name,
+     * @param session A Session object over which configuration and command
+     * data are exchanged.
+     * @param config_handler A callback function pointer to be called when
+     * configuration of the local module needs to be updated.
+     * @param command_handler A callback function pointer to be called when
+     * a control command from a remote agent needs to be performed on the
+     * local module.
+     */
+    ModuleCCSession(const std::string& spec_file_name,
                     isc::cc::AbstractSession& session,
                     isc::data::ElementPtr(*config_handler)(
                         isc::data::ElementPtr new_config) = NULL,