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

ModuleRemove Class Reference

Inheritance diagram for ModuleRemove:

[legend]Collaboration diagram for ModuleRemove:

[legend]List of all members.

Public Member Functions
	ModuleRemove (InspIRCd *Me)
virtual void	On005Numeric (std::string &output)
	Called when a 005 numeric is about to be output.
virtual void	OnRehash (User *user, const std::string &)
	Called on rehash.
virtual	~ModuleRemove ()
virtual Version	GetVersion ()
	Returns the version number of a Module.
Private Attributes
CommandRemove *	mycommand
CommandFpart *	mycommand2
bool	supportnokicks

---

Detailed Description

Definition at line 239 of file m_remove.cpp.

---

Constructor & Destructor Documentation

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

Definition at line 247 of file m_remove.cpp. References InspIRCd::AddCommand(), ModuleManager::Attach(), I_On005Numeric, I_OnRehash, InspIRCd::Modules, mycommand, mycommand2, OnRehash(), Module::ServerInstance, and supportnokicks.

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

Definition at line 271 of file m_remove.cpp.

---

Member Function Documentation

virtual Version ModuleRemove::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 275 of file m_remove.cpp. References API_VERSION, VF_COMMON, and VF_VENDOR.

virtual void ModuleRemove::On005Numeric (  std::string &  output  )  [inline, virtual]

Called when a 005 numeric is about to be output. The module should modify the 005 numeric if needed to indicate its features. Parameters: output  The 005 string to be modified if neccessary. Reimplemented from Module. Definition at line 260 of file m_remove.cpp.

virtual void ModuleRemove::OnRehash (  User *  user, const std::string &  )  [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 265 of file m_remove.cpp. References conf, ConfigReader::ReadFlag(), Module::ServerInstance, and supportnokicks. Referenced by ModuleRemove().

---

Member Data Documentation

CommandRemove* ModuleRemove::mycommand [private]

Definition at line 241 of file m_remove.cpp. Referenced by ModuleRemove().

CommandFpart* ModuleRemove::mycommand2 [private]

Definition at line 242 of file m_remove.cpp. Referenced by ModuleRemove().

bool ModuleRemove::supportnokicks [private]

Definition at line 243 of file m_remove.cpp. Referenced by ModuleRemove(), and OnRehash().

---

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

• m_remove.cpp