include/commands/cmd_rules.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *      the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 #ifndef __CMD_RULES_H__
  15 #define __CMD_RULES_H__
  16
  17 // include the common header files
  18
  19 #include <string>
  20 #include <vector>
  21 #include "inspircd.h"
  22 #include "users.h"
  23 #include "channels.h"
  24
  25 /** Handle /RULES. These command handlers can be reloaded by the core,
  26  * and handle basic RFC1459 commands. Commands within modules work
  27  * the same way, however, they can be fully unloaded, where these
  28  * may not.
  29  */
  30 class CommandRules : public Command
  31 {
  32  public:
  33         /** Constructor for rules.
  34          */
  35         CommandRules (InspIRCd* Instance) : Command(Instance,"RULES",0,0) { syntax = "[<servername>]"; }
  36         /** Handle command.
  37          * @param parameters The parameters to the comamnd
  38          * @param pcnt The number of parameters passed to teh command
  39          * @param user The user issuing the command
  40          * @return A value from CmdResult to indicate command success or failure.
  41          */
  42         CmdResult Handle(const std::vector<std::string>& parameters, User *user);
  43 };
  44
  45 #endif