From: Arran Cudbard-Bell <a.cudbardb@freeradius.org>
Date: Wed, 20 Feb 2013 19:43:25 +0000 (-0500)
Subject: More docs, rename struct from auth_req to request
X-Git-Tag: release_3_0_0_beta1~977
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=34191152980aaccf6281e1ab081434367d8f6f79;p=thirdparty%2Ffreeradius-server.git

More docs, rename struct from auth_req to request
---

diff --git a/src/include/radiusd.h b/src/include/radiusd.h
index eea6c49d8f0..70a134879ef 100644
--- a/src/include/radiusd.h
+++ b/src/include/radiusd.h
@@ -34,7 +34,7 @@ RCSIDH(radiusd_h, "$Id$")
 #include <freeradius-devel/event.h>
 #include <freeradius-devel/connection.h>
 
-typedef struct auth_req REQUEST;
+typedef struct request REQUEST;
 
 #ifdef HAVE_PTHREAD_H
 #include	<pthread.h>
@@ -165,7 +165,7 @@ typedef		int (*RAD_REQUEST_FUNP)(REQUEST *);
 #define REQUEST_DATA_REGEX (0xadbeef00)
 #define REQUEST_MAX_REGEX (8)
 
-struct auth_req {
+struct request {
 #ifndef NDEBUG
 	uint32_t		magic; 		//!< Magic number used to 
 						//!< detect memory corruption,
@@ -268,10 +268,15 @@ struct auth_req {
 
 	const char		*server;
 	REQUEST			*parent;
-	radlog_func_t		radlog;	/* logging function, if set */
+	radlog_func_t		radlog;		//!< Function to call to output 
+						//!< log messages about this
+						//!< request.
 #ifdef WITH_COA
-	REQUEST			*coa;
-	int			num_coa_requests;
+	REQUEST			*coa;		//!< CoA request originated
+						//!< by this request.
+	int			num_coa_requests;//!< Counter for number of
+						//!< requests sent including
+						//!< retransmits.
 #endif
 };				/* REQUEST typedef */