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