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

ModuleAllowInvite Class Reference

Inheritance diagram for ModuleAllowInvite:

Inheritance graph
[legend]
Collaboration diagram for ModuleAllowInvite:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ModuleAllowInvite (InspIRCd *Me)
virtual void On005Numeric (std::string &output)
 Called when a 005 numeric is about to be output.
virtual int OnUserPreInvite (User *user, User *dest, Channel *channel, time_t timeout)
 Called whenever a user is about to invite another user into a channel, before any processing is done.
virtual ~ModuleAllowInvite ()
virtual Version GetVersion ()
 Returns the version number of a Module.

Private Attributes

AllowInvite * ni

Detailed Description

Definition at line 24 of file m_allowinvite.cpp.

Constructor & Destructor Documentation

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

Definition at line 29 of file m_allowinvite.cpp.

References ModeParser::AddMode(), ModuleManager::Attach(), I_On005Numeric, I_OnUserPreInvite, InspIRCd::Modes, InspIRCd::Modules, ni, and Module::ServerInstance.

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

Definition at line 57 of file m_allowinvite.cpp.

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

Member Function Documentation

virtual Version ModuleAllowInvite::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 63 of file m_allowinvite.cpp.

References API_VERSION, VF_COMMON, and VF_VENDOR.

virtual void ModuleAllowInvite::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 38 of file m_allowinvite.cpp.

References InspIRCd::AddExtBanChar(), and Module::ServerInstance.

virtual int ModuleAllowInvite::OnUserPreInvite (  User *  user,
User *  dest,
Channel *  channel,
time_t  timeout
)  [inline, virtual]
 

Called whenever a user is about to invite another user into a channel, before any processing is done.

Returning 1 from this function stops the process immediately, causing no output to be sent to the user by the core. If you do this you must produce your own numerics, notices etc. This is useful for modules which may want to filter invites to channels.

Parameters:
source The user who is issuing the INVITE
dest The user being invited
channel The channel the user is being invited to
timeout The time the invite will expire (0 == never)
Returns:
1 to deny the invite, 0 to check whether or not the user has permission to invite, -1 to explicitly allow the invite

Reimplemented from Module.

Definition at line 43 of file m_allowinvite.cpp.

References IS_LOCAL, Channel::IsExtBanned(), and Channel::IsModeSet().

Member Data Documentation

AllowInvite* ModuleAllowInvite::ni [private]
 

Definition at line 26 of file m_allowinvite.cpp.

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

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