docs/module-doc/annotated.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>InspIRCd: Class List</title>
<link href="inspircd.doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.4-20050815 -->
<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="qindexHL" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
<h1>InspIRCd Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table>
  <tr><td class="indexkey"><a class="el" href="classAdmin.html">Admin</a></td><td class="indexvalue">Holds /ADMIN data This class contains the admin details of the local server </td></tr>
  <tr><td class="indexkey"><a class="el" href="classBanItem.html">BanItem</a></td><td class="indexvalue">A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to hold channel bans (+b) </td></tr>
  <tr><td class="indexkey"><a class="el" href="classBoolSet.html">BoolSet</a></td><td class="indexvalue">BoolSet is a utility class designed to hold eight bools in a bitmask </td></tr>
  <tr><td class="indexkey"><a class="el" href="classchanrec.html">chanrec</a></td><td class="indexvalue">Holds all relevent information for a channel </td></tr>
  <tr><td class="indexkey"><a class="el" href="classstd_1_1char__traits.html">char_traits</a></td><td class="indexvalue"></td></tr>
  <tr><td class="indexkey"><a class="el" href="classclassbase.html">classbase</a></td><td class="indexvalue">The base class for all inspircd classes </td></tr>
  <tr><td class="indexkey"><a class="el" href="classcommand__t.html">command_t</a></td><td class="indexvalue">A structure that defines a command </td></tr>
  <tr><td class="indexkey"><a class="el" href="classConfigReader.html">ConfigReader</a></td><td class="indexvalue">Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file </td></tr>
  <tr><td class="indexkey"><a class="el" href="classConnectClass.html">ConnectClass</a></td><td class="indexvalue">Holds information relevent to &lt;connect allow&gt; and &lt;connect deny&gt; tags in the config file </td></tr>
  <tr><td class="indexkey"><a class="el" href="classconnection.html">connection</a></td><td class="indexvalue">Please note: classes serverrec and userrec both inherit from class connection </td></tr>
  <tr><td class="indexkey"><a class="el" href="classCullItem.html">CullItem</a></td><td class="indexvalue">Holds a user and their quitmessage, and is used internally by the <a class="el" href="classCullList.html">CullList</a> class to compile a list of users which are to be culled when a long operation (such as a netsplit) has completed </td></tr>
  <tr><td class="indexkey"><a class="el" href="classCullList.html">CullList</a></td><td class="indexvalue">Can be used by modules, and is used by the core, to compile large lists of users in preperation to quitting them all at once </td></tr>
  <tr><td class="indexkey"><a class="el" href="classDNS.html">DNS</a></td><td class="indexvalue">Allows fast nonblocking resolution of hostnames and ip addresses </td></tr>
  <tr><td class="indexkey"><a class="el" href="structdns__ip4list.html">dns_ip4list</a></td><td class="indexvalue"></td></tr>
  <tr><td class="indexkey"><a class="el" href="classELine.html">ELine</a></td><td class="indexvalue"></td></tr>
  <tr><td class="indexkey"><a class="el" href="classEvent.html">Event</a></td><td class="indexvalue">Unicast message directed at all modules </td></tr>
  <tr><td class="indexkey"><a class="el" href="classExemptItem.html">ExemptItem</a></td><td class="indexvalue">A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to hold channel exempts (+e) </td></tr>
  <tr><td class="indexkey"><a class="el" href="classExtensible.html">Extensible</a></td><td class="indexvalue">Class Extensible is the parent class of many classes such as userrec and chanrec </td></tr>
  <tr><td class="indexkey"><a class="el" href="classExtMode.html">ExtMode</a></td><td class="indexvalue">Holds an extended mode's details </td></tr>
  <tr><td class="indexkey"><a class="el" href="classFileReader.html">FileReader</a></td><td class="indexvalue">Caches a text file into memory and can be used to retrieve lines from it </td></tr>
  <tr><td class="indexkey"><a class="el" href="classGLine.html">GLine</a></td><td class="indexvalue">GLine class </td></tr>
  <tr><td class="indexkey"><a class="el" href="structnspace_1_1hash_3_01in__addr_01_4.html">nspace::hash&lt; in_addr &gt;</a></td><td class="indexvalue"></td></tr>
  <tr><td class="indexkey"><a class="el" href="structnspace_1_1hash_3_01string_01_4.html">nspace::hash&lt; string &gt;</a></td><td class="indexvalue"></td></tr>
  <tr><td class="indexkey"><a class="el" href="classHostItem.html">HostItem</a></td><td class="indexvalue">Holds an entry for a ban list, exemption list, or invite list </td></tr>
  <tr><td class="indexkey"><a class="el" href="structirc_1_1InAddr__HashComp.html">irc::InAddr_HashComp</a></td><td class="indexvalue">This class returns true if two in_addr structs match </td></tr>
  <tr><td class="indexkey"><a class="el" href="classInspIRCd.html">InspIRCd</a></td><td class="indexvalue"></td></tr>
  <tr><td class="indexkey"><a class="el" href="classInspSocket.html">InspSocket</a></td><td class="indexvalue">InspSocket is an extendable socket class which modules can use for TCP socket support </td></tr>
  <tr><td class="indexkey"><a class="el" href="classInvited.html">Invited</a></td><td class="indexvalue">Holds a channel name to which a user has been invited </td></tr>
  <tr><td class="indexkey"><a class="el" href="classInviteItem.html">InviteItem</a></td><td class="indexvalue">A subclass of <a class="el" href="classHostItem.html">HostItem</a> designed to hold channel invites (+I) </td></tr>
  <tr><td class="indexkey"><a class="el" href="structirc_1_1irc__char__traits.html">irc::irc_char_traits</a></td><td class="indexvalue">The <a class="el" href="structirc_1_1irc__char__traits.html">irc_char_traits</a> class is used for RFC-style comparison of strings </td></tr>
  <tr><td class="indexkey"><a class="el" href="classKLine.html">KLine</a></td><td class="indexvalue">KLine class </td></tr>
  <tr><td class="indexkey"><a class="el" href="classModeParameter.html">ModeParameter</a></td><td class="indexvalue">Holds a custom parameter to a module-defined channel mode e.g </td></tr>
  <tr><td class="indexkey"><a class="el" href="classModule.html">Module</a></td><td class="indexvalue">Base class for all <a class="el" href="classInspIRCd.html">InspIRCd</a> modules This class is the base class for <a class="el" href="classInspIRCd.html">InspIRCd</a> modules </td></tr>
  <tr><td class="indexkey"><a class="el" href="classModuleFactory.html">ModuleFactory</a></td><td class="indexvalue">Instantiates classes inherited from <a class="el" href="classModule.html">Module</a> This class creates a class inherited from type <a class="el" href="classModule.html">Module</a>, using new </td></tr>
  <tr><td class="indexkey"><a class="el" href="classModuleMessage.html">ModuleMessage</a></td><td class="indexvalue">Base class of <a class="el" href="classRequest.html">Request</a> and <a class="el" href="classEvent.html">Event</a> This class is used to represent a basic data structure which is passed between modules for safe inter-module communications </td></tr>
  <tr><td class="indexkey"><a class="el" href="classQLine.html">QLine</a></td><td class="indexvalue">QLine class </td></tr>
  <tr><td class="indexkey"><a class="el" href="classRequest.html">Request</a></td><td class="indexvalue">Unicast message directed at a given module </td></tr>
  <tr><td class="indexkey"><a class="el" href="classServer.html">Server</a></td><td class="indexvalue">Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers </td></tr>
  <tr><td class="indexkey"><a class="el" href="classServerConfig.html">ServerConfig</a></td><td class="indexvalue">This class holds the bulk of the runtime configuration for the ircd </td></tr>
  <tr><td class="indexkey"><a class="el" href="classserverstats.html">serverstats</a></td><td class="indexvalue"></td></tr>
  <tr><td class="indexkey"><a class="el" href="classSocketEngine.html">SocketEngine</a></td><td class="indexvalue">The actual socketengine class presents the same interface on all operating systems, but its private members and internal behaviour should be treated as blackboxed, and vary from system to system and upon the config settings chosen by the server admin </td></tr>
  <tr><td class="indexkey"><a class="el" href="structirc_1_1StrHashComp.html">irc::StrHashComp</a></td><td class="indexvalue">This class returns true if two strings match </td></tr>
  <tr><td class="indexkey"><a class="el" href="classucrec.html">ucrec</a></td><td class="indexvalue">Holds a user's modes on a channel This class associates a users privilages with a channel by creating a pointer link between a userrec and chanrec class </td></tr>
  <tr><td class="indexkey"><a class="el" href="classuserrec.html">userrec</a></td><td class="indexvalue">Holds all information about a user This class stores all information about a user connected to the irc server </td></tr>
  <tr><td class="indexkey"><a class="el" href="classVersion.html">Version</a></td><td class="indexvalue">Holds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module </td></tr>
  <tr><td class="indexkey"><a class="el" href="classWhoWasUser.html">WhoWasUser</a></td><td class="indexvalue">A lightweight userrec used by WHOWAS </td></tr>
  <tr><td class="indexkey"><a class="el" href="classXLine.html">XLine</a></td><td class="indexvalue">XLine is the base class for ban lines such as G lines and K lines </td></tr>
  <tr><td class="indexkey"><a class="el" href="classZLine.html">ZLine</a></td><td class="indexvalue">ZLine class </td></tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Thu Dec 15 11:14:17 2005 for InspIRCd by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address>
</body>
</html>