path: root/docs/man/man3/chanrec.3

.TH "chanrec" 3 "7 May 2005" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
chanrec \- Holds all relevent information for a channel.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <channels.h>\fP
.PP
Inherits \fBExtensible\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "void \fBSetCustomMode\fP (char mode, bool mode_on)"
.br
.RI "\fISets or unsets a custom mode in the channels info. \fP"
.ti -1c
.RI "void \fBSetCustomModeParam\fP (char mode, char *parameter, bool mode_on)"
.br
.RI "\fISets or unsets the parameters for a custom mode in a channels info. \fP"
.ti -1c
.RI "bool \fBIsCustomModeSet\fP (char mode)"
.br
.RI "\fIReturns true if a custom mode is set on a channel. \fP"
.ti -1c
.RI "std::string \fBGetModeParameter\fP (char mode)"
.br
.RI "\fIReturns the parameter for a custom mode on a channel. \fP"
.ti -1c
.RI "void \fBIncUserCounter\fP ()"
.br
.RI "\fIIncrement the channel 'user counter' The channel user counter is a reference counter which holds the number of users on the channel. \fP"
.ti -1c
.RI "void \fBDecUserCounter\fP ()"
.br
.RI "\fIDecrement the channel 'user counter' The channel user counter is a reference counter which holds the number of users on the channel. \fP"
.ti -1c
.RI "long \fBGetUserCounter\fP ()"
.br
.RI "\fIObtain 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. \fP"
.ti -1c
.RI "void \fBAddUser\fP (char *castuser)"
.br
.RI "\fIAdd 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. \fP"
.ti -1c
.RI "void \fBDelUser\fP (char *castuser)"
.br
.RI "\fIDelete 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. \fP"
.ti -1c
.RI "std::vector< char * > * \fBGetUsers\fP ()"
.br
.RI "\fIObrain the internal reference list The internal reference list contains a list of userrec* cast to char*. \fP"
.ti -1c
.RI "\fBchanrec\fP ()"
.br
.RI "\fICreates a channel record and initialises it with default values. \fP"
.ti -1c
.RI "virtual \fB~chanrec\fP ()"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "char \fBname\fP [CHANMAX]"
.br
.RI "\fIThe channels name. \fP"
.ti -1c
.RI "char \fBcustom_modes\fP [MAXMODES]"
.br
.RI "\fICustom modes for the channel. \fP"
.ti -1c
.RI "long \fBusers\fP"
.br
.RI "\fICount of users on the channel used for fast user counting. \fP"
.ti -1c
.RI "std::vector< char * > \fBinternal_userlist\fP"
.br
.RI "\fIUser list (casted to char*'s to stop forward declaration stuff) (chicken and egg scenario!). \fP"
.ti -1c
.RI "char \fBtopic\fP [MAXBUF]"
.br
.RI "\fIChannel topic. \fP"
.ti -1c
.RI "time_t \fBcreated\fP"
.br
.RI "\fICreation time. \fP"
.ti -1c
.RI "time_t \fBtopicset\fP"
.br
.RI "\fITime topic was set. \fP"
.ti -1c
.RI "char \fBsetby\fP [NICKMAX]"
.br
.RI "\fIThe last user to set the topic. \fP"
.ti -1c
.RI "long \fBlimit\fP"
.br
.RI "\fIContains the channel user limit. \fP"
.ti -1c
.RI "char \fBkey\fP [32]"
.br
.RI "\fIContains the channel key. \fP"
.ti -1c
.RI "short int \fBtopiclock\fP"
.br
.RI "\fINonzero if the mode +t is set. \fP"
.ti -1c
.RI "short int \fBnoexternal\fP"
.br
.RI "\fINonzero if the mode +n is set. \fP"
.ti -1c
.RI "short int \fBinviteonly\fP"
.br
.RI "\fINonzero if the mode +i is set. \fP"
.ti -1c
.RI "short int \fBmoderated\fP"
.br
.RI "\fINonzero if the mode +m is set. \fP"
.ti -1c
.RI "short int \fBsecret\fP"
.br
.RI "\fINonzero if the mode +s is set. \fP"
.ti -1c
.RI "short int \fBc_private\fP"
.br
.RI "\fINonzero if the mode +p is set. \fP"
.ti -1c
.RI "\fBBanList\fP \fBbans\fP"
.br
.RI "\fIThe list of all bans set on the channel. \fP"
.in -1c
.SH "Detailed Description"
.PP 
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. 
.PP
Definition at line 94 of file channels.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "chanrec::chanrec ()"
.PP
Creates a channel record and initialises it with default values. Definition at line 113 of file channels.cpp.
.PP
References c_private, created, custom_modes, internal_userlist, inviteonly, key, limit, moderated, name, noexternal, secret, setby, topic, topiclock, topicset, and users.
.PP
.nf
114 {
115         strcpy(name,'');
116         strcpy(custom_modes,'');
117         strcpy(topic,'');
118         strcpy(setby,'');
119         strcpy(key,'');
120         created = topicset = limit = users = 0;
121         topiclock = noexternal = inviteonly = moderated = secret = c_private = false;
122         internal_userlist.clear();
123 }
.fi
.SS "virtual chanrec::~\fBchanrec\fP ()\fC [inline, virtual]\fP"
.PP
Definition at line 240 of file channels.h.
.PP
.nf
240 { /* stub */ }
.fi
.SH "Member Function Documentation"
.PP 
.SS "void chanrec::AddUser (char * castuser)"
.PP
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 220 of file channels.cpp.
.PP
References DEBUG, and internal_userlist.
.PP
.nf
221 {
222         internal_userlist.push_back(castuser);
223         log(DEBUG,'Added casted user to channel's internal list');
224 }
.fi
.SS "void chanrec::DecUserCounter ()"
.PP
Decrement the channel 'user counter' The channel user counter is a reference counter which holds the number of users on the channel. If it decremented to 0 then the channel is removed from the system. Modules may alter the reference count to hold channels open which have no users and would normally be deleted once empty.Definition at line 208 of file channels.cpp.
.PP
References DEBUG, name, and users.
.PP
.nf
209 {
210         if (this->users > 0)
211                 this->users--;
212         log(DEBUG,'Decremented channel user count for %s to %lu',name,(unsigned long)users);
213 }
.fi
.SS "void chanrec::DelUser (char * castuser)"
.PP
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 226 of file channels.cpp.
.PP
References DEBUG, internal_userlist, and name.
.PP
.nf
227 {
228         for (std::vector<char*>::iterator a = internal_userlist.begin(); a < internal_userlist.end(); a++)
229         {
230                 if (*a == castuser)
231                 {
232                         log(DEBUG,'Removed casted user from channel's internal list');
233                         internal_userlist.erase(a);
234                         return;
235                 }
236         }
237         log(DEBUG,'BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!',name);
238 }
.fi
.SS "std::string chanrec::GetModeParameter (char mode)"
.PP
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.
.PP
References custom_mode_params.
.PP
.nf
188 {
189         if (custom_mode_params.size())
190         {
191                 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
192                 {
193                         if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
194                         {
195                                 return std::string(i->parameter);
196                         }
197                 }
198         }
199         return std::string('');
200 }
.fi
.SS "long chanrec::GetUserCounter ()"
.PP
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 215 of file channels.cpp.
.PP
References users.
.PP
.nf
216 {
217         return (this->users);
218 }
.fi
.SS "std::vector< char * > * chanrec::GetUsers ()"
.PP
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 240 of file channels.cpp.
.PP
References internal_userlist.
.PP
Referenced by Server::GetUsers().
.PP
.nf
241 {
242         return &internal_userlist;
243 }
.fi
.SS "void chanrec::IncUserCounter ()"
.PP
Increment the channel 'user counter' The channel user counter is a reference counter which holds the number of users on the channel. If it decremented to 0 then the channel is removed from the system.Definition at line 202 of file channels.cpp.
.PP
References DEBUG, name, and users.
.PP
.nf
203 {
204         this->users++;
205         log(DEBUG,'Incremented channel user count for %s to %lu',name,(unsigned long)users);
206 }
.fi
.SS "bool chanrec::IsCustomModeSet (char mode)"
.PP
Returns true if a custom mode is set on a channel. Definition at line 181 of file channels.cpp.
.PP
References DEBUG.
.PP
.nf
182 {
183         log(DEBUG,'Checking ISCustomModeSet: %c %s',mode,this->custom_modes);
184         return (strchr(this->custom_modes,mode) != 0);
185 }
.fi
.SS "void chanrec::SetCustomMode (char mode, bool mode_on)"
.PP
Sets or unsets a custom mode in the channels info. Definition at line 125 of file channels.cpp.
.PP
References custom_modes, DEBUG, and SetCustomModeParam().
.PP
.nf
126 {
127         if (mode_on) {
128                 static char m[3];
129                 m[0] = mode;
130                 m[1] = '\0';
131                 if (!strchr(this->custom_modes,mode))
132                 {
133                         strlcat(custom_modes,m,MAXMODES);
134                 }
135                 log(DEBUG,'Custom mode %c set',mode);
136         }
137         else {
138 
139                 std::string a = this->custom_modes;
140                 int pos = a.find(mode);
141                 a.erase(pos,1);
142                 strncpy(this->custom_modes,a.c_str(),MAXMODES);
143 
144                 log(DEBUG,'Custom mode %c removed: modelist='%s'',mode,this->custom_modes);
145                 this->SetCustomModeParam(mode,'',false);
146         }
147 }
.fi
.SS "void chanrec::SetCustomModeParam (char mode, char * parameter, bool mode_on)"
.PP
Sets or unsets the parameters for a custom mode in a channels info. Definition at line 150 of file channels.cpp.
.PP
References ModeParameter::channel, custom_mode_params, DEBUG, ModeParameter::mode, and ModeParameter::parameter.
.PP
Referenced by SetCustomMode().
.PP
.nf
151 {
152 
153         log(DEBUG,'SetCustomModeParam called');
154         ModeParameter M;
155         M.mode = mode;
156         strlcpy(M.channel,this->name,CHANMAX);
157         strlcpy(M.parameter,parameter,MAXBUF);
158         if (mode_on)
159         {
160                 log(DEBUG,'Custom mode parameter %c %s added',mode,parameter);
161                 custom_mode_params.push_back(M);
162         }
163         else
164         {
165                 if (custom_mode_params.size())
166                 {
167                         for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
168                         {
169                                 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
170                                 {
171                                         log(DEBUG,'Custom mode parameter %c %s removed',mode,parameter);
172                                         custom_mode_params.erase(i);
173                                         return;
174                                 }
175                         }
176                 }
177                 log(DEBUG,'*** BUG *** Attempt to remove non-existent mode parameter!');
178         }
179 }
.fi
.SH "Member Data Documentation"
.PP 
.SS "\fBBanList\fP \fBchanrec::bans\fP"
.PP
The list of all bans set on the channel. Definition at line 168 of file channels.h.
.SS "short int \fBchanrec::c_private\fP"
.PP
Nonzero if the mode +p is set. This value cannot be set at the same time as \fBchanrec::secret\fPDefinition at line 164 of file channels.h.
.PP
Referenced by chanrec().
.SS "time_t \fBchanrec::created\fP"
.PP
Creation time. Definition at line 120 of file channels.h.
.PP
Referenced by chanrec().
.SS "char \fBchanrec::custom_modes\fP[MAXMODES]"
.PP
Custom modes for the channel. Plugins may use this field in any way they see fit.Definition at line 103 of file channels.h.
.PP
Referenced by chanrec(), and SetCustomMode().
.SS "std::vector<char*> \fBchanrec::internal_userlist\fP"
.PP
User list (casted to char*'s to stop forward declaration stuff) (chicken and egg scenario!). Definition at line 112 of file channels.h.
.PP
Referenced by AddUser(), chanrec(), DelUser(), and GetUsers().
.SS "short int \fBchanrec::inviteonly\fP"
.PP
Nonzero if the mode +i is set. Definition at line 150 of file channels.h.
.PP
Referenced by chanrec().
.SS "char \fBchanrec::key\fP[32]"
.PP
Contains the channel key. If this value is an empty string, there is no channel key in place.Definition at line 138 of file channels.h.
.PP
Referenced by chanrec().
.SS "long \fBchanrec::limit\fP"
.PP
Contains the channel user limit. If this value is zero, there is no limit in place.Definition at line 133 of file channels.h.
.PP
Referenced by chanrec().
.SS "short int \fBchanrec::moderated\fP"
.PP
Nonzero if the mode +m is set. Definition at line 154 of file channels.h.
.PP
Referenced by chanrec().
.SS "char \fBchanrec::name\fP[CHANMAX]"
.PP
The channels name. Definition at line 99 of file channels.h.
.PP
Referenced by chanrec(), DecUserCounter(), DelUser(), IncUserCounter(), and Server::PseudoToUser().
.SS "short int \fBchanrec::noexternal\fP"
.PP
Nonzero if the mode +n is set. Definition at line 146 of file channels.h.
.PP
Referenced by chanrec().
.SS "short int \fBchanrec::secret\fP"
.PP
Nonzero if the mode +s is set. This value cannot be set at the same time as \fBchanrec::c_private\fPDefinition at line 159 of file channels.h.
.PP
Referenced by chanrec().
.SS "char \fBchanrec::setby\fP[NICKMAX]"
.PP
The last user to set the topic. If this member is an empty string, no topic was ever set.Definition at line 128 of file channels.h.
.PP
Referenced by chanrec(), and Server::PseudoToUser().
.SS "char \fBchanrec::topic\fP[MAXBUF]"
.PP
Channel topic. If this is an empty string, no channel topic is set.Definition at line 117 of file channels.h.
.PP
Referenced by chanrec(), and Server::PseudoToUser().
.SS "short int \fBchanrec::topiclock\fP"
.PP
Nonzero if the mode +t is set. Definition at line 142 of file channels.h.
.PP
Referenced by chanrec().
.SS "time_t \fBchanrec::topicset\fP"
.PP
Time topic was set. If no topic was ever set, this will be equal to \fBchanrec::created\fPDefinition at line 124 of file channels.h.
.PP
Referenced by chanrec(), and Server::PseudoToUser().
.SS "long \fBchanrec::users\fP"
.PP
Count of users on the channel used for fast user counting. Definition at line 107 of file channels.h.
.PP
Referenced by chanrec(), DecUserCounter(), GetUserCounter(), and IncUserCounter().

.SH "Author"
.PP 
Generated automatically by Doxygen for InspIRCd from the source code.