include/commands/cmd_pong.h

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 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_PONG_H__
  15 #define __CMD_PONG_H__
  16
  17 // include the common header files
  18
  19 #include "inspircd.h"
  20 #include "users.h"
  21 #include "channels.h"
  22
  23 /** Handle /PONG. These command handlers can be reloaded by the core,
  24  * and handle basic RFC1459 commands. Commands within modules work
  25  * the same way, however, they can be fully unloaded, where these
  26  * may not.
  27  */
  28 class CommandPong : public Command
  29 {
  30  public:
  31         /** Constructor for pong.
  32          */
  33         CommandPong (InspIRCd* Instance) : Command(Instance,"PONG", 0, 1, false, 0) { syntax = "<ping-text>"; }
  34         /** Handle command.
  35          * @param parameters The parameters to the comamnd
  36          * @param pcnt The number of parameters passed to teh command
  37          * @param user The user issuing the command
  38          * @return A value from CmdResult to indicate command success or failure.
  39          */
  40         CmdResult Handle(const std::vector<std::string>& parameters, User *user);
  41 };
  42
  43 #endif