Header update: 2007 -> 2008

[user/henk/code/inspircd.git] / include / commands / cmd_whowas.h

diff --git a/include/commands/cmd_whowas.h b/include/commands/cmd_whowas.h
index 8b31c3e7af61233b37d596cd035ce66452a6e6ec..51ec38b179eea92687403bb2c53e51220045dbd0 100644 (file)
--- a/include/commands/cmd_whowas.h
+++ b/include/commands/cmd_whowas.h
@@ -2,14 +2,11 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd is copyright (C) 2002-2007 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *                <Craig@chatspike.net>
+ *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
  *
- * Written by Craig Edwards, Craig McLure, and others.
  * This program is free but copyrighted software; see
- *            the file COPYING for details.
+ *      the file COPYING for details.
  *
  * ---------------------------------------------------
  */
@@ -38,7 +35,7 @@ class WhoWasMaintainTimer;
 /* Forward ref for typedefs */
 class WhoWasGroup;
 
-/** InspTimer that is used to maintain the whowas list, called once an hour
+/** Timer that is used to maintain the whowas list, called once an hour
  */
 extern WhoWasMaintainTimer* timer;
 
@@ -54,9 +51,12 @@ typedef std::map<irc::string,whowas_set*> whowas_users;
  */
 typedef std::deque<std::pair<time_t,irc::string> > whowas_users_fifo;
 
-/** Handle /WHOWAS
+/** Handle /WHOWAS. These command handlers can be reloaded by the core,
+ * and handle basic RFC1459 commands. Commands within modules work
+ * the same way, however, they can be fully unloaded, where these
+ * may not.
  */
-class cmd_whowas : public command_t
+class CommandWhowas : public Command
 {
   private:
        /** Whowas container, contains a map of vectors of users tracked by WHOWAS
@@ -67,15 +67,32 @@ class cmd_whowas : public command_t
         */
        whowas_users_fifo whowas_fifo;
 
+       /* String holding stats so it can be collected
+        */
+       std::string stats;
+
   public:
-       cmd_whowas(InspIRCd* Instance);
-       CmdResult Handle(const char** parameters, int pcnt, userrec *user);
+       CommandWhowas(InspIRCd* Instance);
+       /** Handle command.
+        * @param parameters The parameters to the comamnd
+        * @param pcnt The number of parameters passed to teh command
+        * @param user The user issuing the command
+        * @return A value from CmdResult to indicate command success or failure.
+        */
+       CmdResult Handle(const char** parameters, int pcnt, User *user);
+       /** Handle an internal request from another command, the core, or a module
+        * @param Command ID
+        * @param Zero or more parameters, whos form is specified by the command ID.
+        * @return Return CMD_SUCCESS on success, or CMD_FAILURE on failure.
+        * If the command succeeds but should remain local to this server,
+        * return CMD_LOCALONLY.
+        */
        CmdResult HandleInternal(const unsigned int id, const std::deque<classbase*> &parameters);
-       void AddToWhoWas(userrec* user);
+       void AddToWhoWas(User* user);
        void GetStats(Extensible* ext);
        void PruneWhoWas(time_t t);
        void MaintainWhoWas(time_t t);
-       virtual ~cmd_whowas();
+       virtual ~CommandWhowas();
 };
 
 /** Used to hold WHOWAS information
@@ -104,19 +121,19 @@ class WhoWasGroup : public classbase
 
        /** Initialize this WhoQasFroup with a user
         */
-       WhoWasGroup(userrec* user);
+       WhoWasGroup(User* user);
        /** Destructor
         */
        ~WhoWasGroup();
 };
 
-class WhoWasMaintainTimer : public InspTimer
+class WhoWasMaintainTimer : public Timer
 {
   private:
        InspIRCd* ServerInstance;
   public:
        WhoWasMaintainTimer(InspIRCd* Instance, long interval)
-       : InspTimer(interval, Instance->Time(), true), ServerInstance(Instance)
+       : Timer(interval, Instance->Time(), true), ServerInstance(Instance)
        {
        }
        virtual void Tick(time_t TIME);