Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
Sebastian Schrader
Kea
Commits
d141c47a
Commit
d141c47a
authored
Nov 06, 2012
by
Stephen Morris
Browse files
[2342] Add programmer documentation
Also add missing library into the makefile - this showed its absence on OS/X.
parent
3dc78f0e
Changes
3
Hide whitespace changes
Inline
Side-by-side
doc/devel/mainpage.dox
View file @
d141c47a
...
...
@@ -29,6 +29,7 @@
* - @subpage libdhcp
* - @subpage libdhcpIntro
* - @subpage libdhcpIfaceMgr
* - @subpage dhcp-database-backends
* - @subpage perfdhcpInternals
*
* @section misc Miscellaneous topics
...
...
src/lib/dhcp/Makefile.am
View file @
d141c47a
...
...
@@ -52,14 +52,15 @@ libb10_dhcpsrv_la_SOURCES += triplet.h
libb10_dhcpsrv_la_CXXFLAGS
=
$(AM_CXXFLAGS)
libb10_dhcpsrv_la_CPPFLAGS
=
$(AM_CPPFLAGS)
$(LOG4CPLUS_INCLUDES)
libb10_dhcpsrv_la_LIBADD
=
$(top_builddir)
/src/lib/asiolink/libb10-asiolink.la
libb10_dhcpsrv_la_LIBADD
=
$(top_builddir)
/src/lib/dhcp/libb10-dhcp++.la
libb10_dhcpsrv_la_LIBADD
+=
$(top_builddir)
/src/lib/asiolink/libb10-asiolink.la
libb10_dhcpsrv_la_LIBADD
+=
$(top_builddir)
/src/lib/util/libb10-util.la
libb10_dhcpsrv_la_LDFLAGS
=
-no-undefined
-version-info
2:0:0
if
HAVE_MYSQL
libb10_dhcpsrv_la_LDFLAGS
+=
$(MYSQL_LIBS)
endif
EXTRA_DIST
=
README
EXTRA_DIST
=
README
database_backends.dox
if
USE_CLANGPP
# Disable unused parameter warning caused by some of the
...
...
src/lib/dhcp/database_backends.dox
0 → 100644
View file @
d141c47a
/**
@page dhcp-database-backends DHCP Database Back-Ends
All DHCP lease data is stored in some form of database, the interface
to this being through the Lease Manager.
All backend classes such as isc::dhcp::MySqlLeaseMgr are derived from
the abstract isc::dhcp::LeaseMgr class. This provides methods to
create, retrieve, modify and delete leases in the database.
@section dhcpdb-instantiation Instantiation of Lease Managers
A lease manager is instantiated through a the LeaseMgrFactory class. This
has three methods:
- isc::dhcp::LeaseMgrFactory::create - Creates a singleton Lease
Manager of the appropriate type.
- isc::dhcp::LeaseMgrFactory::instance - Returns a reference to the
the instance of the Lease Manager.
- isc::dhcp::LeaseMgrFactory::destroy - Destroys the singleton lease manager.
The selection of the Lease Manager (and thus the backend database) is
is controlled by the argument passed to isc::dhcp::LeaseMgrfactory::create.
This is a string containing a set of "keyword=value" pairs (no embedded
spaces), each pair separated by a space from the others, e.g.
\code
type=mysql user=keatest password=keatest name=keatest host=localhost
\endcode
The following keywords are used for all backends:
- type - specifies the type of database backend. The following types are
supported:
- mysql - Use MySQL as the database
The following keywords apply to the MySQL backend:
- host - host on which the selected database is running. If not supplied,
"localhost" is assumed.
- name - name of the MySQL database to access. There is no default - this
must be supplied.
- password - password for the selected user ID (see below). If not specified,
no password is used.
- user - database user ID under which the database is accessed. If not
specified, no user ID is used - the database is assumed to be open.
*/
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment