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

ModuleSVSHold Class Reference

Inheritance diagram for ModuleSVSHold:

[legend]Collaboration diagram for ModuleSVSHold:

[legend]List of all members.

Public Member Functions
	ModuleSVSHold (InspIRCd *Me)
virtual int	OnStats (char symbol, User *user, string_list &out)
	Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core.
virtual int	OnUserPreNick (User *user, const std::string &newnick)
	Called before any nickchange, local or remote.
virtual	~ModuleSVSHold ()
virtual Version	GetVersion ()
	Returns the version number of a Module.
Private Attributes
CommandSvshold *	mycommand
SVSHoldFactory *	s

---

Detailed Description

Definition at line 143 of file m_svshold.cpp.

---

Constructor & Destructor Documentation

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

Definition at line 150 of file m_svshold.cpp. References InspIRCd::AddCommand(), ModuleManager::Attach(), I_OnDecodeMetaData, I_OnStats, I_OnSyncOtherMetaData, I_OnUserPreNick, InspIRCd::Modules, mycommand, XLineManager::RegisterFactory(), s, Module::ServerInstance, and InspIRCd::XLines.

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

Definition at line 183 of file m_svshold.cpp. References XLineManager::DelAll(), s, Module::ServerInstance, XLineManager::UnregisterFactory(), and InspIRCd::XLines.

---

Member Function Documentation

virtual Version ModuleSVSHold::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 189 of file m_svshold.cpp. References API_VERSION, VF_COMMON, and VF_VENDOR.

virtual int ModuleSVSHold::OnStats (  char  symbol, User *  user, string_list &  out )  [inline, virtual]

Called on all /STATS commands This method is triggered for all /STATS use, including stats symbols handled by the core. Parameters: symbol  the symbol provided to /STATS user  the user issuing the /STATS command results  A string_list to append results into. You should put all your results into this string_list, rather than displaying them directly, so that your handler will work when remote STATS queries are received. Returns: 1 to block the /STATS from being processed by the core, 0 to allow it Reimplemented from Module. Definition at line 161 of file m_svshold.cpp. References XLineManager::InvokeStats(), Module::ServerInstance, and InspIRCd::XLines.

virtual int ModuleSVSHold::OnUserPreNick (  User *  user, const std::string &  newnick )  [inline, virtual]

Called before any nickchange, local or remote. This can be used to implement Q-lines etc. Please note that although you can see remote nickchanges through this function, you should NOT make any changes to the User if the user is a remote user as this may cause a desnyc. check user->server before taking any action (including returning nonzero from the method). If your method returns nonzero, the nickchange is silently forbidden, and it is down to your module to generate some meaninful output. Parameters: user  The username changing their nick newnick  Their new nickname Returns: 1 to deny the change, 0 to allow Reimplemented from Module. Definition at line 170 of file m_svshold.cpp. References XLineManager::MatchesLine(), User::nick, XLine::reason, Module::ServerInstance, User::WriteServ(), and InspIRCd::XLines.

---

Member Data Documentation

CommandSvshold* ModuleSVSHold::mycommand [private]

Definition at line 145 of file m_svshold.cpp. Referenced by ModuleSVSHold().

SVSHoldFactory* ModuleSVSHold::s [private]

Definition at line 146 of file m_svshold.cpp. Referenced by ModuleSVSHold(), and ~ModuleSVSHold().

---

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

• m_svshold.cpp