mainpage.dox 4.88 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://oldkea.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://oldkea.isc.org/">Kea webpage (http://oldkea.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
 * @section buildingKeaWithUnitTests Building Kea with Unit tests
 * - @subpage unitTests
 *   - @subpage unitTestsIntroduction
 *   - @subpage unitTestsEnvironmentVariables
 *   - @subpage unitTestsDatabaseConfig
Tomek Mrugalski's avatar
Tomek Mrugalski committed
44
 *   - @subpage unitTestsSysrepo
45
 *
46 47 48
 * @section performance Performance
 * - @subpage benchmarks
 *
49
 * @section hooksFramework Hooks Framework
50
 * - @subpage hooksdgDevelopersGuide
51 52
 * - @subpage dhcpv4Hooks
 * - @subpage dhcpv6Hooks
53
 * - @subpage agentHooks
54
 * - @subpage hooksComponentDeveloperGuide
55
 * - @subpage hooksmgMaintenanceGuide
56
 * - @subpage libdhcp_ha
57
 * - @subpage libdhcp_user_chk
58
 * - @subpage libdhcp_lease_cmds
59
 * - @subpage libdhcp_stat_cmds
60
 *
61
 * @section dhcpMaintenanceGuide DHCP Maintenance Guide
62
 * - @subpage dhcp4
63 64
 *   - @subpage dhcpv4ConfigParser
 *   - @subpage dhcpv4ConfigInherit
65
 *   - @subpage dhcpv4OptionsParse
66
 *   - @subpage dhcpv4DDNSIntegration
67
 *   - @subpage dhcpv4Classifier
68
 *   - @subpage dhcpv4ConfigBackend
69
 *   - @subpage dhcpv4SignalBasedReconfiguration
70
 *   - @subpage dhcpv4Other
71
 *   - @subpage dhcpv4o6Dhcp4
72
 * - @subpage dhcp6
73 74
 *   - @subpage dhcpv6ConfigParser
 *   - @subpage dhcpv6ConfigInherit
75
 *   - @subpage dhcpv6DDNSIntegration
76
 *   - @subpage dhcpv6OptionsParse
77
 *   - @subpage dhcpv6Classifier
78
 *   - @subpage dhcpv6ConfigBackend
79
 *   - @subpage dhcpv6SignalBasedReconfiguration
80
 *   - @subpage dhcpv6Other
81
 *   - @subpage dhcpv4o6Dhcp6
82
 * - @subpage d2
Jeremy C. Reed's avatar
Jeremy C. Reed committed
83
 *   - @subpage d2ProcessDerivation
84 85 86 87 88 89 90
 *   - @subpage d2ConfigMgt
 *   - @subpage d2NCRReceipt
 *   - @subpage d2DDNSUpdateExecution
 *   - @subpage d2EventLoop
 *   - @subpage d2TransDetail
 *   - @subpage d2StateModel
 *   - @subpage d2TransExecExample
91 92 93 94 95
 * - @subpage controlAgent
 *   - @subpage ctrlAgentHttp
 *   - @subpage ctrlAgentCreatingResponse
 *   - @subpage ctrlAgentCommandMgr
 *   - @subpage CtrlAgentSecurity
96 97 98
 * - @subpage lfc
 *   - @subpage lfcProcessing
 *   - @subpage lfcFiles
99 100 101 102 103
 * - @subpage ctrlSocket
 *   - @subpage ctrlSocketOverview
 *   - @subpage ctrlSocketClient
 *   - @subpage ctrlSocketImpl
 *   - @subpage ctrlSocketConnections
104 105 106 107 108 109 110
 * - @subpage dhcpDatabaseBackends
 * - @subpage configBackend
 *   - @subpage configBackendJSONDesign
 * - @subpage perfdhcpInternals
 *
 * @section libraries Kea libraries
 * - @subpage libcc
111
 * - @subpage libdhcp
112
 *   - @subpage libdhcpIntro
113
 *   - @subpage libdhcpRelay
114
 *   - @subpage libdhcpIfaceMgr
115
 *   - @subpage libdhcpPktFilter
116
 *   - @subpage libdhcpPktFilter6
117
 *   - @subpage libdhcpErrorLogging
118
 * - @subpage libdhcp_ddns
119 120 121
 * - @subpage libdhcpsrv
 *   - @subpage leasemgr
 *   - @subpage cfgmgr
122
 *   - @subpage hostmgr
123
 *   - @subpage optionsConfig
124
 *   - @subpage allocengine
125 126
 *   - @subpage timerManager
 *   - @subpage leaseReclamationRoutine
127 128
 *   - @subpage subnetSelect
 *   - @subpage dhcp4o6Ipc
129 130 131 132
 * - @subpage libeval
 * - @subpage libprocess
 *   - @subpage cpl
 *   - @subpage cplSignals
133
 * - @subpage libyang
134
 *
135
 * @section miscellaneousTopics Miscellaneous Topics
Tomek Mrugalski's avatar
Tomek Mrugalski committed
136
 * - @subpage terminology
Tomek Mrugalski's avatar
Tomek Mrugalski committed
137
 * - @subpage parser
138
 * - @subpage logKeaLogging
139 140 141
 *   - @subpage logBasicIdeas
 *   - @subpage logDeveloperUse
 *   - @subpage logNotes
142
 * - @subpage LoggingApi
143
 * - @subpage SocketSessionUtility
144
 * - @subpage docs
145 146
 * - <a href="./doxygen-error.log">Documentation warnings and errors</a>
 *
147
 */