diff options
Diffstat (limited to 'docs/man/man3/ServerConfig.3')
| -rw-r--r-- | docs/man/man3/ServerConfig.3 | 113 |
1 files changed, 72 insertions, 41 deletions
diff --git a/docs/man/man3/ServerConfig.3 b/docs/man/man3/ServerConfig.3 index 445d8b097..e35314eae 100644 --- a/docs/man/man3/ServerConfig.3 +++ b/docs/man/man3/ServerConfig.3 @@ -1,4 +1,4 @@ -.TH "ServerConfig" 3 "15 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*- +.TH "ServerConfig" 3 "19 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -44,6 +44,15 @@ Inherits \fBclassbase\fP. .ti -1c .RI "int \fBEnumValues\fP (std::stringstream *config, const char *tag, int index)" .br +.ti -1c +.RI "\fBModule\fP * \fBGetIOHook\fP (int port)" +.br +.ti -1c +.RI "bool \fBAddIOHook\fP (int port, \fBModule\fP *iomod)" +.br +.ti -1c +.RI "bool \fBDelIOHook\fP (int port)" +.br .in -1c .SS "Public Attributes" @@ -191,6 +200,10 @@ Inherits \fBclassbase\fP. .RI "int \fBports\fP [255]" .br .RI "\fIA list of ports which the server is listening on. \fP" +.ti -1c +.RI "std::map< int, \fBModule\fP * > \fBIOHookModule\fP" +.br +.RI "\fIA list of ports claimed by IO Modules. \fP" .in -1c .SS "Private Member Functions" @@ -218,13 +231,15 @@ 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. .PP -Definition at line 39 of file inspircd_io.h. +Definition at line 40 of file inspircd_io.h. .SH "Constructor & Destructor Documentation" .PP .SS "ServerConfig::ServerConfig ()" .PP .SH "Member Function Documentation" .PP +.SS "bool ServerConfig::AddIOHook (int port, \fBModule\fP * iomod)" +.PP .SS "void ServerConfig::ClearStack ()" .PP Clears the include stack in preperation for a \fBRead()\fP call. @@ -239,6 +254,8 @@ This private method processes one line of configutation, appending errors to err Referenced by userrec::HasPermission(). .SS "int ServerConfig::ConfValueEnum (char * tag, std::stringstream * config)" .PP +.SS "bool ServerConfig::DelIOHook (int port)" +.PP .SS "int ServerConfig::EnumConf (std::stringstream * config_f, const char * tag)" .PP Referenced by ConfigReader::Enumerate(). @@ -250,6 +267,9 @@ Referenced by ConfigReader::EnumerateValues(). Used by the config file subsystem to safely read a C-style string without dependency upon any certain style of linefeed, e.g. .PP it can read both windows and UNIX style linefeeds transparently. +.SS "\fBModule\fP* ServerConfig::GetIOHook (int port)" +.PP +Referenced by kill_link(), and kill_link_silent(). .SS "bool ServerConfig::LoadConf (const char * filename, std::stringstream * target, std::stringstream * errorstream)" .PP Referenced by ConfigReader::ConfigReader(). @@ -269,213 +289,224 @@ Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigR .PP A list of IP addresses the server is listening on. .PP -Definition at line 216 of file inspircd_io.h. +Definition at line 217 of file inspircd_io.h. .SS "char \fBServerConfig::AdminEmail\fP[MAXBUF]" .PP Holds the email address of the admin, for output in the /ADMIN command. .PP -Definition at line 89 of file inspircd_io.h. +Definition at line 90 of file inspircd_io.h. .PP Referenced by Server::GetAdmin(). .SS "char \fBServerConfig::AdminName\fP[MAXBUF]" .PP Holds the admin's name, for output in the /ADMIN command. .PP -Definition at line 84 of file inspircd_io.h. +Definition at line 85 of file inspircd_io.h. .PP Referenced by Server::GetAdmin(). .SS "char \fBServerConfig::AdminNick\fP[MAXBUF]" .PP Holds the admin's nickname, for output in the /ADMIN command. .PP -Definition at line 94 of file inspircd_io.h. +Definition at line 95 of file inspircd_io.h. .PP Referenced by Server::GetAdmin(). .SS "bool \fBServerConfig::AllowHalfop\fP" .PP If this value is true, halfops have been enabled in the configuration file. .PP -Definition at line 171 of file inspircd_io.h. +Definition at line 172 of file inspircd_io.h. .SS "\fBClassVector\fP \fBServerConfig::Classes\fP" .PP The connect classes in use by the IRC server. .PP -Definition at line 242 of file inspircd_io.h. +Definition at line 243 of file inspircd_io.h. +.PP +Referenced by AddClient(). .SS "std::stringstream \fBServerConfig::config_f\fP" .PP The parsed configuration file as a stringstream. .PP You should pass this to any configuration methods of this class, and not access it directly. It is recommended that modules use \fBConfigReader\fP instead which provides a simpler abstraction of configuration files. .PP -Definition at line 238 of file inspircd_io.h. +Definition at line 239 of file inspircd_io.h. .PP Referenced by userrec::HasPermission(). .SS "int \fBServerConfig::debugging\fP" .PP True if the DEBUG loglevel is selected. .PP -Definition at line 202 of file inspircd_io.h. +Definition at line 203 of file inspircd_io.h. .SS "int \fBServerConfig::DieDelay\fP" .PP How many seconds to wait before exiting the program when /DIE is correctly issued. .PP -Definition at line 211 of file inspircd_io.h. +Definition at line 212 of file inspircd_io.h. .SS "char \fBServerConfig::diepass\fP[MAXBUF]" .PP The admin-configured /DIE password. .PP -Definition at line 98 of file inspircd_io.h. +Definition at line 99 of file inspircd_io.h. .SS "char \fBServerConfig::DieValue\fP[MAXBUF]" .PP The last string found within a <die> tag, or an empty string. .PP -Definition at line 121 of file inspircd_io.h. +Definition at line 122 of file inspircd_io.h. .SS "char \fBServerConfig::DisabledCommands\fP[MAXBUF]" .PP This variable contains a space-seperated list of commands which are disabled by the administrator of the server for non-opers. .PP -Definition at line 131 of file inspircd_io.h. +Definition at line 132 of file inspircd_io.h. .SS "int \fBServerConfig::dns_timeout\fP" .PP The number of seconds the \fBDNS\fP subsystem will wait before timing out any request. .PP -Definition at line 176 of file inspircd_io.h. +Definition at line 177 of file inspircd_io.h. +.PP +Referenced by AddClient(). .SS "char \fBServerConfig::DNSServer\fP[MAXBUF]" .PP The \fBDNS\fP server to use for \fBDNS\fP queries. .PP -Definition at line 125 of file inspircd_io.h. +Definition at line 126 of file inspircd_io.h. .SS "std::vector<\fBstd::string\fP> \fBServerConfig::include_stack\fP\fC [private]\fP" .PP This variable holds the names of all files included from the main one. .PP This is used to make sure that no files are recursively included. .PP -Definition at line 47 of file inspircd_io.h. +Definition at line 48 of file inspircd_io.h. +.SS "std::map<int,\fBModule\fP*> \fBServerConfig::IOHookModule\fP" +.PP +A list of ports claimed by IO Modules. +.PP +Definition at line 256 of file inspircd_io.h. .SS "FILE* \fBServerConfig::log_file\fP" .PP The file handle of the logfile. .PP 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!). .PP -Definition at line 151 of file inspircd_io.h. +Definition at line 152 of file inspircd_io.h. .SS "int \fBServerConfig::LogLevel\fP" .PP The loglevel in use by the IRC server. .PP -Definition at line 206 of file inspircd_io.h. +Definition at line 207 of file inspircd_io.h. .SS "int \fBServerConfig::MaxConn\fP" .PP The value to be used for listen() backlogs as default. .PP -Definition at line 187 of file inspircd_io.h. +Definition at line 188 of file inspircd_io.h. .SS "int \fBServerConfig::MaxWhoResults\fP" .PP The maximum number of /WHO results allowed in any single /WHO command. .PP -Definition at line 198 of file inspircd_io.h. +Definition at line 199 of file inspircd_io.h. .SS "char \fBServerConfig::ModPath\fP[1024]" .PP The full path to the modules directory. .PP This is either set at compile time, or overridden in the configuration file via the <options> tag. .PP -Definition at line 138 of file inspircd_io.h. +Definition at line 139 of file inspircd_io.h. .SS "std::vector<\fBstd::string\fP> \fBServerConfig::module_names\fP" .PP A list of module names (names only, no paths) which are currently loaded by the server. .PP -Definition at line 247 of file inspircd_io.h. +Definition at line 248 of file inspircd_io.h. .PP Referenced by Server::FindModule(). .SS "\fBfile_cache\fP \fBServerConfig::MOTD\fP" .PP The MOTD file, cached in a file_cache type. .PP -Definition at line 220 of file inspircd_io.h. +Definition at line 221 of file inspircd_io.h. .SS "char \fBServerConfig::motd\fP[MAXBUF]" .PP The pathname and filename of the message of the day file, as defined by the administrator. .PP -Definition at line 107 of file inspircd_io.h. +Definition at line 108 of file inspircd_io.h. .SS "char \fBServerConfig::MyExecutable\fP[1024]" .PP The full pathname to the executable, as given in argv[0] when the program starts. .PP -Definition at line 143 of file inspircd_io.h. +Definition at line 144 of file inspircd_io.h. .SS "int \fBServerConfig::NetBufferSize\fP" .PP The size of the read() buffer in the user handling code, used to read data into a user's recvQ. .PP -Definition at line 182 of file inspircd_io.h. +Definition at line 183 of file inspircd_io.h. .SS "char \fBServerConfig::Network\fP[MAXBUF]" .PP -Definition at line 74 of file inspircd_io.h. +Definition at line 75 of file inspircd_io.h. .PP -Referenced by Server::GetNetworkName(). +Referenced by FullConnectUser(), and Server::GetNetworkName(). .SS "bool \fBServerConfig::nofork\fP" .PP If this value is true, the owner of the server specified -nofork on the command line, causing the daemon to stay in the foreground. .PP -Definition at line 158 of file inspircd_io.h. +Definition at line 159 of file inspircd_io.h. .SS "char \fBServerConfig::PID\fP[1024]" .PP The full pathname and filename of the PID file as defined in the configuration. .PP -Definition at line 229 of file inspircd_io.h. +Definition at line 230 of file inspircd_io.h. .SS "int \fBServerConfig::ports\fP[255]" .PP A list of ports which the server is listening on. .PP -Definition at line 251 of file inspircd_io.h. +Definition at line 252 of file inspircd_io.h. .SS "char \fBServerConfig::PrefixQuit\fP[MAXBUF]" .PP The quit prefix in use, or an empty string. .PP -Definition at line 116 of file inspircd_io.h. +Definition at line 117 of file inspircd_io.h. .SS "char \fBServerConfig::restartpass\fP[MAXBUF]" .PP The admin-configured /RESTART password. .PP -Definition at line 102 of file inspircd_io.h. +Definition at line 103 of file inspircd_io.h. .SS "\fBfile_cache\fP \fBServerConfig::RULES\fP" .PP The RULES file, cached in a file_cache type. .PP -Definition at line 224 of file inspircd_io.h. +Definition at line 225 of file inspircd_io.h. .SS "char \fBServerConfig::rules\fP[MAXBUF]" .PP The pathname and filename of the rules file, as defined by the administrator. .PP -Definition at line 112 of file inspircd_io.h. +Definition at line 113 of file inspircd_io.h. .SS "char \fBServerConfig::ServerDesc\fP[MAXBUF]" .PP Holds the description of the local server as defined by the administrator. .PP -Definition at line 79 of file inspircd_io.h. +Definition at line 80 of file inspircd_io.h. .PP Referenced by Server::GetServerDescription(). .SS "char \fBServerConfig::ServerName\fP[MAXBUF]" .PP Holds the server name of the local server as defined by the administrator. .PP -Definition at line 68 of file inspircd_io.h. +Definition at line 69 of file inspircd_io.h. .PP -Referenced by Server::GetServerName(), and userrec::userrec(). +Referenced by AddClient(), FullConnectUser(), Server::GetServerName(), and userrec::userrec(). .SS "unsigned int \fBServerConfig::SoftLimit\fP" .PP The soft limit value assigned to the irc server. .PP The IRC server will not allow more than this number of local users. .PP -Definition at line 193 of file inspircd_io.h. +Definition at line 194 of file inspircd_io.h. +.PP +Referenced by AddClient(). .SS "bool \fBServerConfig::unlimitcore\fP" .PP 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. .PP This is often used when debugging. .PP -Definition at line 166 of file inspircd_io.h. +Definition at line 167 of file inspircd_io.h. .SH "Author" .PP |