Committer : entrope
CVSROOT : /cvsroot/undernet-ircu
Module : ircu2.10
Commit time: 2004-09-21 15:23:03 UTC
Modified files:
include/s_auth.h
Log message:
Doxyfile s_auth.h.
---------------------- diff included ----------------------
Index: ircu2.10/include/s_auth.h
diff -u ircu2.10/include/s_auth.h:1.4 ircu2.10/include/s_auth.h:1.5
--- ircu2.10/include/s_auth.h:1.4 Wed Jun 6 17:29:47 2001
+++ ircu2.10/include/s_auth.h Tue Sep 21 08:22:53 2004
@@ -15,7 +15,7 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
- * $Id: s_auth.h,v 1.4 2001/06/07 00:29:47 kev Exp $
+ * $Id: s_auth.h,v 1.5 2004/09/21 15:22:53 entrope Exp $
*/
#ifndef INCLUDED_s_auth_h
#define INCLUDED_s_auth_h
@@ -29,27 +29,29 @@
struct Client;
+/** Stores state of the DNS and RFC 1413 ident lookups for a client. */
struct AuthRequest {
- struct AuthRequest* next; /* linked list node ptr */
- struct AuthRequest* prev; /* linked list node ptr */
- struct Client* client; /* pointer to client struct for request */
- unsigned int flags; /* current state of request */
- int fd; /* file descriptor for auth queries */
- struct Socket socket; /* socket descriptor for auth queries */
- struct Timer timeout; /* timeout timer for auth queries */
+ struct AuthRequest* next; /**< linked list node ptr */
+ struct AuthRequest* prev; /**< linked list node ptr */
+ struct Client* client; /**< pointer to client struct for request */
+ unsigned int flags; /**< current state of request */
+ int fd; /**< file descriptor for auth queries */
+ struct Socket socket; /**< socket descriptor for auth queries */
+ struct Timer timeout; /**< timeout timer for auth queries */
};
/*
* flag values for AuthRequest
* NAMESPACE: AM_xxx - Authentication Module
*/
-#define AM_AUTH_CONNECTING 0x01
-#define AM_AUTH_PENDING 0x02
-#define AM_DNS_PENDING 0x04
+#define AM_AUTH_CONNECTING 0x01 /**< waiting for ident connect to complete */
+#define AM_AUTH_PENDING 0x02 /**< ident connected, waiting for response */
+#define AM_DNS_PENDING 0x04 /**< dns request sent, waiting for response */
-#define AM_SOCKET 0x40 /* socket structure not destroyed */
-#define AM_TIMEOUT 0x80 /* timer structure not destroyed */
+#define AM_SOCKET 0x40 /**< socket structure not destroyed */
+#define AM_TIMEOUT 0x80 /**< timer structure not destroyed */
+/** If any of AM_FREE_MASK bits are set, operations are still in progress. */
#define AM_FREE_MASK (AM_SOCKET | AM_TIMEOUT)
#define SetDNSPending(x) ((x)->flags |= AM_DNS_PENDING)
@@ -67,9 +69,6 @@
#define ClearAuth(x) ((x)->flags &= ~(AM_AUTH_PENDING | AM_AUTH_CONNECTING))
#define IsDoingAuth(x) ((x)->flags & (AM_AUTH_PENDING | AM_AUTH_CONNECTING))
-
-extern struct AuthRequest* AuthPollList; /* GLOBAL - auth queries pending io */
-
extern void start_auth(struct Client *);
extern void read_auth_reply(struct AuthRequest* req);
extern void send_auth_query(struct AuthRequest* req);
----------------------- End of diff -----------------------
