ModeChannelVoice Class Reference

Channel mode +v. More...

#include <cmode_v.h>

Inheritance diagram for ModeChannelVoice:

[legend]Collaboration diagram for ModeChannelVoice:

[legend]List of all members.


Public Member Functions
	ModeChannelVoice (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.
std::string	AddVoice (User user, const char dest, Channel *chan, int status)
std::string	DelVoice (User user, const char dest, Channel *chan, int status)
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.
unsigned int	GetPrefixRank ()
	Get the 'value' of this modes prefix.
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.
void	RemoveMode (Channel channel, irc::modestacker stack=NULL)
	When a MODETYPE_CHANNEL mode handler is being removed, the server will call this method for every channel on the server.

Detailed Description

Channel mode +v.

Definition at line 21 of file cmode_v.h.

Constructor & Destructor Documentation

ModeChannelVoice::ModeChannelVoice ( InspIRCd * Instance )

Definition at line 23 of file cmode_v.cpp.

Member Function Documentation

std::string ModeChannelVoice::AddVoice ( User * user,

const char * dest,

Channel * chan,

int status

)

Definition at line 100 of file cmode_v.cpp.
References AC_VOICE, ACR_DEFAULT, ACR_DENY, FOREACH_RESULT, ModeParser::Grant(), I_OnAccessCheck, IS_LOCAL, InspIRCd::Modes, Channel::name, ModeParser::SanityChecks(), ModeHandler::ServerInstance, STATUS_HOP, UCMODE_VOICE, and InspIRCd::ULine().
Referenced by OnModeChange().

std::string ModeChannelVoice::DelVoice ( User * user,

const char * dest,

Channel * chan,

int status

)

Definition at line 128 of file cmode_v.cpp.
References AC_DEVOICE, ACR_DEFAULT, ACR_DENY, FOREACH_RESULT, I_OnAccessCheck, IS_LOCAL, InspIRCd::Modes, Channel::name, ModeParser::Revoke(), ModeParser::SanityChecks(), ModeHandler::ServerInstance, STATUS_HOP, UCMODE_VOICE, and InspIRCd::ULine().
Referenced by OnModeChange().

unsigned int ModeChannelVoice::GetPrefixRank ( ) [virtual]

Get the 'value' of this modes prefix.
determines which to display when there are multiple. The mode with the highest value is ranked first. See the PrefixModeValue enum and Channel::GetPrefixValue() for more information.
Reimplemented from ModeHandler.
Definition at line 27 of file cmode_v.cpp.
References VOICE_VALUE.

ModePair ModeChannelVoice::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 32 of file cmode_v.cpp.
References InspIRCd::FindNick(), Channel::GetStatusFlags(), ModeHandler::ServerInstance, and UCMODE_VOICE.

ModeAction ModeChannelVoice::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 76 of file cmode_v.cpp.
References AddVoice(), DelVoice(), Channel::GetStatus(), MODEACTION_ALLOW, and MODEACTION_DENY.

void ModeChannelVoice::RemoveMode ( Channel * channel,

irc::modestacker * stack = NULL

) [virtual]

When a MODETYPE_CHANNEL mode handler is being removed, the server will call this method for every channel on the server.
Your mode handler should remove its user mode from the channel 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 channel. Note that in the case of listmodes, you should remove the entire list of items.
Parameters:

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

Reimplemented from ModeHandler.
Definition at line 49 of file cmode_v.cpp.
References InspIRCd::FakeClient, Channel::GetVoicedUsers(), Channel::name, User::nick, irc::modestacker::Push(), InspIRCd::SendMode(), and ModeHandler::ServerInstance.

void ModeChannelVoice::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 72 of file cmode_v.cpp.

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

ModeChannelVoice Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation