From 48e477893fdc3cd87b46e445b1e3e2d1395c4b94 Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 14 Dec 2005 16:07:04 +0000 Subject: Removed depreciated docs git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2420 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServerConfig.html | 230 +++++++++++++++++++++++++-------- 1 file changed, 176 insertions(+), 54 deletions(-) (limited to 'docs/module-doc/classServerConfig.html') diff --git a/docs/module-doc/classServerConfig.html b/docs/module-doc/classServerConfig.html index 7991b1f19..c359b2c7d 100644 --- a/docs/module-doc/classServerConfig.html +++ b/docs/module-doc/classServerConfig.html @@ -5,7 +5,10 @@
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members
-

ServerConfig Class Reference

#include <inspircd_io.h> +

ServerConfig Class Reference

This class holds the bulk of the runtime configuration for the ircd. +More... +

+#include <inspircd_io.h>

Inheritance diagram for ServerConfig:

Inheritance graph
@@ -22,8 +25,10 @@ Inheritance diagram for ServerConfig:

void ClearStack () + Clears the include stack in preperation for a Read() call.
void Read (bool bail, userrec *user) + Read the entire configuration into memory and initialize this class.
bool LoadConf (const char *filename, std::stringstream *target, std::stringstream *errorstream) int ConfValue (char *tag, char *var, int index, char *result, std::stringstream *config) @@ -39,89 +44,128 @@ Inheritance diagram for ServerConfig:


Public Attributes

char ServerName [MAXBUF] + Holds the server name of the local server as defined by the administrator.
char Network [MAXBUF] char ServerDesc [MAXBUF] + Holds the description of the local server as defined by the administrator.
char AdminName [MAXBUF] + Holds the admin's name, for output in the /ADMIN command.
char AdminEmail [MAXBUF] + Holds the email address of the admin, for output in the /ADMIN command.
char AdminNick [MAXBUF] + Holds the admin's nickname, for output in the /ADMIN command.
char diepass [MAXBUF] + The admin-configured /DIE password.
char restartpass [MAXBUF] + The admin-configured /RESTART password.
char motd [MAXBUF] + The pathname and filename of the message of the day file, as defined by the administrator.
char rules [MAXBUF] + The pathname and filename of the rules file, as defined by the administrator.
char PrefixQuit [MAXBUF] + The quit prefix in use, or an empty string.
char DieValue [MAXBUF] + The last string found within a <die> tag, or an empty string.
char DNSServer [MAXBUF] + The DNS server to use for DNS queries.
char DisabledCommands [MAXBUF] + This variable contains a space-seperated list of commands which are disabled by the administrator of the server for non-opers.
char ModPath [1024] + The full path to the modules directory.
char MyExecutable [1024] + The full pathname to the executable, as given in argv[0] when the program starts.
FILE * log_file + The file handle of the logfile.
bool nofork + If this value is true, the owner of the server specified -nofork on the command line, causing the daemon to stay in the foreground.
bool unlimitcore + If this value is true, the owner of the server has chosen to unlimit the coredump size to as large a value as his account settings will allow.
bool AllowHalfop + If this value is true, halfops have been enabled in the configuration file.
int dns_timeout + The number of seconds the DNS subsystem will wait before timing out any request.
int NetBufferSize + The size of the read() buffer in the user handling code, used to read data into a user's recvQ.
int MaxConn + The value to be used for listen() backlogs as default.
unsigned int SoftLimit + The soft limit value assigned to the irc server.
int MaxWhoResults + The maximum number of /WHO results allowed in any single /WHO command.
int debugging + True if the DEBUG loglevel is selected.
int LogLevel + The loglevel in use by the IRC server.
int DieDelay + How many seconds to wait before exiting the program when /DIE is correctly issued.
char addrs [MAXBUF][255] + A list of IP addresses the server is listening on.
file_cache MOTD + The MOTD file, cached in a file_cache type.
file_cache RULES + The RULES file, cached in a file_cache type.
char PID [1024] + The full pathname and filename of the PID file as defined in the configuration.
std::stringstream config_f + The parsed configuration file as a stringstream.
ClassVector Classes + The connect classes in use by the IRC server.
std::vector< std::string > module_names + A list of module names (names only, no paths) which are currently loaded by the server.

Private Member Functions

int fgets_safe (char *buffer, size_t maxsize, FILE *&file) + Used by the config file subsystem to safely read a C-style string without dependency upon any certain style of linefeed, e.g.
std::string ConfProcess (char *buffer, long linenumber, std::stringstream *errorstream, bool &error, std::string filename) + This private method processes one line of configutation, appending errors to errorstream and setting error if an error has occured.

Private Attributes

std::vector< std::string > include_stack + This variable holds the names of all files included from the main one.

Detailed Description

- +This class holds the bulk of the runtime configuration for the ircd. +

+It allows for reading new config values, accessing configuration files, and storage of the configuration data needed to run the ircd, such as the servername, connect classes, /ADMIN data, MOTDs and filenames etc.

-Definition at line 34 of file inspircd_io.h.

Constructor & Destructor Documentation

+Definition at line 39 of file inspircd_io.h.

Constructor & Destructor Documentation

@@ -174,9 +218,11 @@ Definition at line 34

+Clears the include stack in preperation for a Read() call. +

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

@@ -230,6 +276,8 @@ Referenced by ConfigReader: +

+This private method processes one line of configutation, appending errors to errorstream and setting error if an error has occured.

@@ -364,7 +412,7 @@ Referenced by userrec::HasPer

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

@@ -409,7 +457,7 @@ Referenced by ConfigReader:

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

@@ -452,7 +500,9 @@ Referenced by ConfigReader:

- +Used by the config file subsystem to safely read a C-style string without dependency upon any certain style of linefeed, e.g. +

+it can read both windows and UNIX style linefeeds transparently.

@@ -497,7 +547,7 @@ Referenced by ConfigReader:

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

@@ -534,7 +584,9 @@ Referenced by ConfigReader:

- +Read the entire configuration into memory and initialize this class. +

+All other methods should be used only by the core.

Referenced by Server::RehashServer(). @@ -593,7 +645,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

@@ -617,9 +669,11 @@ Referenced by ConfigReader:

+A list of IP addresses the server is listening on. +

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

@@ -642,9 +696,11 @@ Definition at line 70

+Holds the email address of the admin, for output in the /ADMIN command. +

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

@@ -667,9 +723,11 @@ Definition at line 46

+Holds the admin's name, for output in the /ADMIN command. +

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

@@ -692,9 +750,11 @@ Definition at line 45

+Holds the admin's nickname, for output in the /ADMIN command. +

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

@@ -717,9 +777,11 @@ Definition at line 47

+If this value is true, halfops have been enabled in the configuration file. +

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

@@ -742,9 +804,11 @@ Definition at line 61

+The connect classes in use by the IRC server. +

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

@@ -767,9 +831,11 @@ Definition at line 75

- +The parsed configuration file as a stringstream.

-Definition at line 74 of file inspircd_io.h. +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.

Referenced by userrec::HasPermission(). @@ -794,9 +860,11 @@ Referenced by userrec::HasPer

+True if the DEBUG loglevel is selected. +

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

@@ -819,9 +887,11 @@ Definition at line 67

+How many seconds to wait before exiting the program when /DIE is correctly issued. +

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

@@ -844,9 +914,11 @@ Definition at line 69

+The admin-configured /DIE password. +

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

@@ -869,9 +941,11 @@ Definition at line 48

+The last string found within a <die> tag, or an empty string. +

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

@@ -894,9 +968,11 @@ Definition at line 53

+This variable contains a space-seperated list of commands which are disabled by the administrator of the server for non-opers. +

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

@@ -919,9 +995,11 @@ Definition at line 55

+The number of seconds the DNS subsystem will wait before timing out any request. +

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

@@ -944,9 +1022,11 @@ Definition at line 62

+The DNS server to use for DNS queries. +

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

@@ -969,9 +1049,11 @@ Definition at line 54

- +This variable holds the names of all files included from the main one.

-Definition at line 37 of file inspircd_io.h. +This is used to make sure that no files are recursively included. +

+Definition at line 47 of file inspircd_io.h.

@@ -994,9 +1076,11 @@ Definition at line 37

- +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 58 of file inspircd_io.h. +Definition at line 151 of file inspircd_io.h.

@@ -1019,9 +1103,11 @@ Definition at line 58

+The loglevel in use by the IRC server. +

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

@@ -1044,9 +1130,11 @@ Definition at line 68

+The value to be used for listen() backlogs as default. +

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

@@ -1069,9 +1157,11 @@ Definition at line 64

+The maximum number of /WHO results allowed in any single /WHO command. +

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

@@ -1094,9 +1184,11 @@ Definition at line 66

- +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 56 of file inspircd_io.h. +Definition at line 138 of file inspircd_io.h.

@@ -1119,11 +1211,13 @@ Definition at line 56

+A list of module names (names only, no paths) which are currently loaded by the server. +

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

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

@@ -1146,9 +1240,11 @@ Referenced by Server::FindM

+The MOTD file, cached in a file_cache type. +

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

@@ -1171,9 +1267,11 @@ Definition at line 71

+The pathname and filename of the message of the day file, as defined by the administrator. +

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

@@ -1196,9 +1294,11 @@ Definition at line 50

+The full pathname to the executable, as given in argv[0] when the program starts. +

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

@@ -1221,9 +1321,11 @@ Definition at line 57

+The size of the read() buffer in the user handling code, used to read data into a user's recvQ. +

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

@@ -1248,7 +1350,7 @@ Definition at line 63

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

@@ -1271,9 +1373,11 @@ Definition at line 43

+If this value is true, the owner of the server specified -nofork on the command line, causing the daemon to stay in the foreground. +

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

@@ -1296,9 +1400,11 @@ Definition at line 59

+The full pathname and filename of the PID file as defined in the configuration. +

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

@@ -1321,9 +1427,11 @@ Definition at line 73

+The quit prefix in use, or an empty string. +

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

@@ -1346,9 +1454,11 @@ Definition at line 52

+The admin-configured /RESTART password. +

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

@@ -1371,9 +1481,11 @@ Definition at line 49

+The RULES file, cached in a file_cache type. +

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

@@ -1396,9 +1508,11 @@ Definition at line 72

+The pathname and filename of the rules file, as defined by the administrator. +

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

@@ -1421,9 +1535,11 @@ Definition at line 51

+Holds the description of the local server as defined by the administrator. +

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

@@ -1446,9 +1562,11 @@ Definition at line 44

+Holds the server name of the local server as defined by the administrator. +

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

Referenced by userrec::userrec(). @@ -1473,9 +1591,11 @@ Referenced by userrec::userre

- +The soft limit value assigned to the irc server.

-Definition at line 65 of file inspircd_io.h. +The IRC server will not allow more than this number of local users. +

+Definition at line 193 of file inspircd_io.h.

@@ -1498,14 +1618,16 @@ Definition at line 65

- +If this value is true, the owner of the server has chosen to unlimit the coredump size to as large a value as his account settings will allow. +

+This is often used when debugging.

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

The documentation for this class was generated from the following file: -
Generated on Wed Dec 14 14:49:34 2005 for InspIRCd by  +
Generated on Wed Dec 14 15:55:51 2005 for InspIRCd by  doxygen 1.4.4-20050815
-- cgit v1.3.1-10-gc9f91