chanrec Class Reference

Holds all relevent information for a channel. More...

#include <channels.h>

Inheritance diagram for chanrec:

[legend]Collaboration diagram for chanrec:

[legend]List of all members.

Public Member Functions
void	SetCustomMode (char mode, bool mode_on)
	Sets or unsets a custom mode in the channels info.
void	SetCustomModeParam (char mode, char *parameter, bool mode_on)
	Sets or unsets the parameters for a custom mode in a channels info.
bool	IsCustomModeSet (char mode)
	Returns true if a custom mode is set on a channel.
std::string	GetModeParameter (char mode)
	Returns the parameter for a custom mode on a channel.
long	GetUserCounter ()
	Obtain the channel "user counter" This returns the channel reference counter, which is initialized to 0 when the channel is created and incremented/decremented upon joins, parts quits and kicks.
void	AddUser (char *castuser)
	Add a user pointer to the internal reference list The data inserted into the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison.
void	DelUser (char *castuser)
	Delete a user pointer to the internal reference list The data removed from the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison.
std::vector< char * > *	GetUsers ()
	Obrain the internal reference list The internal reference list contains a list of userrec* cast to char*.
	chanrec ()
	Creates a channel record and initialises it with default values.
virtual	~chanrec ()
Public Attributes
char	name [CHANMAX]
	The channels name.
char	custom_modes [MAXMODES]
	Custom modes for the channel.
std::vector< char * >	internal_userlist
	User list (casted to char*'s to stop forward declaration stuff) (chicken and egg scenario!).
char	topic [MAXBUF]
	Channel topic.
time_t	created
	Creation time.
time_t	topicset
	Time topic was set.
char	setby [NICKMAX]
	The last user to set the topic.
short int	limit
	Contains the channel user limit.
char	key [32]
	Contains the channel key.
char	binarymodes
	Contains a bitmask of the CM_* builtin (RFC) binary mode symbols.
BanList	bans
	The list of all bans set on the channel.

---

Detailed Description

Holds all relevent information for a channel.

This class represents a channel, and contains its name, modes, time created, topic, topic set time, etc, and an instance of the BanList type.

Definition at line 101 of file channels.h.

---

Constructor & Destructor Documentation

chanrec::chanrec (   )

Creates a channel record and initialises it with default values. Definition at line 113 of file channels.cpp. References binarymodes, created, custom_modes, internal_userlist, key, limit, name, setby, topic, and topicset. { strcpy(name,""); strcpy(custom_modes,""); strcpy(topic,""); strcpy(setby,""); strcpy(key,""); created = topicset = limit = 0; binarymodes = 0; internal_userlist.clear(); }

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

Definition at line 205 of file channels.h. { /* stub */ }

---

Member Function Documentation

void chanrec::AddUser (  char *  castuser  )

Add a user pointer to the internal reference list The data inserted into the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison. Definition at line 207 of file channels.cpp. References DEBUG, and internal_userlist. { internal_userlist.push_back(castuser); log(DEBUG,"Added casted user to channel's internal list"); }

void chanrec::DelUser (  char *  castuser  )

Delete a user pointer to the internal reference list The data removed from the reference list is a table as it is an arbitary pointer compared to other users by its memory address, as this is a very fast 32 or 64 bit integer comparison. Definition at line 213 of file channels.cpp. References DEBUG, internal_userlist, and name. { for (std::vector<char*>::iterator a = internal_userlist.begin(); a < internal_userlist.end(); a++) { if (*a == castuser) { log(DEBUG,"Removed casted user from channel's internal list"); internal_userlist.erase(a); return; } } log(DEBUG,"BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!",name); }

std::string chanrec::GetModeParameter (  char  mode  )

Returns the parameter for a custom mode on a channel. For example if "+L #foo" is set, and you pass this method 'L', it will return '#foo'. If the mode is not set on the channel, or the mode has no parameters associated with it, it will return an empty string. Definition at line 187 of file channels.cpp. References custom_mode_params. { if (custom_mode_params.size()) { for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) { if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) { return i->parameter; } } } return ""; }

long chanrec::GetUserCounter (   )

Obtain the channel "user counter" This returns the channel reference counter, which is initialized to 0 when the channel is created and incremented/decremented upon joins, parts quits and kicks. Definition at line 202 of file channels.cpp. References internal_userlist. { return (this->internal_userlist.size()); }

std::vector< char * > * chanrec::GetUsers (   )

Obrain the internal reference list The internal reference list contains a list of userrec* cast to char*. These are used for rapid comparison to determine channel membership for PRIVMSG, NOTICE, QUIT, PART etc. The resulting pointer to the vector should be considered readonly and only modified via AddUser and DelUser. Definition at line 227 of file channels.cpp. References internal_userlist. Referenced by Server::GetUsers(). { return &internal_userlist; }

bool chanrec::IsCustomModeSet (  char  mode  )

Returns true if a custom mode is set on a channel. Definition at line 181 of file channels.cpp. References DEBUG. { log(DEBUG,"Checking ISCustomModeSet: %c %s",mode,this->custom_modes); return (strchr(this->custom_modes,mode) != 0); }

void chanrec::SetCustomMode (  char  mode, bool  mode_on )

Sets or unsets a custom mode in the channels info. Definition at line 125 of file channels.cpp. References custom_modes, DEBUG, and SetCustomModeParam(). { if (mode_on) { static char m[3]; m[0] = mode; m[1] = '\0'; if (!strchr(this->custom_modes,mode)) { strlcat(custom_modes,m,MAXMODES); } log(DEBUG,"Custom mode %c set",mode); } else { std::string a = this->custom_modes; int pos = a.find(mode); a.erase(pos,1); strncpy(this->custom_modes,a.c_str(),MAXMODES); log(DEBUG,"Custom mode %c removed: modelist='%s'",mode,this->custom_modes); this->SetCustomModeParam(mode,"",false); } }

void chanrec::SetCustomModeParam (  char  mode, char *  parameter, bool  mode_on )

Sets or unsets the parameters for a custom mode in a channels info. Definition at line 150 of file channels.cpp. References ModeParameter::channel, custom_mode_params, DEBUG, ModeParameter::mode, and ModeParameter::parameter. Referenced by SetCustomMode(). { log(DEBUG,"SetCustomModeParam called"); ModeParameter M; M.mode = mode; strlcpy(M.channel,this->name,CHANMAX); strlcpy(M.parameter,parameter,MAXBUF); if (mode_on) { log(DEBUG,"Custom mode parameter %c %s added",mode,parameter); custom_mode_params.push_back(M); } else { if (custom_mode_params.size()) { for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++) { if ((i->mode == mode) && (!strcasecmp(this->name,i->channel))) { log(DEBUG,"Custom mode parameter %c %s removed",mode,parameter); custom_mode_params.erase(i); return; } } } log(DEBUG,"*** BUG *** Attempt to remove non-existent mode parameter!"); } }

---

Member Data Documentation

BanList chanrec::bans

The list of all bans set on the channel. Definition at line 149 of file channels.h.

char chanrec::binarymodes

Contains a bitmask of the CM_* builtin (RFC) binary mode symbols. Definition at line 145 of file channels.h. Referenced by chanrec().

time_t chanrec::created

Creation time. Definition at line 123 of file channels.h. Referenced by chanrec().

char chanrec::custom_modes[MAXMODES]

Custom modes for the channel. Plugins may use this field in any way they see fit. Definition at line 110 of file channels.h. Referenced by chanrec(), and SetCustomMode().

std::vector<char*> chanrec::internal_userlist

User list (casted to char*'s to stop forward declaration stuff) (chicken and egg scenario!). Definition at line 115 of file channels.h. Referenced by AddUser(), chanrec(), DelUser(), GetUserCounter(), and GetUsers().

char chanrec::key[32]

Contains the channel key. If this value is an empty string, there is no channel key in place. Definition at line 141 of file channels.h. Referenced by chanrec().

short int chanrec::limit

Contains the channel user limit. If this value is zero, there is no limit in place. Definition at line 136 of file channels.h. Referenced by chanrec().

char chanrec::name[CHANMAX]

The channels name. Definition at line 106 of file channels.h. Referenced by chanrec(), DelUser(), and Server::PseudoToUser().

char chanrec::setby[NICKMAX]

The last user to set the topic. If this member is an empty string, no topic was ever set. Definition at line 131 of file channels.h. Referenced by chanrec(), and Server::PseudoToUser().

char chanrec::topic[MAXBUF]

Channel topic. If this is an empty string, no channel topic is set. Definition at line 120 of file channels.h. Referenced by chanrec(), and Server::PseudoToUser().

time_t chanrec::topicset

Time topic was set. If no topic was ever set, this will be equal to chanrec::created Definition at line 127 of file channels.h. Referenced by chanrec(), and Server::PseudoToUser().

---

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

• channels.h
• channels.cpp

---