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

ModuleTimedBans Class Reference

Inheritance diagram for ModuleTimedBans:

Inheritance graph
[legend]
Collaboration diagram for ModuleTimedBans:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ModuleTimedBans (InspIRCd *Me)
virtual ~ModuleTimedBans ()
virtual int OnDelBan (User *source, Channel *chan, const std::string &banmask)
 Called whenever a ban is removed from a channel's list.
virtual void OnBackgroundTimer (time_t curtime)
 Called once every five seconds for background processing.
virtual Version GetVersion ()
 Returns the version number of a Module.

Private Attributes

CommandTban * mycommand

Detailed Description

Definition at line 109 of file m_timedbans.cpp.

Constructor & Destructor Documentation

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

Definition at line 113 of file m_timedbans.cpp.

References InspIRCd::AddCommand(), ModuleManager::Attach(), I_OnBackgroundTimer, I_OnDelBan, InspIRCd::Modules, mycommand, Module::ServerInstance, and TimedBanList.

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

Definition at line 124 of file m_timedbans.cpp.

References TimedBanList.

Member Function Documentation

virtual Version ModuleTimedBans::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 187 of file m_timedbans.cpp.

References API_VERSION, VF_COMMON, and VF_VENDOR.

virtual void ModuleTimedBans::OnBackgroundTimer (  time_t  curtime  )  [inline, virtual]
 

Called once every five seconds for background processing.

This timer can be used to control timed features. Its period is not accurate enough to be used as a clock, but it is gauranteed to be called at least once in any five second period, directly from the main loop of the server.

Parameters:
curtime The current timer derived from time(2)

Reimplemented from Module.

Definition at line 146 of file m_timedbans.cpp.

References ServerConfig::AllowHalfop, InspIRCd::Config, InspIRCd::FakeClient, InspIRCd::FindChan(), ModeParser::GetLastParse(), InspIRCd::Modes, Channel::name, InspIRCd::PI, InspIRCd::SendMode(), ProtocolInterface::SendModeStr(), Module::ServerInstance, TimedBanList, and Channel::WriteAllExcept().

virtual int ModuleTimedBans::OnDelBan (  User *  source,
Channel *  chan,
const std::string &  banmask
)  [inline, virtual]
 

Called whenever a ban is removed from a channel's list.

Return a non-zero value to 'eat' the mode change and prevent the ban from being removed.

Parameters:
source The user deleting the ban
channel The channel the ban is being deleted from
banmask The ban mask being deleted
Returns:
1 to block the unban, 0 to continue as normal

Reimplemented from Module.

Definition at line 129 of file m_timedbans.cpp.

References Channel::name, and TimedBanList.

Member Data Documentation

CommandTban* ModuleTimedBans::mycommand [private]
 

Definition at line 111 of file m_timedbans.cpp.

Referenced by ModuleTimedBans().

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