The InspIRCd Project
Home | Developers | Wiki | Forums | Bug Tracker | SVN | Download
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

ModuleHelpop Class Reference

Inheritance diagram for ModuleHelpop:

Inheritance graph
[legend]
Collaboration diagram for ModuleHelpop:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ModuleHelpop (InspIRCd *Me)
virtual void ReadConfig ()
virtual void OnRehash (User *user, const std::string &parameter)
 Called on rehash.
virtual void OnWhois (User *src, User *dst)
 Called whenever a /WHOIS is performed on a local user.
virtual ~ModuleHelpop ()
virtual Version GetVersion ()
 Returns the version number of a Module.

Private Attributes

std::string h_file
CommandHelpop * mycommand
Helpop * ho

Detailed Description

Definition at line 83 of file m_helpop.cpp.

Constructor & Destructor Documentation

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

Definition at line 91 of file m_helpop.cpp.

References InspIRCd::AddCommand(), ModeParser::AddMode(), ModuleManager::Attach(), ho, I_OnRehash, I_OnWhois, InspIRCd::Modes, InspIRCd::Modules, mycommand, ReadConfig(), and Module::ServerInstance.

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

Definition at line 150 of file m_helpop.cpp.

References ModeParser::DelMode(), ho, InspIRCd::Modes, and Module::ServerInstance.

Member Function Documentation

virtual Version ModuleHelpop::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 156 of file m_helpop.cpp.

References API_VERSION, VF_COMMON, and VF_VENDOR.

virtual void ModuleHelpop::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 137 of file m_helpop.cpp.

References ReadConfig().

virtual void ModuleHelpop::OnWhois (  User *  src,
User *  dst
)  [inline, virtual]
 

Called whenever a /WHOIS is performed on a local user.

The source parameter contains the details of the user who issued the WHOIS command, and the dest parameter contains the information of the user they are whoising.

Parameters:
source The user issuing the WHOIS command
dest The user who is being WHOISed

Reimplemented from Module.

Definition at line 142 of file m_helpop.cpp.

References User::IsModeSet(), User::nick, InspIRCd::SendWhoisLine(), and Module::ServerInstance.

virtual void ModuleHelpop::ReadConfig (   )  [inline, virtual]
 

Definition at line 104 of file m_helpop.cpp.

References assign(), helpop_map, ConfigReader::ReadValue(), and Module::ServerInstance.

Referenced by ModuleHelpop(), and OnRehash().

Member Data Documentation

std::string ModuleHelpop::h_file [private]
 

Definition at line 86 of file m_helpop.cpp.

Helpop* ModuleHelpop::ho [private]
 

Definition at line 88 of file m_helpop.cpp.

Referenced by ModuleHelpop(), and ~ModuleHelpop().

CommandHelpop* ModuleHelpop::mycommand [private]
 

Definition at line 87 of file m_helpop.cpp.

Referenced by ModuleHelpop().

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