Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

ModuleMapHide Class Reference

Inheritance diagram for ModuleMapHide:

[legend]Collaboration diagram for ModuleMapHide:

[legend]List of all members.

Public Member Functions
	ModuleMapHide (InspIRCd *Me)
void	OnRehash (User *user, const std::string &parameter)
	Called on rehash.
int	OnPreCommand (std::string &command, std::vector< std::string > &parameters, User *user, bool validated, const std::string &original_line)
	Called whenever any command is about to be executed.
virtual	~ModuleMapHide ()
virtual Version	GetVersion ()
	Returns the version number of a Module.
Private Attributes
std::string	url

---

Detailed Description

Definition at line 18 of file m_maphide.cpp.

---

Constructor & Destructor Documentation

ModuleMapHide::ModuleMapHide (  InspIRCd *  Me  )  [inline]

Definition at line 22 of file m_maphide.cpp. References ModuleManager::Attach(), I_OnPreCommand, I_OnRehash, InspIRCd::Modules, OnRehash(), and Module::ServerInstance.

virtual ModuleMapHide::~ModuleMapHide (   )  [inline, virtual]

Definition at line 48 of file m_maphide.cpp.

---

Member Function Documentation

virtual Version ModuleMapHide::GetVersion (   )  [inline, virtual]

Returns the version number of a Module. The method should return a Version object with its version information assigned via Version::Version Reimplemented from Module. Definition at line 52 of file m_maphide.cpp. References API_VERSION, and VF_VENDOR.

int ModuleMapHide::OnPreCommand (  std::string &  command, std::vector< std::string > &  parameters, User *  user, bool  validated, const std::string &  original_line )  [inline, virtual]

Called whenever any command is about to be executed. This event occurs for all registered commands, wether they are registered in the core, or another module, and for invalid commands. Invalid commands may only be sent to this function when the value of validated is false. By returning 1 from this method you may prevent the command being executed. If you do this, no output is created by the core, and it is down to your module to produce any output neccessary. Note that unless you return 1, you should not destroy any structures (e.g. by using InspIRCd::QuitUser) otherwise when the command's handler function executes after your method returns, it will be passed an invalid pointer to the user object and crash!) Parameters: command  The command being executed parameters  An array of array of characters containing the parameters for the command pcnt  The nuimber of parameters passed to the command user  the user issuing the command validated  True if the command has passed all checks, e.g. it is recognised, has enough parameters, the user has permission to execute it, etc. You should only change the parameter list and command string if validated == false (e.g. before the command lookup occurs). original_line  The entire original line as passed to the parser from the user Returns: 1 to block the command, 0 to allow Reimplemented from Module. Definition at line 37 of file m_maphide.cpp. References IS_OPER, User::nick, url, and User::WriteServ().

void ModuleMapHide::OnRehash (  User *  user, const std::string &  parameter )  [inline, virtual]

Called on rehash. This method is called prior to a /REHASH or when a SIGHUP is received from the operating system. You should use it to reload any files so that your module keeps in step with the rest of the application. If a parameter is given, the core has done nothing. The module receiving the event can decide if this parameter has any relevence to it. Parameters: user  The user performing the rehash, if any -- if this is server initiated, the value of this variable will be NULL. parameter  The (optional) parameter given to REHASH from the user. Reimplemented from Module. Definition at line 31 of file m_maphide.cpp. References ConfigReader::ReadValue(), Module::ServerInstance, and url. Referenced by ModuleMapHide().

---

Member Data Documentation

std::string ModuleMapHide::url [private]

Definition at line 20 of file m_maphide.cpp. Referenced by OnPreCommand(), and OnRehash().

---

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

• m_maphide.cpp