Command Class Reference

#include <ctables.h>

Inheritance diagram for Command:

Public Member Functions
	Command (Module *me, const std::string &cmd, int minpara=0, int maxpara=0)
virtual CmdResult	Handle (const std::vector< std::string > &parameters, User *user)=0
virtual RouteDescriptor	GetRouting (User *user, const std::vector< std::string > &parameters)
virtual void	EncodeParameter (std::string &parameter, int index)
virtual void	DecodeParameter (std::string &parameter, int index)
void	Disable (bool setting)
bool	IsDisabled ()
bool	WorksBeforeReg ()
Public Member Functions inherited from ServiceProvider
	ServiceProvider (Module *Creator, const std::string &Name, ServiceType Type)
Public Member Functions inherited from classbase
virtual CullResult	cull ()

Public Attributes
char	flags_needed
const unsigned int	min_params
const unsigned int	max_params
unsigned long	use_count
unsigned long	total_bytes
bool	disabled
bool	works_before_reg
bool	allow_empty_last_param
std::string	syntax
std::vector< TranslateType >	translation
int	Penalty
Public Attributes inherited from ServiceProvider
ModuleRef	creator
const std::string	name
const ServiceType	service

Detailed Description

A structure that defines a command. Every command available in InspIRCd must be defined as derived from Command.

Constructor & Destructor Documentation

Command()

Command::Command ( Module *  me, const std::string &  cmd, int  minpara = 0, int  maxpara = 0  )

inline

Create a new command.

Parameters

me	The module which created this command.
cmd	Command name. This must be UPPER CASE.
minpara	Minimum parameters required for the command.
maxpara	Maximum number of parameters this command may have - extra parameters will be tossed into one last space-seperated param.

Member Function Documentation

DecodeParameter()

virtual void Command::DecodeParameter ( std::string &  parameter, int  index  )

inlinevirtual

Decode a parameter from server->server transmission. Not currently used in this version of InspIRCd. Used for parameters for which the translation type is TR_CUSTOM.

Parameters

parameter	The parameter to decode. Can be modified in place.
index	The parameter index (0 == first parameter).

Disable()

void Command::Disable ( bool  setting )

inline

Disable or enable this command.

Parameters

setting

True to disable the command.

EncodeParameter()

virtual void Command::EncodeParameter ( std::string &  parameter, int  index  )

inlinevirtual

Encode a parameter for server->server transmission. Used for parameters for which the translation type is TR_CUSTOM.

Parameters

parameter	The parameter to encode. Can be modified in place.
index	The parameter index (0 == first parameter).

Handle()

virtual CmdResult Command::Handle ( const std::vector< std::string > &  parameters, User *  user  )

pure virtual

Handle the command from a user.

Parameters

parameters	The parameters for the command.
user	The user who issued the command.

Returns

Return CMD_SUCCESS on success, or CMD_FAILURE on failure.

Implemented in SplitCommand.

IsDisabled()

bool Command::IsDisabled ( )

inline

Obtain this command's disable state.

Returns

true if the command is currently disabled (disabled commands can be used only by operators)

WorksBeforeReg()

bool Command::WorksBeforeReg ( )

inline

Returns

true if the command works before registration.

Member Data Documentation

allow_empty_last_param

bool Command::allow_empty_last_param

True if the command allows an empty last parameter. When false and the last parameter is empty, it's popped BEFORE checking there are enough params, etc. (i.e. the handler won't be called if there aren't enough params after popping the empty param). True by default

disabled

bool Command::disabled

True if the command is disabled to non-opers

flags_needed

char Command::flags_needed

User flags needed to execute the command or 0

max_params

const unsigned int Command::max_params

Maximum number of parameters command takes. This is used by the command parser to join extra parameters into one last param. If not set, no munging is done to this command.

min_params

const unsigned int Command::min_params

Minimum number of parameters command takes

Penalty

int Command::Penalty

How many seconds worth of penalty does this command have?

syntax

std::string Command::syntax

Syntax string for the command, displayed if non-empty string. This takes place of the text in the 'not enough parameters' numeric.

total_bytes

unsigned long Command::total_bytes

used by /stats m

translation

std::vector<TranslateType> Command::translation

Translation type list for possible parameters, used to tokenize parameters into UIDs and SIDs etc.

use_count

unsigned long Command::use_count

used by /stats m

works_before_reg

bool Command::works_before_reg

True if the command can be issued before registering

---

The documentation for this class was generated from the following files:

• include/ctables.h
• src/command_parse.cpp