Author: Kev <klmitch@mit.edu>

[ircu2.10.12-pk.git] / include / s_auth.h

diff --git a/include/s_auth.h b/include/s_auth.h
index 0b03355e93d13d82f978c5a3ec631e4028e917c6..2925339e0079bfe679e9db8d960595a8dcfcd2a3 100644 (file)
--- a/include/s_auth.h
+++ b/include/s_auth.h
@@ -14,8 +14,10 @@
  *   You should have received a copy of the GNU General Public License
  *   along with this program; if not, write to the Free Software
  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- *   $Id$
+ */
+/** @file
+ * @brief Interface for DNS and ident lookups.
+ * @version $Id$
  */
 #ifndef INCLUDED_s_auth_h
 #define INCLUDED_s_auth_h
@@ -23,26 +25,36 @@
 #include <sys/types.h>
 #define INCLUDED_sys_types_h
 #endif
+#ifndef INCLUDED_ircd_events_h
+#include "ircd_events.h"
+#endif
 
 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 */
-  int                 index;     /* select / poll index */
-  time_t              timeout;   /* time when query expires */
+  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 */
+
+/** 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)
 #define ClearDNSPending(x)   ((x)->flags &= ~AM_DNS_PENDING)
@@ -59,14 +71,10 @@ struct AuthRequest {
 #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 timeout_auth_queries(time_t now);
 extern void read_auth_reply(struct AuthRequest* req);
 extern void send_auth_query(struct AuthRequest* req);
-extern void remove_auth_request(struct AuthRequest *req);
+extern void destroy_auth_request(struct AuthRequest *req, int send_reports);
 
 #endif /* INCLUDED_s_auth_h */