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

ModuleCAP Class Reference

Inheritance diagram for ModuleCAP:

Inheritance graph
[legend]
Collaboration diagram for ModuleCAP:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ModuleCAP (InspIRCd *Me)
virtual bool OnCheckReady (User *user)
 Called to check if a user who is connecting can now be allowed to register If any modules return false for this function, the user is held in the waiting state until all modules return true.
virtual ~ModuleCAP ()
virtual Version GetVersion ()
 Returns the version number of a Module.

Private Attributes

CommandCAPnewcommand

Detailed Description

Definition at line 133 of file m_cap.cpp.


Constructor & Destructor Documentation

ModuleCAP::ModuleCAP InspIRCd Me  )  [inline]
 

Definition at line 137 of file m_cap.cpp.

References InspIRCd::AddCommand(), ModuleManager::Attach(), I_OnCheckReady, InspIRCd::Modules, newcommand, and Module::ServerInstance.

virtual ModuleCAP::~ModuleCAP  )  [inline, virtual]
 

Definition at line 157 of file m_cap.cpp.


Member Function Documentation

virtual Version ModuleCAP::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 161 of file m_cap.cpp.

References API_VERSION, and VF_VENDOR.

virtual bool ModuleCAP::OnCheckReady User user  )  [inline, virtual]
 

Called to check if a user who is connecting can now be allowed to register If any modules return false for this function, the user is held in the waiting state until all modules return true.

For example a module which implements ident lookups will continue to return false for a user until their ident lookup is completed. Note that the registration timeout for a user overrides these checks, if the registration timeout is reached, the user is disconnected even if modules report that the user is not ready to connect.

Parameters:
user The user to check
Returns:
true to indicate readiness, false if otherwise

Reimplemented from Module.

Definition at line 148 of file m_cap.cpp.

References Extensible::GetExt().


Member Data Documentation

CommandCAP* ModuleCAP::newcommand [private]
 

Definition at line 135 of file m_cap.cpp.

Referenced by ModuleCAP().


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