From: Mukund Sivaraman <muks@isc.org>
Date: Mon, 10 Jun 2013 08:32:23 +0000 (+0530)
Subject: [2853] Update ZoneWriter documentation from C++ docs using doxygen XML output
X-Git-Tag: bind10-1.2.0beta1-release~399^2~28
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a555e12ddf75657f9ba417f1bc9366c8ba094854;p=thirdparty%2Fkea.git

[2853] Update ZoneWriter documentation from C++ docs using doxygen XML output
---

diff --git a/src/lib/python/isc/datasrc/Makefile.am b/src/lib/python/isc/datasrc/Makefile.am
index 7643d3bf8e..af32cea818 100644
--- a/src/lib/python/isc/datasrc/Makefile.am
+++ b/src/lib/python/isc/datasrc/Makefile.am
@@ -39,6 +39,7 @@ EXTRA_DIST += iterator_inc.cc
 EXTRA_DIST += updater_inc.cc
 EXTRA_DIST += journal_reader_inc.cc
 EXTRA_DIST += zone_loader_inc.cc
+EXTRA_DIST += zonewriter_inc.cc
 
 CLEANDIRS = __pycache__
 
diff --git a/src/lib/python/isc/datasrc/zonewriter_inc.cc b/src/lib/python/isc/datasrc/zonewriter_inc.cc
new file mode 100644
index 0000000000..dc19a4676f
--- /dev/null
+++ b/src/lib/python/isc/datasrc/zonewriter_inc.cc
@@ -0,0 +1,100 @@
+// Copyright (C) 2013  Internet Systems Consortium, Inc. ("ISC")
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+// OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+namespace {
+
+const char* const ZoneWriter_doc = "\
+Does an update to a zone.\n\
+\n\
+This represents the work of a (re)load of a zone. The work is divided\n\
+into three stages  load(), install() and cleanup(). They should be\n\
+called in this order for the effect to take place.\n\
+\n\
+We divide them so the update of zone data can be done asynchronously,\n\
+in a different thread. The install() operation is the only one that\n\
+needs to be done in a critical section.\n\
+\n\
+This class provides strong exception guarantee for each public method.\n\
+That is, when any of the methods throws, the entire state stays the\n\
+same as before the call.\n\
+\n\
+ZoneWriter objects cannot be constructed directly. They have to be\n\
+obtained by using get_cached_zone_writer() on a ConfigurableClientList.\n\
+\n\
+";
+
+const char* const ZoneWriter_load_doc = "\
+load() -> err_msg\n\
+\n\
+Get the zone data into memory.\n\
+\n\
+This is the part that does the time-consuming loading into the memory.\n\
+This can be run in a separate thread, for example. It has no effect on\n\
+the data actually served, it only prepares them for future use.\n\
+\n\
+This is the first method you should call on the object. Never call it\n\
+multiple times.\n\
+\n\
+If the ZoneWriter was constructed with catch_load_error being True, then\n\
+in case a load error happens, a string with the error message will be\n\
+returned. In all other cases, None is returned..\n\
+\n\
+Exceptions:\n\
+  isc.InvalidOperation if called second time.\n\
+  DataSourceError load related error (not thrown if constructed with\n\
+             catch_load_error being false).\n\
+\n\
+";
+
+const char* const ZoneWriter_install_doc = "\
+install() -> void\n\
+\n\
+Put the changes to effect.\n\
+\n\
+This replaces the old version of zone with the one previously prepared\n\
+by load(). It takes ownership of the old zone data, if any.\n\
+\n\
+You may call it only after successful load() and at most once. It\n\
+includes the case the writer is constructed with catch_load_error\n\
+being true and load() encountered and caught a DataSourceError\n\
+exception. In this case this method installs a special empty zone to\n\
+the table.\n\
+\n\
+The operation is expected to be fast and is meant to be used inside a\n\
+critical section.\n\
+\n\
+This may throw in rare cases. If it throws, you still need to call\n\
+cleanup().\n\
+\n\
+Exceptions:\n\
+  isc.InvalidOperation if called without previous load() or for the\n\
+             second time or cleanup() was called already.\n\
+\n\
+";
+
+const char* const ZoneWriter_cleanup_doc = "\
+cleanup() -> void\n\
+\n\
+Clean up resources.\n\
+\n\
+This releases all resources held by owned zone data. That means the\n\
+one loaded by load() in case install() was not called or was not\n\
+successful, or the one replaced in install().\n\
+\n\
+Exceptions:\n\
+  none\n\
+\n\
+";
+
+} // unnamed namespace
diff --git a/src/lib/python/isc/datasrc/zonewriter_python.cc b/src/lib/python/isc/datasrc/zonewriter_python.cc
index 1e7df65a3b..713c44db67 100644
--- a/src/lib/python/isc/datasrc/zonewriter_python.cc
+++ b/src/lib/python/isc/datasrc/zonewriter_python.cc
@@ -30,6 +30,8 @@
 #include "zonewriter_python.h"
 #include "datasrc.h"
 
+#include "zonewriter_inc.cc"
+
 using namespace std;
 using namespace isc::util::python;
 using namespace isc::datasrc;
@@ -143,40 +145,15 @@ ZoneWriter_cleanup(PyObject* po_self, PyObject*) {
 // 3. Argument type
 // 4. Documentation
 PyMethodDef ZoneWriter_methods[] = {
-    { "load", ZoneWriter_load, METH_NOARGS,
-        "load() -> None\n\
-\n\
-Get the zone data into memory.\n\
-\n\
-This is the part that does the time-consuming loading into the memory.\n\
-This can be run in a separate thread, for example. It has no effect on\n\
-the data actually served, it only prepares them for future use." },
+    { "load", ZoneWriter_load, METH_VARARGS,
+      ZoneWriter_load_doc },
     { "install", ZoneWriter_install, METH_NOARGS,
-        "install() -> None\n\
-\n\
-Put the changes to effect.\n\
-\n\
-This replaces the old version of zone with the one previously prepared\n\
-by load(). It takes ownership of the old zone data, if any." },
+      ZoneWriter_install_doc },
     { "cleanup", ZoneWriter_cleanup, METH_NOARGS,
-        "cleanup() -> None\n\
-\n\
-Clean up resources.\n\
-\n\
-This releases all resources held by owned zone data. That means the\n\
-one loaded by load() in case install() was not called or was not\n\
-successful, or the one replaced in install()." },
+      ZoneWriter_cleanup_doc },
     { NULL, NULL, 0, NULL }
 };
 
-const char* const ZoneWriter_doc = "\
-Does an update to a zone\n\
-\n\
-This represents the work of a (re)load of a zone.  The work is divided\n\
-into three stages -- load(), install() and cleanup().  They should\n\
-be called in this order for the effect to take place.\n\
-";
-
 } // end of unnamed namespace
 
 namespace isc {