include/commands/cmd_squit.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2007 ChatSpike-Dev.
   6  *                     E-mail:
   7  *              <brain@chatspike.net>
   8  *              <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *          the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 #ifndef __CMD_SQUIT_H__
  18 #define __CMD_SQUIT_H__
  19
  20 // include the common header files
  21
  22 #include <string>
  23 #include <vector>
  24 #include "inspircd.h"
  25 #include "users.h"
  26 #include "channels.h"
  27
  28 /** Handle /SQUIT. These command handlers can be reloaded by the core,
  29  * and handle basic RFC1459 commands. Commands within modules work
  30  * the same way, however, they can be fully unloaded, where these
  31  * may not.
  32  */
  33 class cmd_squit : public command_t
  34 {
  35  public:
  36         /** Constructor for squit.
  37          */
  38         cmd_squit (InspIRCd* Instance) : command_t(Instance,"SQUIT",'o',1) { syntax = "<servername> [<reason>]"; }
  39         /** Handle command.
  40          * @param parameters The parameters to the comamnd
  41          * @param pcnt The number of parameters passed to teh command
  42          * @param user The user issuing the command
  43          * @return A value from CmdResult to indicate command success or failure.
  44          */
  45         CmdResult Handle(const char** parameters, int pcnt, userrec *user);
  46 };
  47
  48 #endif