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