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

.TH "chanrec" 3 "12 Dec 2005" "Version 1.0Betareleases" "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 "\fBstd::string\fP \fBGetModeParameter\fP (char mode)"
.br
.RI "\fIReturns the parameter for a custom mode on a 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. \fP"
.ti -1c
.RI "void \fBDelUser\fP (char *castuser)"
.br
.RI "\fIDelete a user pointer to the internal reference list. \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 "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 "short int \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 "char \fBbinarymodes\fP"
.br
.RI "\fIContains a bitmask of the CM_* builtin (RFC) binary mode symbols. \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 101 of file channels.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "chanrec::chanrec ()"
.PP
Creates a channel record and initialises it with default values. 
.PP
Definition at line 101 of file channels.cpp.
.PP
References binarymodes, created, custom_modes, internal_userlist, key, limit, name, setby, topic, and topicset.
.PP
.nf
102 {
103         strcpy(name,'');
104         strcpy(custom_modes,'');
105         strcpy(topic,'');
106         strcpy(setby,'');
107         strcpy(key,'');
108         created = topicset = limit = 0;
109         binarymodes = 0;
110         internal_userlist.clear();
111 }
.fi
.PP
.SS "virtual chanrec::~chanrec ()\fC [inline, virtual]\fP"
.PP
Definition at line 224 of file channels.h.
.PP
.nf
224 { /* stub */ }
.fi
.PP
.SH "Member Function Documentation"
.PP 
.SS "void chanrec::AddUser (char * castuser)"
.PP
Add a user pointer to the internal reference list. 
.PP
\fBParameters:\fP
.RS 4
\fIcastuser\fP This should be a pointer to a userrec, casted to char*
.RE
.PP
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.
.PP
Definition at line 194 of file channels.cpp.
.PP
References DEBUG, and internal_userlist.
.PP
.nf
195 {
196         internal_userlist.push_back(castuser);
197         log(DEBUG,'Added casted user to channel's internal list');
198 }
.fi
.PP
.SS "void chanrec::DelUser (char * castuser)"
.PP
Delete a user pointer to the internal reference list. 
.PP
\fBParameters:\fP
.RS 4
\fIcastuser\fP This should be a pointer to a userrec, casted to char*
.RE
.PP
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.
.PP
Definition at line 200 of file channels.cpp.
.PP
References DEBUG, internal_userlist, and name.
.PP
.nf
201 {
202         for (std::vector<char*>::iterator a = internal_userlist.begin(); a < internal_userlist.end(); a++)
203         {
204                 if (*a == castuser)
205                 {
206                         log(DEBUG,'Removed casted user from channel's internal list');
207                         internal_userlist.erase(a);
208                         return;
209                 }
210         }
211         log(DEBUG,'BUG BUG BUG! Attempt to remove an uncasted user from the internal list of %s!',name);
212 }
.fi
.PP
.SS "\fBstd::string\fP chanrec::GetModeParameter (char mode)"
.PP
Returns the parameter for a custom mode on a channel. 
.PP
\fBParameters:\fP
.RS 4
\fImode\fP The mode character you wish to query
.RE
.PP
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.
.PP
\fBReturns:\fP
.RS 4
The parameter for this mode is returned, or an empty string
.RE
.PP

.PP
Definition at line 174 of file channels.cpp.
.PP
References custom_mode_params.
.PP
.nf
175 {
176         if (custom_mode_params.size())
177         {
178                 for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
179                 {
180                         if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
181                         {
182                                 return i->parameter;
183                         }
184                 }
185         }
186         return '';
187 }
.fi
.PP
.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. 
.PP
\fBReturns:\fP
.RS 4
The number of users on this channel
.RE
.PP

.PP
Definition at line 189 of file channels.cpp.
.PP
.nf
190 {
191         return (this->internal_userlist.size());
192 }
.fi
.PP
.SS "std::vector< char * > * chanrec::GetUsers ()"
.PP
Obrain the internal reference list The internal reference list contains a list of userrec* cast to char*. 
.PP
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.
.PP
\fBReturns:\fP
.RS 4
This function returns a vector of userrec pointers, each of which has been casted to char* to prevent circular references
.RE
.PP

.PP
Definition at line 214 of file channels.cpp.
.PP
References internal_userlist.
.PP
Referenced by Server::GetUsers().
.PP
.nf
215 {
216         return &internal_userlist;
217 }
.fi
.PP
.SS "bool chanrec::IsCustomModeSet (char mode)"
.PP
Returns true if a custom mode is set on a channel. 
.PP
\fBParameters:\fP
.RS 4
\fImode\fP The mode character you wish to query 
.RE
.PP
\fBReturns:\fP
.RS 4
True if the custom mode is set, false if otherwise
.RE
.PP

.PP
Definition at line 169 of file channels.cpp.
.PP
.nf
170 {
171         return (strchr(this->custom_modes,mode));
172 }
.fi
.PP
.SS "void chanrec::SetCustomMode (char mode, bool mode_on)"
.PP
Sets or unsets a custom mode in the channels info. 
.PP
\fBParameters:\fP
.RS 4
\fImode\fP The mode character to set or unset 
.br
\fImode_on\fP True if you want to set the mode or false if you want to remove it
.RE
.PP

.PP
Definition at line 113 of file channels.cpp.
.PP
References custom_modes, DEBUG, and SetCustomModeParam().
.PP
.nf
114 {
115         if (mode_on) {
116                 static char m[3];
117                 m[0] = mode;
118                 m[1] = '\0';
119                 if (!strchr(this->custom_modes,mode))
120                 {
121                         strlcat(custom_modes,m,MAXMODES);
122                 }
123                 log(DEBUG,'Custom mode %c set',mode);
124         }
125         else {
126 
127                 std::string a = this->custom_modes;
128                 int pos = a.find(mode);
129                 a.erase(pos,1);
130                 strncpy(this->custom_modes,a.c_str(),MAXMODES);
131 
132                 log(DEBUG,'Custom mode %c removed: modelist='%s'',mode,this->custom_modes);
133                 this->SetCustomModeParam(mode,'',false);
134         }
135 }
.fi
.PP
.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. 
.PP
\fBParameters:\fP
.RS 4
\fImode\fP The mode character to set or unset 
.br
\fIparameter\fP The parameter string to associate with this mode character 
.br
\fImode_on\fP True if you want to set the mode or false if you want to remove it
.RE
.PP

.PP
Definition at line 138 of file channels.cpp.
.PP
References ModeParameter::channel, custom_mode_params, DEBUG, ModeParameter::mode, and ModeParameter::parameter.
.PP
Referenced by SetCustomMode().
.PP
.nf
139 {
140 
141         log(DEBUG,'SetCustomModeParam called');
142         ModeParameter M;
143         M.mode = mode;
144         strlcpy(M.channel,this->name,CHANMAX);
145         strlcpy(M.parameter,parameter,MAXBUF);
146         if (mode_on)
147         {
148                 log(DEBUG,'Custom mode parameter %c %s added',mode,parameter);
149                 custom_mode_params.push_back(M);
150         }
151         else
152         {
153                 if (custom_mode_params.size())
154                 {
155                         for (vector<ModeParameter>::iterator i = custom_mode_params.begin(); i < custom_mode_params.end(); i++)
156                         {
157                                 if ((i->mode == mode) && (!strcasecmp(this->name,i->channel)))
158                                 {
159                                         log(DEBUG,'Custom mode parameter %c %s removed',mode,parameter);
160                                         custom_mode_params.erase(i);
161                                         return;
162                                 }
163                         }
164                 }
165                 log(DEBUG,'*** BUG *** Attempt to remove non-existent mode parameter!');
166         }
167 }
.fi
.PP
.SH "Member Data Documentation"
.PP 
.SS "\fBBanList\fP \fBchanrec::bans\fP"
.PP
The list of all bans set on the channel. 
.PP
Definition at line 149 of file channels.h.
.SS "char \fBchanrec::binarymodes\fP"
.PP
Contains a bitmask of the CM_* builtin (RFC) binary mode symbols. 
.PP
Definition at line 145 of file channels.h.
.PP
Referenced by chanrec().
.SS "time_t \fBchanrec::created\fP"
.PP
Creation time. 
.PP
Definition at line 123 of file channels.h.
.PP
Referenced by chanrec().
.SS "char \fBchanrec::custom_modes\fP[MAXMODES]"
.PP
Custom modes for the channel. 
.PP
Plugins may use this field in any way they see fit.
.PP
Definition at line 110 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!). 
.PP
Definition at line 115 of file channels.h.
.PP
Referenced by AddUser(), chanrec(), DelUser(), and GetUsers().
.SS "char \fBchanrec::key\fP[32]"
.PP
Contains the channel key. 
.PP
If this value is an empty string, there is no channel key in place.
.PP
Definition at line 141 of file channels.h.
.PP
Referenced by chanrec().
.SS "short int \fBchanrec::limit\fP"
.PP
Contains the channel user limit. 
.PP
If this value is zero, there is no limit in place.
.PP
Definition at line 136 of file channels.h.
.PP
Referenced by chanrec().
.SS "char \fBchanrec::name\fP[CHANMAX]"
.PP
The channels name. 
.PP
Definition at line 106 of file channels.h.
.PP
Referenced by chanrec(), DelUser(), and Server::PseudoToUser().
.SS "char \fBchanrec::setby\fP[NICKMAX]"
.PP
The last user to set the topic. 
.PP
If this member is an empty string, no topic was ever set.
.PP
Definition at line 131 of file channels.h.
.PP
Referenced by chanrec(), and Server::PseudoToUser().
.SS "char \fBchanrec::topic\fP[MAXBUF]"
.PP
Channel topic. 
.PP
If this is an empty string, no channel topic is set.
.PP
Definition at line 120 of file channels.h.
.PP
Referenced by chanrec(), and Server::PseudoToUser().
.SS "time_t \fBchanrec::topicset\fP"
.PP
Time topic was set. 
.PP
If no topic was ever set, this will be equal to \fBchanrec::created\fP
.PP
Definition at line 127 of file channels.h.
.PP
Referenced by chanrec(), and Server::PseudoToUser().

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