From 23e4df812a0af2fb8a2b6ebb2af0a3eb1e5a9009 Mon Sep 17 00:00:00 2001 From: JINMEI Tatuya Date: Sun, 1 Nov 2015 10:53:18 +0900 Subject: [PATCH] [4108] added doc for the new method, adjusted it for run() accordingly. --- src/bin/dhcp4/dhcp4_srv.h | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/src/bin/dhcp4/dhcp4_srv.h b/src/bin/dhcp4/dhcp4_srv.h index 3a5732f9c9..429ff7c133 100644 --- a/src/bin/dhcp4/dhcp4_srv.h +++ b/src/bin/dhcp4/dhcp4_srv.h @@ -208,15 +208,21 @@ public: /// @brief Main server processing loop. /// - /// Main server processing loop. Receives incoming packets, verifies - /// their correctness, generates appropriate answer (if needed) and - /// transmits responses. + /// Main server processing loop. Receives incoming packets, and calls + /// processPakcet for each of them. /// /// @return true, if being shut down gracefully, fail if experienced /// critical error. 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. void shutdown();