02-dhcp.dox 1.4 KB

1234567891011121314151617181920212223242526272829303132
  1. /**
  2. * @page dhcpv4 DHCPv4 Component
  3. *
  4. * BIND10 offers DHCPv4 server implementation. It is implemented as b10-dhcp4 component.
  5. * It's primary code is located in isc::dhcp::Dhcpv4Srv class. It uses \ref libdhcp extensively,
  6. * especially isc::dhcp::Pkt4, isc::dhcp::Option and isc::dhcp::IfaceMgr classes.
  7. *
  8. * @todo Describe DHCPv4 component properly.
  9. *
  10. * @page dhcpv6 DHCPv6 Component
  11. *
  12. * @todo DHCPv6 component will be described here.
  13. *
  14. * @page libdhcp libdhcp++ library
  15. *
  16. * @section libdhcpIntro Libdhcp++ Introduction
  17. *
  18. * libdhcp++ is an all-purpose DHCP-manipulation library, written in C++. It offers packet
  19. * parsing and assembly, DHCPv4 and DHCPv6 options parsing and assembly, interface detection
  20. * (currently on Linux systems only) and socket operations. Following classes are implemented:
  21. *
  22. * - isc::dhcp::Pkt4 - represents DHCPv4 packet.
  23. * - isc::dhcp::Pkt6 - represents DHCPv6 packet.
  24. *
  25. * @section lidhcpIfaceMgr Interface Manager
  26. *
  27. * Interface Manager (or IfaceMgr) is an abstraction layer about low-level network operations.
  28. * In particlar, it provides information about existing network interfaces See isc::dhcp::IfaceMgr::Iface
  29. * class and isc::dhcp::IfaceMgr::detectIfaces() and isc::dhcp::IfaceMgr::getIface().
  30. * Another useful methods are dedicated to transmission (isc::dhcp::IfaceMgr::send(), 2 overloads)
  31. * and reception (isc::dhcp::IfaceMgr::receive4() and isc::dhcp::IfaceMgr::receive6()).
  32. */