2
0
mirror of https://gitlab.isc.org/isc-projects/kea synced 2025-08-31 05:55:28 +00:00

[4108] added doc for the new method, adjusted it for run() accordingly.

This commit is contained in:
JINMEI Tatuya
2015-11-01 10:53:18 +09:00
committed by Tomek Mrugalski
parent 6aa7bd8c31
commit 23e4df812a

View File

@@ -208,15 +208,21 @@ public:
/// @brief Main server processing loop. /// @brief Main server processing loop.
/// ///
/// Main server processing loop. Receives incoming packets, verifies /// Main server processing loop. Receives incoming packets, and calls
/// their correctness, generates appropriate answer (if needed) and /// processPakcet for each of them.
/// transmits responses.
/// ///
/// @return true, if being shut down gracefully, fail if experienced /// @return true, if being shut down gracefully, fail if experienced
/// critical error. /// critical error.
bool run(); bool run();
void processPacket(Pkt4Ptr& packet); /// @brief Process a single incoming DHCPv4 packet.
///
/// It verifies correctness of the passed packet, call per-type processXXX
/// methods, generates appropriate answer (if needed) and (if necessary)
/// transmits a response.
///
/// @param query A pointer to the packet to be processed.
void processPacket(Pkt4Ptr& query);
/// @brief Instructs the server to shut down. /// @brief Instructs the server to shut down.
void shutdown(); void shutdown();