Commit 1b9ab32f authored by Tomek Mrugalski's avatar Tomek Mrugalski 🛰
Browse files

[1531] Initial pages for Developer's Guide

parent 0dc861f4
/**
*
* @mainpage BIND10 Developer's Guide
*
* Welcome to BIND10 Developer's Guide. This documentation is addressed
* at existing and prospecting developers and programmers, who would like
* to gain insight into internal workings of BIND 10.
*
* If you are a user or system administrator, rather than software engineer,
* you should read BIND10 Guide instead.
*
* @section DNS
* - @subpage DataScrubbing
* @section DHCP
* - @subpage dhcpv4
* - @subpage dhcpv6
* - @subpage libdhcp
*
* @section Miscellaneous topics
* - @subpage LoggingApi
* - @subpage LoggingApiOverview
* - @subpage LoggingApiLoggerNames
* - @subpage LoggingApiLoggingMessages
* - @subpage SocketSessionUtility
*
* <a href="./doxygen-error.log">Documentation warnings and errors</a>
*/
\ No newline at end of file
/**
*
* @page dns BIND10 DNS
*
* @section dns-auth b10-auth
*
* @todo: Describe b10-auth here.
*
* @section b10-cfgmgr b10-cfgmgr Overview
*
* @todo: Descibe b10-cfgmgr here.
*
*
*/
/**
* @page dhcpv4 DHCPv4 Component
*
* BIND10 offers DHCPv4 server implementation. It is implemented as b10-dhcp4 component.
* It's primary code is located in isc::dhcp::Dhcpv4Srv class. It uses \ref libdhcp extensively,
* especially isc::dhcp::Pkt4, isc::dhcp::Option and isc::dhcp::IfaceMgr classes.
*
* @todo Describe DHCPv4 component properly.
*
* @page dhcpv6 DHCPv6 Component
*
* @todo DHCPv6 component will be described here.
*
* @page libdhcp libdhcp++ library
*
* @section libdhcpIntro Libdhcp++ Introduction
*
* libdhcp++ is an all-purpose DHCP-manipulation library, written in C++. It offers packet
* parsing and assembly, DHCPv4 and DHCPv6 options parsing and assembly, interface detection
* (currently on Linux systems only) and socket operations. Following classes are implemented:
*
* - isc::dhcp::Pkt4 - represents DHCPv4 packet.
* - isc::dhcp::Pkt6 - represents DHCPv6 packet.
*
* @section lidhcpIfaceMgr Interface Manager
*
* Interface Manager (or IfaceMgr) is an abstraction layer about low-level network operations.
* In particlar, it provides information about existing network interfaces See isc::dhcp::IfaceMgr::Iface
* class and isc::dhcp::IfaceMgr::detectIfaces() and isc::dhcp::IfaceMgr::getIface().
* Another useful methods are dedicated to transmission (isc::dhcp::IfaceMgr::send(), 2 overloads)
* and reception (isc::dhcp::IfaceMgr::receive4() and isc::dhcp::IfaceMgr::receive6()).
*/
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment