Modified documentation for base classes

Added base classes


git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@151 e03df62e-2008-0410-955e-edbf42e46eb7

1 files changed, 8 insertions, 84 deletions

diff --git a/include/users.h b/include/users.h
index dddda8dd6..b1b21ae0b 100644
--- a/include/users.h
+++ b/include/users.h
@@ -1,8 +1,12 @@
 /*
 
 $Log$
-Revision 1.1  2003/01/23 19:45:58  brain
-Initial revision
+Revision 1.2  2003/01/26 23:52:59  brain
+Modified documentation for base classes
+Added base classes
+
+Revision 1.1.1.1  2003/01/23 19:45:58  brain
+InspIRCd second source tree
 
 Revision 1.9  2003/01/22 00:44:26  brain
 Added documentation comments
@@ -31,6 +35,7 @@ added /ISON command (for mIRC etc basic notify)
 
 #include "inspircd_config.h" 
 #include "channels.h"
+#include "connection.h"
 
 #include <string>
  
@@ -80,7 +85,7 @@ typedef vector<ConnectClass> ClassVector;
  * user's nickname and hostname. Use the Find method of the server class to locate a specific user
  * by nickname.
  */
-class userrec
+class userrec : public connection
 {
  private:
 
@@ -95,18 +100,10 @@ class userrec
 	
 	char nick[NICKMAX];
 	
-	/** The users ip address in network order.
-	 */
-	unsigned long ip;
-
 	/** The users ident reply.
 	 */
 	char ident[64];
 
-	/** The users hostname, or ip address in string form.
-	 */
-	char host[256];
-	
 	/** The host displayed to non-opers (used for cloaking etc).
 	 * This usually matches the value of userrec::host.
 	 */
@@ -116,55 +113,12 @@ class userrec
 	 */
 	char fullname[128];
 	
-	/** The users file descriptor.
-	 * If this is zero, the socket has been closed and the core has not yet
-	 * realised and removed the record from memory.
-	 */
-	int fd;
-	
 	/** The user's mode string.
 	 * This may contain any of the following RFC characters: o, w, s, i
 	 * Your module may define other mode characters as it sees fit.
 	 */
 	char modes[32];
 	
-	/** The users input buffer.
-	 * Used by the C recv() function.
-	 */
-	char inbuf[MAXBUF];
-	
-	/** The last time the user was pinged by the core.
-	 * When this value is more than 120 seconds difference from 'time(NULL)', a ping is sent
-	 * to the client. If the user has an outstanding PING request the next time this
-	 * event occurs after 4 total minutes, they are disconnected.
-	 */
-	time_t lastping;
-	
-	/** The users signon time.
-	 */
-	time_t signon;
-	
-	/** The time the user last sent a message.
-	 * See also userrec::lastping and userrec::signon
-	 */
-	time_t idle_lastmsg;
-	
-	/** True if the user replied to their last ping.
-	 * If this is true, the user can be sent another ping at the specified time, otherwise
-	 * they will be discnnected. See also userrec::lastping
-	 */
-	time_t nping;
-	
-	/** Bit 1 is set if the user sent a NICK command, bit 2 is set if the user sent a USER command.
-	 * If both bits are set then the connection is awaiting MOTD. Sending of MOTD sets bit 3, and
-	 * makes the value of userrec::registered == 7, showing a fully established client session.
-	 */
-	int registered;
-	
-	/** A list of the channels the user is currently on.
-	 * If any of these values are NULL, the record is not in use and may be associated with
-	 * a channel by the JOIN command. see RFC 1459.
-	 */
 	ucrec chans[MAXCHANS];
 	
 	/** The server the user is connected to.
@@ -176,41 +130,11 @@ class userrec
 	 */
 	char awaymsg[512];
 	
-	/** The port that the user connected to.
-	 */
-	int port;
-	
-	/** Stores the number of incoming bytes from the connection.
-	 * Used by /STATS
-	 */
-	long bytes_in;
-	
-	/** Stores the number of outgoing bytes to the connection.
-	 * Used by /STATS
-	 */
-	long bytes_out;
-	
-	/** Stores the number of incoming commands from the connection.
-	 * Used by /STATS
-	 */
-	long cmds_in;
-	
-	/** Stores the number of outgoing commands to the connection.
-	 * Used by /STATS
-	 */
-	long cmds_out;
-	
 	/** Stores the result of the last GetFullHost or GetRealHost call.
 	 * You may use this to increase the speed of use of this class.
 	 */
 	char result[256];
 	
-	/** True if a correct password has been given using PASS command.
-	 * If the user is a member of a connection class that does not require a password,
-	 * the value stored here is of no use.
-	 */
-	bool haspassed;
-
 	userrec();
 	
 	virtual ~userrec() {  }