BIND 10 trac3065, updated. df4d44fb1d1b127847a61a84f5cb529a7a4cd324 [3065] Added doxygen file for libdhcp_ddns

[BIND 10 source code commits]

The branch, trac3065 has been updated
       via  df4d44fb1d1b127847a61a84f5cb529a7a4cd324 (commit)
      from  cffabd52cf16cb75e896abb29ee194e6e90223b9 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit df4d44fb1d1b127847a61a84f5cb529a7a4cd324
Author: Thomas Markwalder <tmark at isc.org>
Date:   Fri Jul 26 11:54:37 2013 -0400

    [3065] Added doxygen file for libdhcp_ddns

-----------------------------------------------------------------------

Summary of changes:
 doc/Doxyfile                       |    1 +
 doc/devel/mainpage.dox             |    1 +
 src/lib/dhcp_ddns/Makefile.am      |    2 +-
 src/lib/dhcp_ddns/libdhcp_ddns.dox |   47 ++++++++++++++++++++++++++++++++++++
 4 files changed, 50 insertions(+), 1 deletion(-)
 create mode 100644 src/lib/dhcp_ddns/libdhcp_ddns.dox

-----------------------------------------------------------------------
diff --git a/doc/Doxyfile b/doc/Doxyfile
index 57c6ce1..c82caa9 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -690,6 +690,7 @@ INPUT                  = ../src/lib/exceptions \
                          ../src/lib/dhcp \
                          ../src/lib/dhcpsrv \
                          ../src/bin/dhcp4 \
+                         ../src/lib/dhcp_ddns \
                          ../src/bin/d2 \
                          ../tests/tools/perfdhcp \
                          devel
diff --git a/doc/devel/mainpage.dox b/doc/devel/mainpage.dox
index 9b8d2a1..9f165cf 100644
--- a/doc/devel/mainpage.dox
+++ b/doc/devel/mainpage.dox
@@ -66,6 +66,7 @@
  *   - @subpage allocengine
  * - @subpage dhcpDatabaseBackends
  * - @subpage perfdhcpInternals
+ * - @subpage libdhcp_ddns
  *
  * @section miscellaneousTopics Miscellaneous topics
  * - @subpage LoggingApi
diff --git a/src/lib/dhcp_ddns/Makefile.am b/src/lib/dhcp_ddns/Makefile.am
index ee31711..9da22ae 100644
--- a/src/lib/dhcp_ddns/Makefile.am
+++ b/src/lib/dhcp_ddns/Makefile.am
@@ -20,7 +20,7 @@ dhcp_ddns_messages.h dhcp_ddns_messages.cc: dhcp_ddns_messages.mes
 BUILT_SOURCES = dhcp_ddns_messages.h dhcp_ddns_messages.cc
 
 # Ensure that the message file is included in the distribution
-EXTRA_DIST = dhcp_ddns_messages.mes
+EXTRA_DIST = dhcp_ddns_messages.mes libdhcp_ddns.dox
 
 # Get rid of generated message files on a clean
 CLEANFILES = *.gcno *.gcda dhcp_ddns_messages.h dhcp_ddns_messages.cc
diff --git a/src/lib/dhcp_ddns/libdhcp_ddns.dox b/src/lib/dhcp_ddns/libdhcp_ddns.dox
new file mode 100644
index 0000000..af7c943
--- /dev/null
+++ b/src/lib/dhcp_ddns/libdhcp_ddns.dox
@@ -0,0 +1,47 @@
+// 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.
+
+/**
+ at page libdhcp_ddns DHCP_DDNS Request IO Library
+
+ at section libdhcp_ddnsIntro Libdhcp_ddns Library Introduction
+
+libdhcp_ddns is a library of classes for sending and receiving requests used
+by ISC's  DHCP-DDNS service for carrying out DHCP-driven DDNS.  These requests
+are implemented in this library by the class, NameChangeRequest.
+
+This class provides services for constructing the requests as well as
+marshalling them to and from various transport formats.  Currently, the only
+format supported is JSON, however the design of the classes in this library is such that supporting additional formats will be easy to add.
+
+For sending and receiving NameChangeRequests, this library supplies an abstract
+pair of classes, NameChangeSender and NameChangeListener.  NameChangeSender
+defines the public interface that DHCP_DDNS clients, such as DHCP servers use
+for sending requests to DHCP_DDNS.   NameChangeListener is used by request
+consumers, primarily the DHCP_DDNS service, for receiving the requests.
+
+By providing abstract interfaces, the implementation isolates the senders and
+listeners from any underlying details of request transportation.  This was done
+to allow support for a variety of transportation mechanisms.  Currently, the
+only transport supported is via UDP Sockets, though support for TCP/IP sockets
+is forthcoming.  There may eventually be an implementation which is driven
+through an RDBMS.
+
+The UDP implementation is provided by NameChangeUDPSender and NameChangeUPDListener.
+The implementation is strictly unidirectional.  This means that there is no explicit
+acknowledgement of receipt of a request, and as it is UDP there is no guarantee of
+delivery.  Once provided, transport via TCP/IP sockets will provide a more reliable
+mechanism.
+
+*/