Header update: 2007 -> 2008

[user/henk/code/inspircd.git] / include / connection.h

diff --git a/include/connection.h b/include/connection.h
index 6f918204d1c69c56f15b91f9e9f6f39fe1e14909..f24fc303d18c7925602d656f9e836a880258ea16 100644 (file)
--- a/include/connection.h
+++ b/include/connection.h
@@ -2,12 +2,9 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *               <Craig@chatspike.net>
- *     
- * Written by Craig Edwards, Craig McLure, and others.
+ *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
+ *
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
  *
@@ -20,17 +17,16 @@
 #include <time.h>
 #include "inspircd_config.h"
 #include "base.h"
+#include "socketengine.h"
 
-/** Please note: classes serverrec and userrec both inherit from class connection.
+/** connection is the base class of User, and holds basic user properties.
+ * This can be extended for holding other user-like objects in the future.
  */
-class connection : public Extensible
+class CoreExport connection : public EventHandler
 {
  public:
-       /** File descriptor of the connection
-        */
-       int fd;
-       
-       /** Hostname of connection. Not used if this is a serverrec
+       /** Hostname of connection.
+        * This should be valid as per RFC1035.
         */
        char host[65];
 
@@ -50,17 +46,13 @@ class connection : public Extensible
         */
        int cmds_out;
 
-       /** True if server/user has authenticated, false if otherwise
+       /** True if user has authenticated, false if otherwise
         */
        bool haspassed;
 
-       /** Port number
-        * For a userrec, this is the port they connected to the network on.
-        * For a serverrec this is the current listening port of the serverrec object.
-        */
-       int port;
-       
-       /** Used by userrec to indicate the registration status of the connection
+       /** Used by User to indicate the registration status of the connection
+        * It is a bitfield of the REG_NICK, REG_USER and REG_ALL bits to indicate
+        * the connection state.
         */
        char registered;
        
@@ -68,24 +60,19 @@ class connection : public Extensible
         */
        time_t lastping;
        
-       /** Time the connection was created, set in the constructor
+       /** Time the connection was created, set in the constructor. This
+        * may be different from the time the user's classbase object was
+        * created.
         */
        time_t signon;
        
-       /** Time that the connection last sent data, used to calculate idle time
+       /** Time that the connection last sent a message, used to calculate idle time
         */
        time_t idle_lastmsg;
        
-       /** Used by PING checks with clients
+       /** Used by PING checking code
         */
        time_t nping;
-       
-       /** Default constructor
-        */
-       connection()
-       {
-               this->fd = -1;
-       }
 };