ModeChannelKey Class Reference

Channel mode +k. More...

#include <cmode_k.h>

Inheritance diagram for ModeChannelKey:

[legend]Collaboration diagram for ModeChannelKey:

[legend]List of all members.


Public Member Functions
	ModeChannelKey (InspIRCd *Instance)
ModeAction	OnModeChange (User source, User dest, Channel *channel, std::string &parameter, bool adding, bool servermode)
	Called when a mode change for your mode occurs.
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.
void	RemoveMode (Channel channel, irc::modestacker stack=NULL)
void	RemoveMode (User user, irc::modestacker stack=NULL)
	When a MODETYPE_USER mode handler is being removed, the server will call this method for every user on the server.

Detailed Description

Channel mode +k.

Definition at line 20 of file cmode_k.h.

Constructor & Destructor Documentation

ModeChannelKey::ModeChannelKey ( InspIRCd * Instance )

Definition at line 20 of file cmode_k.cpp.

Member Function Documentation

bool ModeChannelKey::CheckTimeStamp ( time_t theirs,

time_t ours,

const std::string & their_param,

const std::string & our_param,

Channel * channel

) [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 61 of file cmode_k.cpp.

ModePair ModeChannelKey::ModeSet ( User * source,

User * dest,

Channel * channel,

const std::string & parameter

) [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 24 of file cmode_k.cpp.
References CM_KEY, Channel::GetModeParameter(), and Channel::modes.

ModeAction ModeChannelKey::OnModeChange ( User * source,

User * dest,

Channel * channel,

std::string & parameter,

bool adding,

bool servermode

) [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 67 of file cmode_k.cpp.
References Channel::GetModeParameter(), IS_LOCAL, Channel::IsModeSet(), MODEACTION_ALLOW, MODEACTION_DENY, Channel::SetMode(), and Channel::SetModeParam().

void ModeChannelKey::RemoveMode ( User * user,

irc::modestacker * stack = NULL

) [virtual]

When a MODETYPE_USER mode handler is being removed, the server will call this method for every user on the server.
Your mode handler should remove its user mode from the user by sending the appropriate server modes using InspIRCd::SendMode(). The default implementation of this method can remove simple modes which have no parameters, and can be used when your mode is of this type, otherwise you must implement a more advanced version of it to remove your mode properly from each user.
Parameters:

user The user which the server wants to remove your mode from

Reimplemented from ModeHandler.
Definition at line 57 of file cmode_k.cpp.

void ModeChannelKey::RemoveMode ( Channel * channel,

irc::modestacker * stack = NULL

) [virtual]

+k needs a parameter when being removed, so we have a special-case RemoveMode here for it
Reimplemented from ModeHandler.
Definition at line 37 of file cmode_k.cpp.
References InspIRCd::FakeClient, Channel::GetModeParameter(), Channel::IsModeSet(), Channel::name, irc::modestacker::Push(), InspIRCd::SendMode(), and ModeHandler::ServerInstance.

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

ModeChannelKey Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation