From 03be04a9a2d86a4568d09d5e1689dd7ef37c863a Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 14 Dec 2005 14:52:12 +0000 Subject: Added extra docs for new config system git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2417 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classServerConfig.html | 1512 ++++++++++++++++++++++++++++++++ 1 file changed, 1512 insertions(+) create mode 100644 docs/module-doc/classServerConfig.html (limited to 'docs/module-doc/classServerConfig.html') diff --git a/docs/module-doc/classServerConfig.html b/docs/module-doc/classServerConfig.html new file mode 100644 index 000000000..7991b1f19 --- /dev/null +++ b/docs/module-doc/classServerConfig.html @@ -0,0 +1,1512 @@ + + +InspIRCd: ServerConfig Class Reference + + + +

ServerConfig Class Reference

#include <inspircd_io.h> +

+Inheritance diagram for ServerConfig:

+ + + +[legend]Collaboration diagram for ServerConfig:

+ + + +[legend]List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +


Public Member Functions
	ServerConfig ()
void	ClearStack ()
void	Read (bool bail, userrec *user)
bool	LoadConf (const char filename, std::stringstream target, std::stringstream *errorstream)
int	ConfValue (char tag, char var, int index, char result, std::stringstream config)
int	ReadConf (std::stringstream config_f, const char tag, const char var, int index, char result)
int	ConfValueEnum (char tag, std::stringstream config)
int	EnumConf (std::stringstream config_f, const char tag)
int	EnumValues (std::stringstream config, const char tag, int index)
Public Attributes
char	ServerName [MAXBUF]
char	Network [MAXBUF]
char	ServerDesc [MAXBUF]
char	AdminName [MAXBUF]
char	AdminEmail [MAXBUF]
char	AdminNick [MAXBUF]
char	diepass [MAXBUF]
char	restartpass [MAXBUF]
char	motd [MAXBUF]
char	rules [MAXBUF]
char	PrefixQuit [MAXBUF]
char	DieValue [MAXBUF]
char	DNSServer [MAXBUF]
char	DisabledCommands [MAXBUF]
char	ModPath [1024]
char	MyExecutable [1024]
FILE *	log_file
bool	nofork
bool	unlimitcore
bool	AllowHalfop
int	dns_timeout
int	NetBufferSize
int	MaxConn
unsigned int	SoftLimit
int	MaxWhoResults
int	debugging
int	LogLevel
int	DieDelay
char	addrs [MAXBUF][255]
file_cache	MOTD
file_cache	RULES
char	PID [1024]
std::stringstream	config_f
ClassVector	Classes
std::vector< std::string >	module_names
Private Member Functions
int	fgets_safe (char buffer, size_t maxsize, FILE &file)
std::string	ConfProcess (char buffer, long linenumber, std::stringstream errorstream, bool &error, std::string filename)
Private Attributes
std::vector< std::string >	include_stack

Detailed Description

+ +

+Definition at line 34 of file inspircd_io.h.

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + +
ServerConfig::ServerConfig ( )
+
+ + + + + +
+ + + +
+
+

Member Function Documentation

+ + + + +
+ + + + + + + + +
void ServerConfig::ClearStack ( )
+
+ + + + + +
+ + + +
+ +
+Referenced by ConfigReader::ConfigReader().
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
std::string ServerConfig::ConfProcess ( char * buffer,
long linenumber,
std::stringstream * errorstream,
bool & error,
std::string filename
) [private]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int ServerConfig::ConfValue ( char * tag,
char * var,
int index,
char * result,
std::stringstream * config
)
+
+ + + + + +
+ + + +
+ +
+Referenced by userrec::HasPermission().
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
int ServerConfig::ConfValueEnum ( char * tag,
std::stringstream * config
)
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
int ServerConfig::EnumConf ( std::stringstream * config_f,
const char * tag
)
+
+ + + + + +
+ + + +
+ +
+Referenced by ConfigReader::Enumerate().
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
int ServerConfig::EnumValues ( std::stringstream * config,
const char * tag,
int index
)
+
+ + + + + +
+ + + +
+ +
+Referenced by ConfigReader::EnumerateValues().
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
int ServerConfig::fgets_safe ( char * buffer,
size_t maxsize,
FILE *& file
) [private]
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool ServerConfig::LoadConf ( const char * filename,
std::stringstream * target,
std::stringstream * errorstream
)
+
+ + + + + +
+ + + +
+ +
+Referenced by ConfigReader::ConfigReader().
+

+ + + + +
+ + + + + + + + + + + + + + + + + + +
void ServerConfig::Read ( bool bail,
userrec * user
)
+
+ + + + + +
+ + + +
+ +
+Referenced by Server::RehashServer().
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int ServerConfig::ReadConf ( std::stringstream * config_f,
const char * tag,
const char * var,
int index,
char * result
)
+
+ + + + + +
+ + + +
+ +
+Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue().
+

Member Data Documentation

+ + + + +
+ + + + +
char ServerConfig::addrs[MAXBUF][255]
+
+ + + + + +
+ + + +
+ +
+Definition at line 70 of file inspircd_io.h.
+

+ + + + +
+ + + + +
char ServerConfig::AdminEmail[MAXBUF]
+
+ + + + + +
+ + + +
+ +
+Definition at line 46 of file inspircd_io.h.
+

+ + + + +
+ + + + +
char ServerConfig::AdminName[MAXBUF]
+
+ + + + + +
+ + + +
+ +
+Definition at line 45 of file inspircd_io.h.
+

+ + + + +
+ + + + +
char ServerConfig::AdminNick[MAXBUF]
+
+ + + + + +
+ + + +
+ +
+Definition at line 47 of file inspircd_io.h.
+

+ + + + +
+ + + + +
bool ServerConfig::AllowHalfop
+
+ + + + + +
+ + + +
+ +
+Definition at line 61 of file inspircd_io.h.
+

+ + + + +
+ + + + +
ClassVector ServerConfig::Classes
+
+ + + + + +
+ + + +
+ +
+Definition at line 75 of file inspircd_io.h.
+

+ + + + +
+ + + + +
std::stringstream ServerConfig::config_f
+
+ + + + + +
+ + + +
+ +
+Definition at line 74 of file inspircd_io.h. +
+Referenced by userrec::HasPermission().
+

+ + + + +
+ + + + +
int ServerConfig::debugging
+
+ + + + + +
+ + + +
+ +
+Definition at line 67 of file inspircd_io.h.
+

+ + + + +
+ + + + +
int ServerConfig::DieDelay
+
+ + + + + +
+ + + +
+ +
+Definition at line 69 of file inspircd_io.h.
+

+ + + + +
+ + + + +
char ServerConfig::diepass[MAXBUF]
+
+ + + + + +
+ + + +
+ +
+Definition at line 48 of file inspircd_io.h.
+

+ + + + +
+ + + + +
char ServerConfig::DieValue[MAXBUF]
+
+ + + + + +
+ + + +
+ +
+Definition at line 53 of file inspircd_io.h.
+

+ + + + +
+ + + + +
char ServerConfig::DisabledCommands[MAXBUF]
+
+ + + + + +
+ + + +
+ +
+Definition at line 55 of file inspircd_io.h.
+

+ + + + +
+ + + + +
int ServerConfig::dns_timeout
+
+ + + + + +
+ + + +
+ +
+Definition at line 62 of file inspircd_io.h.
+

+ + + + +
+ + + + +
char ServerConfig::DNSServer[MAXBUF]
+
+ + + + + +
+ + + +
+ +
+Definition at line 54 of file inspircd_io.h.
+

+ + + + +
+ + + + +
std::vector<std::string> ServerConfig::include_stack [private]
+
+ + + + + +
+ + + +
+ +
+Definition at line 37 of file inspircd_io.h.
+

+ + + + +
+ + + + +
FILE* ServerConfig::log_file
+
+ + + + + +
+ + + +
+ +
+Definition at line 58 of file inspircd_io.h.
+

+ + + + +
+ + + + +
int ServerConfig::LogLevel
+
+ + + + + +
+ + + +
+ +
+Definition at line 68 of file inspircd_io.h.
+

+ + + + +
+ + + + +
int ServerConfig::MaxConn
+
+ + + + + +
+ + + +
+ +
+Definition at line 64 of file inspircd_io.h.
+

+ + + + +
+ + + + +
int ServerConfig::MaxWhoResults
+
+ + + + + +
+ + + +
+ +
+Definition at line 66 of file inspircd_io.h.
+

+ + + + +
+ + + + +
char ServerConfig::ModPath[1024]
+
+ + + + + +
+ + + +
+ +
+Definition at line 56 of file inspircd_io.h.
+

+ + + + +
+ + + + +
std::vector<std::string> ServerConfig::module_names
+
+ + + + + +
+ + + +
+ +
+Definition at line 76 of file inspircd_io.h. +
+Referenced by Server::FindModule().
+

+ + + + +
+ + + + +
file_cache ServerConfig::MOTD
+
+ + + + + +
+ + + +
+ +
+Definition at line 71 of file inspircd_io.h.
+

+ + + + +
+ + + + +
char ServerConfig::motd[MAXBUF]
+
+ + + + + +
+ + + +
+ +
+Definition at line 50 of file inspircd_io.h.
+

+ + + + +
+ + + + +
char ServerConfig::MyExecutable[1024]
+
+ + + + + +
+ + + +
+ +
+Definition at line 57 of file inspircd_io.h.
+

+ + + + +
+ + + + +
int ServerConfig::NetBufferSize
+
+ + + + + +
+ + + +
+ +
+Definition at line 63 of file inspircd_io.h.
+

+ + + + +
+ + + + +
char ServerConfig::Network[MAXBUF]
+
+ + + + + +
+ + + +
+ +
+Definition at line 43 of file inspircd_io.h.
+

+ + + + +
+ + + + +
bool ServerConfig::nofork
+
+ + + + + +
+ + + +
+ +
+Definition at line 59 of file inspircd_io.h.
+

+ + + + +
+ + + + +
char ServerConfig::PID[1024]
+
+ + + + + +
+ + + +
+ +
+Definition at line 73 of file inspircd_io.h.
+

+ + + + +
+ + + + +
char ServerConfig::PrefixQuit[MAXBUF]
+
+ + + + + +
+ + + +
+ +
+Definition at line 52 of file inspircd_io.h.
+

+ + + + +
+ + + + +
char ServerConfig::restartpass[MAXBUF]
+
+ + + + + +
+ + + +
+ +
+Definition at line 49 of file inspircd_io.h.
+

+ + + + +
+ + + + +
file_cache ServerConfig::RULES
+
+ + + + + +
+ + + +
+ +
+Definition at line 72 of file inspircd_io.h.
+

+ + + + +
+ + + + +
char ServerConfig::rules[MAXBUF]
+
+ + + + + +
+ + + +
+ +
+Definition at line 51 of file inspircd_io.h.
+

+ + + + +
+ + + + +
char ServerConfig::ServerDesc[MAXBUF]
+
+ + + + + +
+ + + +
+ +
+Definition at line 44 of file inspircd_io.h.
+

+ + + + +
+ + + + +
char ServerConfig::ServerName[MAXBUF]
+
+ + + + + +
+ + + +
+ +
+Definition at line 42 of file inspircd_io.h. +
+Referenced by userrec::userrec().
+

+ + + + +
+ + + + +
unsigned int ServerConfig::SoftLimit
+
+ + + + + +
+ + + +
+ +
+Definition at line 65 of file inspircd_io.h.
+

+ + + + +
+ + + + +
bool ServerConfig::unlimitcore
+
+ + + + + +
+ + + +
+ +
+Definition at line 60 of file inspircd_io.h.
+

The documentation for this class was generated from the following file:

inspircd_io.h

Generated on Wed Dec 14 14:49:34 2005 for InspIRCd by + +

1.4.4-20050815

+ + -- cgit v1.3.1-10-gc9f91

ServerConfig Class Reference

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation