]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/module-doc/users_8h-source.html
Added final documentation for inspircd Beta 4
[user/henk/code/inspircd.git] / docs / module-doc / users_8h-source.html
index 47f4689e13f9f423e87cc7963221e7a5f53b6de6..1ebbec1e58388caff3d5cbeb2a14c21bb953278b 100644 (file)
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
-<title>users.h Source File</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css">
+<title>InspIRCd: users.h Source File</title>
+<link href="inspircd.css" rel="stylesheet" type="text/css">
 </head><body>
-<!-- Generated by Doxygen 1.3-rc3 -->
-<center>
-<a class="qindex" href="main.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
-<hr><h1>users.h</h1><a href="users_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span>
-00002 <span class="comment"></span>
-00003 <span class="comment"></span>
-00004 <span class="comment">*/</span>
-00005 
-00006 <span class="preprocessor">#include "inspircd_config.h"</span> 
-00007 <span class="preprocessor">#include "<a class="code" href="channels_8h.html">channels.h</a>"</span>
-00008 <span class="preprocessor">#include "<a class="code" href="connection_8h.html">connection.h</a>"</span>
-00009 
-00010 <span class="preprocessor">#include &lt;string&gt;</span>
-00011  
-00012 <span class="preprocessor">#ifndef __USERS_H__ </span>
-00013 <span class="preprocessor"></span><span class="preprocessor">#define __USERS_H__ </span>
-00014 <span class="preprocessor"></span> 
-<a name="l00015"></a><a class="code" href="users_8h.html#a0">00015</a> <span class="preprocessor">#define STATUS_OP       4</span>
-<a name="l00016"></a><a class="code" href="users_8h.html#a1">00016</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_HOP      2</span>
-<a name="l00017"></a><a class="code" href="users_8h.html#a2">00017</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_VOICE    1</span>
-<a name="l00018"></a><a class="code" href="users_8h.html#a3">00018</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_NORMAL   0</span>
-00019 <span class="preprocessor"></span>
-<a name="l00020"></a><a class="code" href="users_8h.html#a4">00020</a> <span class="preprocessor">#define CC_ALLOW        0</span>
-<a name="l00021"></a><a class="code" href="users_8h.html#a5">00021</a> <span class="preprocessor"></span><span class="preprocessor">#define CC_DENY         1</span>
-00022 <span class="preprocessor"></span>
-<a name="l00025"></a><a class="code" href="classInvited.html">00025</a> <span class="keyword">class </span><a class="code" href="classInvited.html">Invited</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
-00026 {
-00027  <span class="keyword">public</span>:
-<a name="l00028"></a><a class="code" href="classInvited.html#m0">00028</a>         <span class="keywordtype">char</span> <a class="code" href="classInvited.html#m0">channel</a>[CHANMAX];
-00029 };
-00030 
-00031 
-<a name="l00034"></a><a class="code" href="classConnectClass.html">00034</a> <span class="keyword">class </span><a class="code" href="classConnectClass.html">ConnectClass</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
-00035 {
-00036  <span class="keyword">public</span>:
-<a name="l00037"></a><a class="code" href="classConnectClass.html#m0">00037</a>         <span class="keywordtype">int</span> <a class="code" href="classConnectClass.html#m0">type</a>;
-<a name="l00038"></a><a class="code" href="classConnectClass.html#m1">00038</a>         <span class="keywordtype">char</span> <a class="code" href="classConnectClass.html#m1">host</a>[MAXBUF];
-<a name="l00039"></a><a class="code" href="classConnectClass.html#m2">00039</a>         <span class="keywordtype">char</span> <a class="code" href="classConnectClass.html#m2">pass</a>[MAXBUF];
+<!-- Generated by Doxygen 1.3.3 -->
+<div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Compound&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Compound&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
+<h1>users.h</h1><a href="users_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*       +------------------------------------+</span>
+00002 <span class="comment"> *       | Inspire Internet Relay Chat Daemon |</span>
+00003 <span class="comment"> *       +------------------------------------+</span>
+00004 <span class="comment"> *</span>
+00005 <span class="comment"> *  Inspire is copyright (C) 2002-2004 ChatSpike-Dev.</span>
+00006 <span class="comment"> *                       E-mail:</span>
+00007 <span class="comment"> *                &lt;brain@chatspike.net&gt;</span>
+00008 <span class="comment"> *                &lt;Craig@chatspike.net&gt;</span>
+00009 <span class="comment"> *     </span>
+00010 <span class="comment"> * Written by Craig Edwards, Craig McLure, and others.</span>
+00011 <span class="comment"> * This program is free but copyrighted software; see</span>
+00012 <span class="comment"> *            the file COPYING for details.</span>
+00013 <span class="comment"> *</span>
+00014 <span class="comment"> * ---------------------------------------------------</span>
+00015 <span class="comment"> */</span>
+00016 
+00017 <span class="preprocessor">#include "inspircd_config.h"</span> 
+00018 <span class="preprocessor">#include "<a class="code" href="channels_8h.html">channels.h</a>"</span>
+00019 <span class="preprocessor">#include "<a class="code" href="connection_8h.html">connection.h</a>"</span>
+00020 <span class="preprocessor">#include "inspstring.h"</span>
+00021 <span class="preprocessor">#include &lt;string&gt;</span>
+00022  
+00023 <span class="preprocessor">#ifndef __USERS_H__ </span>
+00024 <span class="preprocessor"></span><span class="preprocessor">#define __USERS_H__ </span>
+00025 <span class="preprocessor"></span> 
+<a name="l00026"></a><a class="code" href="users_8h.html#a0">00026</a> <span class="preprocessor">#define STATUS_OP       4</span>
+<a name="l00027"></a><a class="code" href="users_8h.html#a1">00027</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_HOP      2</span>
+<a name="l00028"></a><a class="code" href="users_8h.html#a2">00028</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_VOICE    1</span>
+<a name="l00029"></a><a class="code" href="users_8h.html#a3">00029</a> <span class="preprocessor"></span><span class="preprocessor">#define STATUS_NORMAL   0</span>
+00030 <span class="preprocessor"></span>
+<a name="l00031"></a><a class="code" href="users_8h.html#a4">00031</a> <span class="preprocessor">#define CC_ALLOW        0</span>
+<a name="l00032"></a><a class="code" href="users_8h.html#a5">00032</a> <span class="preprocessor"></span><span class="preprocessor">#define CC_DENY         1</span>
+00033 <span class="preprocessor"></span>
+<a name="l00036"></a><a class="code" href="classInvited.html">00036</a> <span class="keyword">class </span><a class="code" href="classInvited.html">Invited</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
+00037 {
+00038  <span class="keyword">public</span>:
+<a name="l00039"></a><a class="code" href="classInvited.html#o0">00039</a>         <span class="keywordtype">char</span> <a class="code" href="classInvited.html#o0">channel</a>[CHANMAX];
 00040 };
 00041 
-<a name="l00044"></a><a class="code" href="users_8h.html#a6">00044</a> <span class="keyword">typedef</span> vector&lt;Invited&gt; <a class="code" href="users_8h.html#a6">InvitedList</a>;
-00045 
-00046 
-00047 
-<a name="l00050"></a><a class="code" href="users_8h.html#a7">00050</a> <span class="keyword">typedef</span> vector&lt;ConnectClass&gt; <a class="code" href="users_8h.html#a7">ClassVector</a>;
-00051 
-<a name="l00058"></a><a class="code" href="classuserrec.html">00058</a> <span class="keyword">class </span><a class="code" href="classuserrec.html">userrec</a> : <span class="keyword">public</span> <a class="code" href="classconnection.html">connection</a>
-00059 {
-00060  <span class="keyword">private</span>:
-00061 
-<a name="l00064"></a><a class="code" href="classuserrec.html#o0">00064</a>         <a class="code" href="users_8h.html#a6">InvitedList</a> <a class="code" href="classuserrec.html#o0">invites</a>;
-00065  <span class="keyword">public</span>:
-00066         
-<a name="l00071"></a><a class="code" href="classuserrec.html#m0">00071</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m0">nick</a>[NICKMAX];
-00072         
-<a name="l00075"></a><a class="code" href="classuserrec.html#m1">00075</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m1">ident</a>[64];
-00076 
-<a name="l00080"></a><a class="code" href="classuserrec.html#m2">00080</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m2">dhost</a>[256];
-00081         
-<a name="l00084"></a><a class="code" href="classuserrec.html#m3">00084</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m3">fullname</a>[128];
-00085         
-<a name="l00090"></a><a class="code" href="classuserrec.html#m4">00090</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m4">modes</a>[32];
-00091         
-<a name="l00092"></a><a class="code" href="classuserrec.html#m5">00092</a>         <a class="code" href="classucrec.html">ucrec</a> <a class="code" href="classuserrec.html#m5">chans</a>[MAXCHANS];
-00093         
-<a name="l00096"></a><a class="code" href="classuserrec.html#m6">00096</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m6">server</a>[256];
-00097         
-<a name="l00101"></a><a class="code" href="classuserrec.html#m7">00101</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m7">awaymsg</a>[512];
-00102         
-<a name="l00106"></a><a class="code" href="classuserrec.html#m8">00106</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#m8">result</a>[256];
-00107         
-00108         <a class="code" href="classuserrec.html#a0">userrec</a>();
-00109         
-<a name="l00110"></a><a class="code" href="classuserrec.html#a1">00110</a>         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html#a1">~userrec</a>() {  }
-00111         
-00116         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a2">GetFullHost</a>();
-00117         
-00123         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a3">GetFullRealHost</a>();
-00124         
-00127         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#a4">IsInvited</a>(<span class="keywordtype">char</span>* channel);
-00128         
-00131         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a5">InviteTo</a>(<span class="keywordtype">char</span>* channel);
-00132         
-00137         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a6">RemoveInvite</a>(<span class="keywordtype">char</span>* channel);
-00138         
-00139 };
-00140 
-00141 
-00142 <span class="preprocessor">#endif</span>
-</pre></div><hr><address style="align: right;"><small>Generated on Sun Mar 30 19:34:54 2003 for InspIRCd by
+00042 
+<a name="l00045"></a><a class="code" href="classConnectClass.html">00045</a> <span class="keyword">class </span><a class="code" href="classConnectClass.html">ConnectClass</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a>
+00046 {
+00047  <span class="keyword">public</span>:
+<a name="l00050"></a><a class="code" href="classConnectClass.html#o0">00050</a>         <span class="keywordtype">int</span> <a class="code" href="classConnectClass.html#o0">type</a>;
+<a name="l00053"></a><a class="code" href="classConnectClass.html#o1">00053</a>         <span class="keywordtype">int</span> <a class="code" href="classConnectClass.html#o1">registration_timeout</a>;
+<a name="l00056"></a><a class="code" href="classConnectClass.html#o2">00056</a>         <span class="keywordtype">int</span> <a class="code" href="classConnectClass.html#o2">flood</a>;
+<a name="l00059"></a><a class="code" href="classConnectClass.html#o3">00059</a>         <span class="keywordtype">char</span> <a class="code" href="classConnectClass.html#o3">host</a>[MAXBUF];
+<a name="l00062"></a><a class="code" href="classConnectClass.html#o4">00062</a>         <span class="keywordtype">int</span> <a class="code" href="classConnectClass.html#o4">pingtime</a>;
+<a name="l00065"></a><a class="code" href="classConnectClass.html#o5">00065</a>         <span class="keywordtype">char</span> <a class="code" href="classConnectClass.html#o5">pass</a>[MAXBUF];
+00066 
+<a name="l00069"></a><a class="code" href="classConnectClass.html#o6">00069</a>         <span class="keywordtype">long</span> <a class="code" href="classConnectClass.html#o6">threshold</a>;
+00070         
+<a name="l00071"></a><a class="code" href="classConnectClass.html#a0">00071</a>         <a class="code" href="classConnectClass.html#a0">ConnectClass</a>()
+00072         {
+00073                 <a class="code" href="classConnectClass.html#o1">registration_timeout</a> = 0;
+00074                 <a class="code" href="classConnectClass.html#o2">flood</a> = 0;
+00075                 <a class="code" href="classConnectClass.html#o4">pingtime</a> = 0;
+00076                 <a class="code" href="classConnectClass.html#o6">threshold</a> = 0;
+00077                 strlcpy(<a class="code" href="classConnectClass.html#o3">host</a>,<span class="stringliteral">""</span>,MAXBUF);
+00078                 strlcpy(<a class="code" href="classConnectClass.html#o5">pass</a>,<span class="stringliteral">""</span>,MAXBUF);
+00079         }
+00080 };
+00081 
+<a name="l00084"></a><a class="code" href="users_8h.html#a6">00084</a> <span class="keyword">typedef</span> std::vector&lt;Invited&gt; <a class="code" href="users_8h.html#a6">InvitedList</a>;
+00085 
+00086 
+00087 
+<a name="l00090"></a><a class="code" href="users_8h.html#a7">00090</a> <span class="keyword">typedef</span> std::vector&lt;ConnectClass&gt; <a class="code" href="users_8h.html#a7">ClassVector</a>;
+00091 
+<a name="l00098"></a><a class="code" href="classuserrec.html">00098</a> <span class="keyword">class </span><a class="code" href="classuserrec.html">userrec</a> : <span class="keyword">public</span> <a class="code" href="classconnection.html">connection</a>
+00099 {
+00100  <span class="keyword">private</span>:
+00101 
+<a name="l00104"></a><a class="code" href="classuserrec.html#r0">00104</a>         <a class="code" href="users_8h.html#a6">InvitedList</a> <a class="code" href="classuserrec.html#r0">invites</a>;
+00105  <span class="keyword">public</span>:
+00106         
+<a name="l00111"></a><a class="code" href="classuserrec.html#o0">00111</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o0">nick</a>[NICKMAX];
+00112         
+<a name="l00115"></a><a class="code" href="classuserrec.html#o1">00115</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o1">ident</a>[64];
+00116 
+<a name="l00120"></a><a class="code" href="classuserrec.html#o2">00120</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o2">dhost</a>[256];
+00121         
+<a name="l00124"></a><a class="code" href="classuserrec.html#o3">00124</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o3">fullname</a>[128];
+00125         
+<a name="l00130"></a><a class="code" href="classuserrec.html#o4">00130</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o4">modes</a>[MAXBUF];
+00131         
+<a name="l00132"></a><a class="code" href="classuserrec.html#o5">00132</a>         <a class="code" href="classucrec.html">ucrec</a> <a class="code" href="classuserrec.html#o5">chans</a>[MAXCHANS];
+00133         
+<a name="l00136"></a><a class="code" href="classuserrec.html#o6">00136</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o6">server</a>[256];
+00137         
+<a name="l00141"></a><a class="code" href="classuserrec.html#o7">00141</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o7">awaymsg</a>[512];
+00142         
+<a name="l00146"></a><a class="code" href="classuserrec.html#o8">00146</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o8">result</a>[256];
+00147         
+<a name="l00152"></a><a class="code" href="classuserrec.html#o9">00152</a>         <span class="keywordtype">int</span> <a class="code" href="classuserrec.html#o9">flood</a>;
+00153         
+<a name="l00158"></a><a class="code" href="classuserrec.html#o10">00158</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#o10">timeout</a>;
+00159         
+<a name="l00165"></a><a class="code" href="classuserrec.html#o11">00165</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o11">oper</a>[NICKMAX];
+00166 
+<a name="l00169"></a><a class="code" href="classuserrec.html#o12">00169</a>         <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#o12">dns_done</a>;
+00170 
+<a name="l00173"></a><a class="code" href="classuserrec.html#o13">00173</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#o13">pingmax</a>;
+00174 
+<a name="l00179"></a><a class="code" href="classuserrec.html#o14">00179</a>         <span class="keywordtype">char</span> <a class="code" href="classuserrec.html#o14">password</a>[MAXBUF];
+00180 
+<a name="l00185"></a><a class="code" href="classuserrec.html#o15">00185</a>         std::string <a class="code" href="classuserrec.html#o15">recvq</a>;
+00186 
+<a name="l00189"></a><a class="code" href="classuserrec.html#o16">00189</a>         <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#o16">lines_in</a>;
+<a name="l00190"></a><a class="code" href="classuserrec.html#o17">00190</a>         time_t <a class="code" href="classuserrec.html#o17">reset_due</a>;
+<a name="l00191"></a><a class="code" href="classuserrec.html#o18">00191</a>         <span class="keywordtype">long</span> <a class="code" href="classuserrec.html#o18">threshold</a>;
+00192 
+00193         <a class="code" href="classuserrec.html#a0">userrec</a>();
+00194         
+<a name="l00195"></a><a class="code" href="classuserrec.html#a1">00195</a>         <span class="keyword">virtual</span> <a class="code" href="classuserrec.html#a1">~userrec</a>() {  }
+00196         
+00201         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a2">GetFullHost</a>();
+00202         
+00208         <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classuserrec.html#a3">GetFullRealHost</a>();
+00209         
+00212         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#a4">IsInvited</a>(<span class="keywordtype">char</span>* channel);
+00213         
+00216         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a5">InviteTo</a>(<span class="keywordtype">char</span>* channel);
+00217         
+00222         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a6">RemoveInvite</a>(<span class="keywordtype">char</span>* channel);
+00223         
+00228         <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#a7">HasPermission</a>(<span class="keywordtype">char</span>* command);
+00229 
+00237         <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#a8">AddBuffer</a>(std::string a);
+00238 
+00242         <span class="keywordtype">bool</span> <a class="code" href="classuserrec.html#a9">BufferIsReady</a>();
+00243 
+00246         <span class="keywordtype">void</span> <a class="code" href="classuserrec.html#a10">ClearBuffer</a>();
+00247 
+00255         std::string <a class="code" href="classuserrec.html#a11">GetBuffer</a>();
+00256         
+00257 };
+00258 
+00259 
+00260 <span class="preprocessor">#endif</span>
+</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sat May 7 15:34:21 2005 for InspIRCd by
 <a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border=0 
-width=110 height=53></a>1.3-rc3 </small></address>
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 
+</a>1.3.3 </small></address>
 </body>
 </html>