From 71bedf497cde8b0b38afbb366828b3df9c2803d6 Mon Sep 17 00:00:00 2001 From: brain Date: Mon, 19 Dec 2005 18:04:22 +0000 Subject: git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2578 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServerConfig.html | 247 +++++++++++++++++++++++++-------- 1 file changed, 192 insertions(+), 55 deletions(-) (limited to 'docs/module-doc/classServerConfig.html') diff --git a/docs/module-doc/classServerConfig.html b/docs/module-doc/classServerConfig.html index 990abb166..28c2a00f4 100644 --- a/docs/module-doc/classServerConfig.html +++ b/docs/module-doc/classServerConfig.html @@ -16,7 +16,7 @@ Inheritance diagram for ServerConfig:

[legend]
Collaboration diagram for ServerConfig:

Collaboration graph
- +
[legend]
List of all members. @@ -41,6 +41,12 @@ Inheritance diagram for ServerConfig:

int 
+ + + + + + @@ -149,6 +155,9 @@ Inheritance diagram for ServerConfig:

int 
+ + + @@ -168,7 +177,7 @@ It allows for reading new config values, accessing configuration files, and stor

-Definition at line 39 of file inspircd_io.h.


Constructor & Destructor Documentation

+Definition at line 40 of file inspircd_io.h.

Constructor & Destructor Documentation

EnumValues (std::stringstream *config, const char *tag, int index)
ModuleGetIOHook (int port)
bool AddIOHook (int port, Module *iomod)
bool DelIOHook (int port)

Public Attributes

char ServerName [MAXBUF]
ports [255]
 A list of ports which the server is listening on.
std::map< int, Module * > IOHookModule
 A list of ports claimed by IO Modules.

Private Member Functions

int fgets_safe (char *buffer, size_t maxsize, FILE *&file)
@@ -197,6 +206,43 @@ Definition at line 39

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
bool ServerConfig::AddIOHook int  port,
Module iomod
+
+ + + + + +
+   + + +

+

@@ -225,7 +271,7 @@ Clears the include stack in preperation for a ConfigReader::ConfigReader(). +Referenced by ConfigReader::ConfigReader().

@@ -339,7 +385,7 @@ This private method processes one line of configutation, appending errors to err

-Referenced by userrec::HasPermission(). +Referenced by userrec::HasPermission().

@@ -375,6 +421,34 @@ Referenced by userrec::HasPer +

+ + + +

+ + + + +
+ + + + + + + + + +
bool ServerConfig::DelIOHook int  port  ) 
+
+ + + + @@ -415,7 +489,7 @@ Referenced by userrec::HasPer

-Referenced by ConfigReader::Enumerate(). +Referenced by ConfigReader::Enumerate().

+   + +

@@ -460,7 +534,7 @@ Referenced by ConfigReader:

-Referenced by ConfigReader::EnumerateValues(). +Referenced by ConfigReader::EnumerateValues().

@@ -508,6 +582,36 @@ Used by the config file subsystem to safely read a C-style string without depend it can read both windows and UNIX style linefeeds transparently. +

+ + + + +
+ + + + + + + + + +
Module* ServerConfig::GetIOHook int  port  ) 
+
+ + + + + +
+   + + +

+ +

+Referenced by kill_link(), and kill_link_silent().

@@ -550,7 +654,7 @@ it can read both windows and UNIX style linefeeds transparently.

-Referenced by ConfigReader::ConfigReader(). +Referenced by ConfigReader::ConfigReader().

@@ -591,7 +695,7 @@ Read the entire configuration into memory and initialize this class.

All other methods should be used only by the core.

-Referenced by Server::RehashServer(). +Referenced by Server::RehashServer().

@@ -648,7 +752,7 @@ Referenced by Server::Rehas

-Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue(). +Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue().


Member Data Documentation

@@ -676,7 +780,7 @@ A list of IP addresses the server is listening on.

-Definition at line 216 of file inspircd_io.h. +Definition at line 217 of file inspircd_io.h.

@@ -703,9 +807,9 @@ Holds the email address of the admin, for output in the /ADMIN command.

-Definition at line 89 of file inspircd_io.h. +Definition at line 90 of file inspircd_io.h.

-Referenced by Server::GetAdmin(). +Referenced by Server::GetAdmin().

@@ -732,9 +836,9 @@ Holds the admin's name, for output in the /ADMIN command.

-Definition at line 84 of file inspircd_io.h. +Definition at line 85 of file inspircd_io.h.

-Referenced by Server::GetAdmin(). +Referenced by Server::GetAdmin().

@@ -761,9 +865,9 @@ Holds the admin's nickname, for output in the /ADMIN command.

-Definition at line 94 of file inspircd_io.h. +Definition at line 95 of file inspircd_io.h.

-Referenced by Server::GetAdmin(). +Referenced by Server::GetAdmin().

@@ -790,7 +894,7 @@ If this value is true, halfops have been enabled in the configuration file.

-Definition at line 171 of file inspircd_io.h. +Definition at line 172 of file inspircd_io.h.

@@ -817,7 +921,9 @@ The connect classes in use by the IRC server.

-Definition at line 242 of file inspircd_io.h. +Definition at line 243 of file inspircd_io.h. +

+Referenced by AddClient().

@@ -844,9 +950,9 @@ The parsed configuration file as a stringstream.

You should pass this to any configuration methods of this class, and not access it directly. It is recommended that modules use ConfigReader instead which provides a simpler abstraction of configuration files.

-Definition at line 238 of file inspircd_io.h. +Definition at line 239 of file inspircd_io.h.

-Referenced by userrec::HasPermission(). +Referenced by userrec::HasPermission().

@@ -873,7 +979,7 @@ True if the DEBUG loglevel is selected.

-Definition at line 202 of file inspircd_io.h. +Definition at line 203 of file inspircd_io.h.

@@ -900,7 +1006,7 @@ How many seconds to wait before exiting the program when /DIE is correctly issue

-Definition at line 211 of file inspircd_io.h. +Definition at line 212 of file inspircd_io.h.

@@ -927,7 +1033,7 @@ The admin-configured /DIE password.

-Definition at line 98 of file inspircd_io.h. +Definition at line 99 of file inspircd_io.h.

@@ -954,7 +1060,7 @@ The last string found within a <die> tag, or an empty string.

-Definition at line 121 of file inspircd_io.h. +Definition at line 122 of file inspircd_io.h.

@@ -981,7 +1087,7 @@ This variable contains a space-seperated list of commands which are disabled by

-Definition at line 131 of file inspircd_io.h. +Definition at line 132 of file inspircd_io.h.

@@ -1008,7 +1114,9 @@ The number of seconds the DNS subsystem w

-Definition at line 176 of file inspircd_io.h. +Definition at line 177 of file inspircd_io.h. +

+Referenced by AddClient().

@@ -1035,7 +1143,7 @@ The DNS server to use for

-Definition at line 125 of file inspircd_io.h. +Definition at line 126 of file inspircd_io.h.

@@ -1062,7 +1170,34 @@ This variable holds the names of all files included from the main one.

This is used to make sure that no files are recursively included.

-Definition at line 47 of file inspircd_io.h. +Definition at line 48 of file inspircd_io.h. + + +

+ + + + +
+ + + + +
std::map<int,Module*> ServerConfig::IOHookModule
+
+ + + +
+   + + +

+A list of ports claimed by IO Modules. +

+ +

+Definition at line 256 of file inspircd_io.h.

@@ -1089,7 +1224,7 @@ The file handle of the logfile.

If this value is NULL, the log file is not open, probably due to a permissions error on startup (this should not happen in normal operation!).

-Definition at line 151 of file inspircd_io.h. +Definition at line 152 of file inspircd_io.h.

@@ -1116,7 +1251,7 @@ The loglevel in use by the IRC server.

-Definition at line 206 of file inspircd_io.h. +Definition at line 207 of file inspircd_io.h.

@@ -1143,7 +1278,7 @@ The value to be used for listen() backlogs as default.

-Definition at line 187 of file inspircd_io.h. +Definition at line 188 of file inspircd_io.h.

@@ -1170,7 +1305,7 @@ The maximum number of /WHO results allowed in any single /WHO command.

-Definition at line 198 of file inspircd_io.h. +Definition at line 199 of file inspircd_io.h.

@@ -1197,7 +1332,7 @@ The full path to the modules directory.

This is either set at compile time, or overridden in the configuration file via the <options> tag.

-Definition at line 138 of file inspircd_io.h. +Definition at line 139 of file inspircd_io.h.

@@ -1224,9 +1359,9 @@ A list of module names (names only, no paths) which are currently loaded by the

-Definition at line 247 of file inspircd_io.h. +Definition at line 248 of file inspircd_io.h.

-Referenced by Server::FindModule(). +Referenced by Server::FindModule().

@@ -1253,7 +1388,7 @@ The MOTD file, cached in a file_cache type.

-Definition at line 220 of file inspircd_io.h. +Definition at line 221 of file inspircd_io.h.

@@ -1280,7 +1415,7 @@ The pathname and filename of the message of the day file, as defined by the admi

-Definition at line 107 of file inspircd_io.h. +Definition at line 108 of file inspircd_io.h.

@@ -1307,7 +1442,7 @@ The full pathname to the executable, as given in argv[0] when the program starts

-Definition at line 143 of file inspircd_io.h. +Definition at line 144 of file inspircd_io.h.

@@ -1334,7 +1469,7 @@ The size of the read() buffer in the user handling code, used to read data into

-Definition at line 182 of file inspircd_io.h. +Definition at line 183 of file inspircd_io.h.

@@ -1359,9 +1494,9 @@ Definition at line 182

-Definition at line 74 of file inspircd_io.h. +Definition at line 75 of file inspircd_io.h.

-Referenced by Server::GetNetworkName(). +Referenced by FullConnectUser(), and Server::GetNetworkName().

@@ -1388,7 +1523,7 @@ If this value is true, the owner of the server specified -nofork on the command

-Definition at line 158 of file inspircd_io.h. +Definition at line 159 of file inspircd_io.h.

@@ -1415,7 +1550,7 @@ The full pathname and filename of the PID file as defined in the configuration.

-Definition at line 229 of file inspircd_io.h. +Definition at line 230 of file inspircd_io.h.

@@ -1442,7 +1577,7 @@ A list of ports which the server is listening on.

-Definition at line 251 of file inspircd_io.h. +Definition at line 252 of file inspircd_io.h.

@@ -1469,7 +1604,7 @@ The quit prefix in use, or an empty string.

-Definition at line 116 of file inspircd_io.h. +Definition at line 117 of file inspircd_io.h.

@@ -1496,7 +1631,7 @@ The admin-configured /RESTART password.

-Definition at line 102 of file inspircd_io.h. +Definition at line 103 of file inspircd_io.h.

@@ -1523,7 +1658,7 @@ The RULES file, cached in a file_cache type.

-Definition at line 224 of file inspircd_io.h. +Definition at line 225 of file inspircd_io.h.

@@ -1550,7 +1685,7 @@ The pathname and filename of the rules file, as defined by the administrator.

-Definition at line 112 of file inspircd_io.h. +Definition at line 113 of file inspircd_io.h.

@@ -1577,9 +1712,9 @@ Holds the description of the local server as defined by the administrator.

-Definition at line 79 of file inspircd_io.h. +Definition at line 80 of file inspircd_io.h.

-Referenced by Server::GetServerDescription(). +Referenced by Server::GetServerDescription().

@@ -1606,9 +1741,9 @@ Holds the server name of the local server as defined by the administrator.

-Definition at line 68 of file inspircd_io.h. +Definition at line 69 of file inspircd_io.h.

-Referenced by Server::GetServerName(), and userrec::userrec(). +Referenced by AddClient(), FullConnectUser(), Server::GetServerName(), and userrec::userrec().

@@ -1635,7 +1770,9 @@ The soft limit value assigned to the irc server.

The IRC server will not allow more than this number of local users.

-Definition at line 193 of file inspircd_io.h. +Definition at line 194 of file inspircd_io.h. +

+Referenced by AddClient().

@@ -1662,12 +1799,12 @@ If this value is true, the owner of the server has chosen to unlimit the coredum

This is often used when debugging.

-Definition at line 166 of file inspircd_io.h. +Definition at line 167 of file inspircd_io.h.


The documentation for this class was generated from the following file: -
Generated on Thu Dec 15 11:14:19 2005 for InspIRCd by  +
Generated on Mon Dec 19 18:02:16 2005 for InspIRCd by  doxygen 1.4.4-20050815
-- cgit v1.2.3