summaryrefslogtreecommitdiffstats
path: root/src/lib/dhcpsrv/libdhcpsrv.dox
diff options
context:
space:
mode:
authorThomas Markwalder <tmark@isc.org>2016-07-14 15:09:03 +0200
committerThomas Markwalder <tmark@isc.org>2016-07-14 15:09:03 +0200
commitc941012d8e8359198d1a26f51af78f83c1f5fa95 (patch)
tree2daab26904c7eef2469dac7b126ca3e40930d8bb /src/lib/dhcpsrv/libdhcpsrv.dox
parent[4277] Addressed bulk of review comments (diff)
downloadkea-c941012d8e8359198d1a26f51af78f83c1f5fa95.tar.xz
kea-c941012d8e8359198d1a26f51af78f83c1f5fa95.zip
[4277] Added PostgreSQL HR Managment section to developer's guide
src/lib/dhcprsrv/images/pgsql_host_data_source.svg - New class diagram for PgSqlHostDataSource doc/Doxyfile - Added src/lib/dhcprsrv/images to IMAGE_PATH src/lib/dhcpsrv/Makefile.am - Added images/pgsql_host_data_source.svg to EXTRA_DIST src/lib/dhcpsrv/libdhcpsrv.dox - Added subsection postgreSQLHostMgr src/lib/dhcpsrv/pgsql_connection.h src/lib/dhcpsrv/pgsql_exchange.h - Minor cleanup
Diffstat (limited to 'src/lib/dhcpsrv/libdhcpsrv.dox')
-rw-r--r--src/lib/dhcpsrv/libdhcpsrv.dox9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/lib/dhcpsrv/libdhcpsrv.dox b/src/lib/dhcpsrv/libdhcpsrv.dox
index e757c051f2..20defeb4d7 100644
--- a/src/lib/dhcpsrv/libdhcpsrv.dox
+++ b/src/lib/dhcpsrv/libdhcpsrv.dox
@@ -110,6 +110,15 @@ data source (if present) and concatenate results.
For more information about the \ref isc::dhcp::HostMgr please refer to its
documentation.
+@subsection postgreSQLHostMgr PostgreSQL Host Reservation Management
+
+Storing and retrieving host reservations within a PostgreSQL schema is
+provided by the class, \ref isc::dhcp::PgSqlHostDataSource, a derivation of
+\ref isc::dhcp::BaseHostDataSource and is depicted in the following
+class diagram:
+
+@image html pgsql_host_data_source.svg "PgSqlHostDataSource Class Diagram"
+
@section optionsConfig Options Configuration Information
The \ref isc::dhcp::CfgOption object holds a collection of options being