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

MsgFlood Class Reference

Handles channel mode +f. More...

Inheritance diagram for MsgFlood:

Inheritance graph
[legend]
Collaboration diagram for MsgFlood:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 MsgFlood (InspIRCd *Instance)
ModePair ModeSet (User *source, User *dest, Channel *channel, const std::string &parameter)
 When a remote server needs to bounce a set of modes, it will call this method for every mode in the mode string to determine if the mode is set or not.
bool CheckTimeStamp (time_t theirs, time_t ours, const std::string &their_param, const std::string &our_param, Channel *channel)
 If your mode needs special action during a server sync to determine which side wins when comparing timestamps, override this function and use it to return true or false.
ModeAction OnModeChange (User *source, User *dest, Channel *channel, std::string &parameter, bool adding, bool)
 Called when a mode change for your mode occurs.

Detailed Description

Handles channel mode +f.

Definition at line 77 of file m_messageflood.cpp.

Constructor & Destructor Documentation

MsgFlood::MsgFlood (  InspIRCd *  Instance  )  [inline]
 

Definition at line 80 of file m_messageflood.cpp.

Member Function Documentation

bool MsgFlood::CheckTimeStamp (  time_t  theirs,
time_t  ours,
const std::string &  their_param,
const std::string &  our_param,
Channel *  channel
)  [inline, virtual]
 

If your mode needs special action during a server sync to determine which side wins when comparing timestamps, override this function and use it to return true or false.

The default implementation just returns true if theirs < ours. This will only be called for non-listmodes with parameters, when adding the mode and where theirs == ours (therefore the default implementation will always return false).

Parameters:
theirs The timestamp of the remote side
ours The timestamp of the local side
their_param Their parameter if the mode has a parameter
our_param Our parameter if the mode has a parameter
channel The channel we are checking against
Returns:
True if the other side wins the merge, false if we win the merge for this mode.

Reimplemented from ModeHandler.

Definition at line 91 of file m_messageflood.cpp.

ModePair MsgFlood::ModeSet (  User *  source,
User *  dest,
Channel *  channel,
const std::string &  parameter
)  [inline, virtual]
 

When a remote server needs to bounce a set of modes, it will call this method for every mode in the mode string to determine if the mode is set or not.

Parameters:
source of the mode change, this will be NULL for a server mode
dest Target user of the mode change, if this is a user mode
channel Target channel of the mode change, if this is a channel mode
parameter The parameter given for the mode change, or an empty string
Returns:
The first value of the pair should be true if the mode is set with the given parameter. In the case of permissions modes such as channelmode +o, this should return true if the user given as the parameter has the given privilage on the given channel. The string value of the pair will hold the current setting for this mode set locally, when the bool is true, or, the parameter given. This allows the local server to enforce our locally set parameters back to a remote server.

Reimplemented from ModeHandler.

Definition at line 82 of file m_messageflood.cpp.

References floodsettings::ban, ConvToStr(), Extensible::GetExt(), floodsettings::lines, and floodsettings::secs.

ModeAction MsgFlood::OnModeChange (  User *  source,
User *  dest,
Channel *  channel,
std::string &  parameter,
bool  adding,
bool 
)  [inline, virtual]
 

Called when a mode change for your mode occurs.

Parameters:
source Contains the user setting the mode.
dest For usermodes, contains the destination user the mode is being set on. For channelmodes, this is an undefined value.
channel For channel modes, contains the destination channel the modes are being set on. For usermodes, this is an undefined value.
parameter The parameter for your mode, if you indicated that your mode requires a parameter when being set or unset. Note that if you alter this value, the new value becomes the one displayed and send out to the network, also, if you set this to an empty string but you specified your mode REQUIRES a parameter, this is equivalent to returning MODEACTION_DENY and will prevent the mode from being displayed.
adding This value is true when the mode is being set, or false when it is being unset.
Returns:
MODEACTION_ALLOW to allow the mode, or MODEACTION_DENY to prevent the mode, also see the description of 'parameter'.

Reimplemented from ModeHandler.

Definition at line 97 of file m_messageflood.cpp.

References floodsettings::ban, ConvToStr(), Extensible::Extend(), Extensible::GetExt(), Channel::GetModeParameter(), floodsettings::lines, MAXBUF, MODEACTION_ALLOW, MODEACTION_DENY, Channel::name, User::nick, floodsettings::secs, ModeHandler::ServerInstance, Channel::SetMode(), Channel::SetModeParam(), Extensible::Shrink(), strlcpy(), and User::WriteNumeric().

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