mainpage.dox 4.78 KB
Newer Older
1
// Copyright (C) 2012-2018 Internet Systems Consortium, Inc. ("ISC")
2
//
3 4 5
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6

7
/**
8
 * @mainpage Kea Developer's Guide
9
 *
10
 * Welcome to the Kea Developer's Guide. This documentation is addressed at
11
 * either existing or prospective Kea developers and contributors, and
12
 * provides information needed to extend and maintain Kea source code.
13

14
 * If you wish to write hook code - the code that is loaded by Kea at
15
 * run-time and modifies its behavior,  you should read the section
16
 * @ref hooksdgDevelopersGuide.
17
 *
18 19 20
 * Kea maintenance information is divided into a number of sections.
 * Information on DHCP-specific topics can be found
 * in the @ref dhcpMaintenanceGuide.  General topics are discussed in
21
 * @ref miscellaneousTopics.
22 23
 *
 * If you are a user or system administrator, rather than software engineer,
24
 * you should read the
25
 * <a href="http://kea.isc.org/docs/kea-guide.html">Kea
26
 * Administrator Reference Manual</a> instead. If you are using a beta or
27 28 29
 * development version of Kea, the
 * <a href="http://git.kea.isc.org/~tester/kea/guide/kea-guide.html">
 * development version of the manual</a> is recommended.
30
 *
31
 * Regardless of your field of expertise, you are encouraged to visit the
32
 * <a href="http://kea.isc.org/">Kea webpage (http://kea.isc.org)</a>
33
 *
34
 * @section contrib Contributor's Guide
35 36 37
 * - @subpage contributorGuide - This page describes the process of sending
 * a patch to ISC and what happens next. Please read it if you are considering
 * sending us any code.
38
 *
39 40 41 42 43 44
 * @section buildingKeaWithUnitTests Building Kea with Unit tests
 * - @subpage unitTests
 *   - @subpage unitTestsIntroduction
 *   - @subpage unitTestsEnvironmentVariables
 *   - @subpage unitTestsDatabaseConfig
 *
45 46 47
 * @section performance Performance
 * - @subpage benchmarks
 *
48
 * @section hooksFramework Hooks Framework
49
 * - @subpage hooksdgDevelopersGuide
50 51
 * - @subpage dhcpv4Hooks
 * - @subpage dhcpv6Hooks
52
 * - @subpage agentHooks
53
 * - @subpage hooksComponentDeveloperGuide
54
 * - @subpage hooksmgMaintenanceGuide
55
 * - @subpage libdhcp_user_chk
56
 * - @subpage libdhcp_lease_cmds
57
 * - @subpage libdhcp_stat_cmds
58
 *
59
 * @section dhcpMaintenanceGuide DHCP Maintenance Guide
60
 * - @subpage dhcp4
61 62
 *   - @subpage dhcpv4ConfigParser
 *   - @subpage dhcpv4ConfigInherit
63
 *   - @subpage dhcpv4OptionsParse
64
 *   - @subpage dhcpv4DDNSIntegration
65
 *   - @subpage dhcpv4Classifier
66
 *   - @subpage dhcpv4ConfigBackend
67
 *   - @subpage dhcpv4SignalBasedReconfiguration
68
 *   - @subpage dhcpv4Other
69
 *   - @subpage dhcpv4o6Dhcp4
70
 * - @subpage dhcp6
71 72
 *   - @subpage dhcpv6ConfigParser
 *   - @subpage dhcpv6ConfigInherit
73
 *   - @subpage dhcpv6DDNSIntegration
74
 *   - @subpage dhcpv6OptionsParse
75
 *   - @subpage dhcpv6Classifier
76
 *   - @subpage dhcpv6ConfigBackend
77
 *   - @subpage dhcpv6SignalBasedReconfiguration
78
 *   - @subpage dhcpv6Other
79
 *   - @subpage dhcpv4o6Dhcp6
80
 * - @subpage d2
Jeremy C. Reed's avatar
Jeremy C. Reed committed
81
 *   - @subpage d2ProcessDerivation
82 83 84 85 86 87 88
 *   - @subpage d2ConfigMgt
 *   - @subpage d2NCRReceipt
 *   - @subpage d2DDNSUpdateExecution
 *   - @subpage d2EventLoop
 *   - @subpage d2TransDetail
 *   - @subpage d2StateModel
 *   - @subpage d2TransExecExample
89 90 91 92 93
 * - @subpage controlAgent
 *   - @subpage ctrlAgentHttp
 *   - @subpage ctrlAgentCreatingResponse
 *   - @subpage ctrlAgentCommandMgr
 *   - @subpage CtrlAgentSecurity
94 95 96
 * - @subpage lfc
 *   - @subpage lfcProcessing
 *   - @subpage lfcFiles
97 98 99 100 101
 * - @subpage ctrlSocket
 *   - @subpage ctrlSocketOverview
 *   - @subpage ctrlSocketClient
 *   - @subpage ctrlSocketImpl
 *   - @subpage ctrlSocketConnections
102 103 104 105 106 107 108
 * - @subpage dhcpDatabaseBackends
 * - @subpage configBackend
 *   - @subpage configBackendJSONDesign
 * - @subpage perfdhcpInternals
 *
 * @section libraries Kea libraries
 * - @subpage libcc
109
 * - @subpage libdhcp
110
 *   - @subpage libdhcpIntro
111
 *   - @subpage libdhcpRelay
112
 *   - @subpage libdhcpIfaceMgr
113
 *   - @subpage libdhcpPktFilter
114
 *   - @subpage libdhcpPktFilter6
115
 *   - @subpage libdhcpErrorLogging
116
 * - @subpage libdhcp_ddns
117 118 119
 * - @subpage libdhcpsrv
 *   - @subpage leasemgr
 *   - @subpage cfgmgr
120
 *   - @subpage hostmgr
121
 *   - @subpage optionsConfig
122
 *   - @subpage allocengine
123 124
 *   - @subpage timerManager
 *   - @subpage leaseReclamationRoutine
125 126
 *   - @subpage subnetSelect
 *   - @subpage dhcp4o6Ipc
127 128 129 130
 * - @subpage libeval
 * - @subpage libprocess
 *   - @subpage cpl
 *   - @subpage cplSignals
131
 *
132
 * @section miscellaneousTopics Miscellaneous Topics
Tomek Mrugalski's avatar
Tomek Mrugalski committed
133
 * - @subpage terminology
Tomek Mrugalski's avatar
Tomek Mrugalski committed
134
 * - @subpage parser
135
 * - @subpage logKeaLogging
136 137 138
 *   - @subpage logBasicIdeas
 *   - @subpage logDeveloperUse
 *   - @subpage logNotes
139
 * - @subpage LoggingApi
140 141 142
 * - @subpage SocketSessionUtility
 * - <a href="./doxygen-error.log">Documentation warnings and errors</a>
 *
143
 */