diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-12-14 14:52:12 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-12-14 14:52:12 +0000 |
| commit | 03be04a9a2d86a4568d09d5e1689dd7ef37c863a (patch) | |
| tree | d7040d4ceeaf75e849d59dd1ed077962b75fb4bf /docs/module-doc/inspircd__io_8h-source.html | |
| parent | 8b6b85c19528de8f0d35ab766d7559ad519869b3 (diff) | |
Added extra docs for new config system
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2417 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/inspircd__io_8h-source.html')
| -rw-r--r-- | docs/module-doc/inspircd__io_8h-source.html | 120 |
1 files changed, 120 insertions, 0 deletions
diff --git a/docs/module-doc/inspircd__io_8h-source.html b/docs/module-doc/inspircd__io_8h-source.html new file mode 100644 index 000000000..1d9d839b9 --- /dev/null +++ b/docs/module-doc/inspircd__io_8h-source.html @@ -0,0 +1,120 @@ +<!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: inspircd_io.h Source File</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 Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">home</a> » <a class="el" href="dir_000001.html">brain</a> » <a class="el" href="dir_000002.html">inspircd-cvs</a> » <a class="el" href="dir_000003.html">inspircd</a> » <a class="el" href="dir_000004.html">include</a></div> +<h1>inspircd_io.h</h1><a href="inspircd__io_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* +------------------------------------+</span> +<a name="l00002"></a>00002 <span class="comment"> * | Inspire Internet Relay Chat Daemon |</span> +<a name="l00003"></a>00003 <span class="comment"> * +------------------------------------+</span> +<a name="l00004"></a>00004 <span class="comment"> *</span> +<a name="l00005"></a>00005 <span class="comment"> * Inspire is copyright (C) 2002-2004 ChatSpike-Dev.</span> +<a name="l00006"></a>00006 <span class="comment"> * E-mail:</span> +<a name="l00007"></a>00007 <span class="comment"> * <brain@chatspike.net></span> +<a name="l00008"></a>00008 <span class="comment"> * <Craig@chatspike.net></span> +<a name="l00009"></a>00009 <span class="comment"> * </span> +<a name="l00010"></a>00010 <span class="comment"> * Written by Craig Edwards, Craig McLure, and others.</span> +<a name="l00011"></a>00011 <span class="comment"> * This program is free but copyrighted software; see</span> +<a name="l00012"></a>00012 <span class="comment"> * the file COPYING for details.</span> +<a name="l00013"></a>00013 <span class="comment"> *</span> +<a name="l00014"></a>00014 <span class="comment"> * ---------------------------------------------------</span> +<a name="l00015"></a>00015 <span class="comment"> */</span> +<a name="l00016"></a>00016 +<a name="l00017"></a>00017 <span class="preprocessor">#ifndef __INSPIRCD_IO_H__</span> +<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define __INSPIRCD_IO_H__</span> +<a name="l00019"></a>00019 <span class="preprocessor"></span> +<a name="l00020"></a>00020 <span class="preprocessor">#include <sstream></span> +<a name="l00021"></a>00021 <span class="preprocessor">#include <string></span> +<a name="l00022"></a>00022 <span class="preprocessor">#include <vector></span> +<a name="l00023"></a>00023 <span class="preprocessor">#include "inspircd.h"</span> +<a name="l00024"></a>00024 <span class="preprocessor">#include "globals.h"</span> +<a name="l00025"></a>00025 +<a name="l00026"></a>00026 <span class="comment">// flags for use with log()</span> +<a name="l00027"></a>00027 +<a name="l00028"></a><a class="code" href="inspircd__io_8h.html#DEBUG">00028</a> <span class="preprocessor">#define DEBUG 10</span> +<a name="l00029"></a><a class="code" href="inspircd__io_8h.html#VERBOSE">00029</a> <span class="preprocessor"></span><span class="preprocessor">#define VERBOSE 20</span> +<a name="l00030"></a><a class="code" href="inspircd__io_8h.html#DEFAULT">00030</a> <span class="preprocessor"></span><span class="preprocessor">#define DEFAULT 30</span> +<a name="l00031"></a><a class="code" href="inspircd__io_8h.html#SPARSE">00031</a> <span class="preprocessor"></span><span class="preprocessor">#define SPARSE 40</span> +<a name="l00032"></a><a class="code" href="inspircd__io_8h.html#NONE">00032</a> <span class="preprocessor"></span><span class="preprocessor">#define NONE 50</span> +<a name="l00033"></a>00033 <span class="preprocessor"></span> +<a name="l00034"></a><a class="code" href="classServerConfig.html">00034</a> <span class="keyword">class </span><a class="code" href="classServerConfig.html">ServerConfig</a> : <span class="keyword">public</span> <a class="code" href="classclassbase.html">classbase</a> +<a name="l00035"></a>00035 { +<a name="l00036"></a>00036 <span class="keyword">private</span>: +<a name="l00037"></a><a class="code" href="classServerConfig.html#include_5Fstack">00037</a> std::vector<std::string> <a class="code" href="classServerConfig.html#include_5Fstack">include_stack</a>; +<a name="l00038"></a>00038 <span class="keywordtype">int</span> <a class="code" href="classServerConfig.html#fgets_5Fsafe_28char_20_2Abuffer_2C_20size_5Ft_20maxsize_2C_20FILE_20_2A_26file_29">fgets_safe</a>(<span class="keywordtype">char</span>* buffer, size_t maxsize, FILE* &file); +<a name="l00039"></a>00039 <a class="code" href="namespaceirc.html#string">std::string</a> <a class="code" href="classServerConfig.html#ConfProcess_28char_20_2Abuffer_2C_20long_20linenumber_2C_20std_3A_3Astringstream_20_2Aerrorstream_2C_20bool_20_26error_2C_20std_3A_3Astring_20filename_29">ConfProcess</a>(<span class="keywordtype">char</span>* buffer, <span class="keywordtype">long</span> linenumber, std::stringstream* errorstream, <span class="keywordtype">bool</span> &error, <a class="code" href="namespaceirc.html#string">std::string</a> filename); +<a name="l00040"></a>00040 +<a name="l00041"></a>00041 <span class="keyword">public</span>: +<a name="l00042"></a><a class="code" href="classServerConfig.html#ServerName_5BMAXBUF_5D">00042</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#ServerName_5BMAXBUF_5D">ServerName</a>[MAXBUF]; +<a name="l00043"></a><a class="code" href="classServerConfig.html#Network_5BMAXBUF_5D">00043</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#Network_5BMAXBUF_5D">Network</a>[MAXBUF]; +<a name="l00044"></a><a class="code" href="classServerConfig.html#ServerDesc_5BMAXBUF_5D">00044</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#ServerDesc_5BMAXBUF_5D">ServerDesc</a>[MAXBUF]; +<a name="l00045"></a><a class="code" href="classServerConfig.html#AdminName_5BMAXBUF_5D">00045</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#AdminName_5BMAXBUF_5D">AdminName</a>[MAXBUF]; +<a name="l00046"></a><a class="code" href="classServerConfig.html#AdminEmail_5BMAXBUF_5D">00046</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#AdminEmail_5BMAXBUF_5D">AdminEmail</a>[MAXBUF]; +<a name="l00047"></a><a class="code" href="classServerConfig.html#AdminNick_5BMAXBUF_5D">00047</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#AdminNick_5BMAXBUF_5D">AdminNick</a>[MAXBUF]; +<a name="l00048"></a><a class="code" href="classServerConfig.html#diepass_5BMAXBUF_5D">00048</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#diepass_5BMAXBUF_5D">diepass</a>[MAXBUF]; +<a name="l00049"></a><a class="code" href="classServerConfig.html#restartpass_5BMAXBUF_5D">00049</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#restartpass_5BMAXBUF_5D">restartpass</a>[MAXBUF]; +<a name="l00050"></a><a class="code" href="classServerConfig.html#motd_5BMAXBUF_5D">00050</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#motd_5BMAXBUF_5D">motd</a>[MAXBUF]; +<a name="l00051"></a><a class="code" href="classServerConfig.html#rules_5BMAXBUF_5D">00051</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#rules_5BMAXBUF_5D">rules</a>[MAXBUF]; +<a name="l00052"></a><a class="code" href="classServerConfig.html#PrefixQuit_5BMAXBUF_5D">00052</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#PrefixQuit_5BMAXBUF_5D">PrefixQuit</a>[MAXBUF]; +<a name="l00053"></a><a class="code" href="classServerConfig.html#DieValue_5BMAXBUF_5D">00053</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#DieValue_5BMAXBUF_5D">DieValue</a>[MAXBUF]; +<a name="l00054"></a><a class="code" href="classServerConfig.html#DNSServer_5BMAXBUF_5D">00054</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#DNSServer_5BMAXBUF_5D">DNSServer</a>[MAXBUF]; +<a name="l00055"></a><a class="code" href="classServerConfig.html#DisabledCommands_5BMAXBUF_5D">00055</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#DisabledCommands_5BMAXBUF_5D">DisabledCommands</a>[MAXBUF]; +<a name="l00056"></a><a class="code" href="classServerConfig.html#ModPath_5B_31_30_32_34_5D">00056</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#ModPath_5B_31_30_32_34_5D">ModPath</a>[1024]; +<a name="l00057"></a><a class="code" href="classServerConfig.html#MyExecutable_5B_31_30_32_34_5D">00057</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#MyExecutable_5B_31_30_32_34_5D">MyExecutable</a>[1024]; +<a name="l00058"></a><a class="code" href="classServerConfig.html#log_5Ffile">00058</a> FILE *<a class="code" href="classServerConfig.html#log_5Ffile">log_file</a>; +<a name="l00059"></a><a class="code" href="classServerConfig.html#nofork">00059</a> <span class="keywordtype">bool</span> <a class="code" href="classServerConfig.html#nofork">nofork</a>; +<a name="l00060"></a><a class="code" href="classServerConfig.html#unlimitcore">00060</a> <span class="keywordtype">bool</span> <a class="code" href="classServerConfig.html#unlimitcore">unlimitcore</a>; +<a name="l00061"></a><a class="code" href="classServerConfig.html#AllowHalfop">00061</a> <span class="keywordtype">bool</span> <a class="code" href="classServerConfig.html#AllowHalfop">AllowHalfop</a>; +<a name="l00062"></a><a class="code" href="classServerConfig.html#dns_5Ftimeout">00062</a> <span class="keywordtype">int</span> <a class="code" href="classServerConfig.html#dns_5Ftimeout">dns_timeout</a>; +<a name="l00063"></a><a class="code" href="classServerConfig.html#NetBufferSize">00063</a> <span class="keywordtype">int</span> <a class="code" href="classServerConfig.html#NetBufferSize">NetBufferSize</a>; <span class="comment">// NetBufferSize used as the buffer size for all read() ops</span> +<a name="l00064"></a><a class="code" href="classServerConfig.html#MaxConn">00064</a> <span class="keywordtype">int</span> <a class="code" href="classServerConfig.html#MaxConn">MaxConn</a>; <span class="comment">// size of accept() backlog (128 by default on *BSD)</span> +<a name="l00065"></a><a class="code" href="classServerConfig.html#SoftLimit">00065</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classServerConfig.html#SoftLimit">SoftLimit</a>; +<a name="l00066"></a><a class="code" href="classServerConfig.html#MaxWhoResults">00066</a> <span class="keywordtype">int</span> <a class="code" href="classServerConfig.html#MaxWhoResults">MaxWhoResults</a>; +<a name="l00067"></a><a class="code" href="classServerConfig.html#debugging">00067</a> <span class="keywordtype">int</span> <a class="code" href="classServerConfig.html#debugging">debugging</a>; +<a name="l00068"></a><a class="code" href="classServerConfig.html#LogLevel">00068</a> <span class="keywordtype">int</span> <a class="code" href="classServerConfig.html#LogLevel">LogLevel</a>; +<a name="l00069"></a><a class="code" href="classServerConfig.html#DieDelay">00069</a> <span class="keywordtype">int</span> <a class="code" href="classServerConfig.html#DieDelay">DieDelay</a>; +<a name="l00070"></a><a class="code" href="classServerConfig.html#addrs_5BMAXBUF_5D_5B_32_35_35_5D">00070</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#addrs_5BMAXBUF_5D_5B_32_35_35_5D">addrs</a>[MAXBUF][255]; +<a name="l00071"></a><a class="code" href="classServerConfig.html#MOTD">00071</a> <a class="code" href="modules_8h.html#file_5Fcache">file_cache</a> <a class="code" href="classServerConfig.html#MOTD">MOTD</a>; +<a name="l00072"></a><a class="code" href="classServerConfig.html#RULES">00072</a> <a class="code" href="modules_8h.html#file_5Fcache">file_cache</a> <a class="code" href="classServerConfig.html#RULES">RULES</a>; +<a name="l00073"></a><a class="code" href="classServerConfig.html#PID_5B_31_30_32_34_5D">00073</a> <span class="keywordtype">char</span> <a class="code" href="classServerConfig.html#PID_5B_31_30_32_34_5D">PID</a>[1024]; +<a name="l00074"></a><a class="code" href="classServerConfig.html#config_5Ff">00074</a> std::stringstream <a class="code" href="classServerConfig.html#config_5Ff">config_f</a>; +<a name="l00075"></a><a class="code" href="classServerConfig.html#Classes">00075</a> <a class="code" href="users_8h.html#ClassVector">ClassVector</a> <a class="code" href="classServerConfig.html#Classes">Classes</a>; +<a name="l00076"></a><a class="code" href="classServerConfig.html#module_5Fnames">00076</a> std::vector<std::string> <a class="code" href="classServerConfig.html#module_5Fnames">module_names</a>; +<a name="l00077"></a>00077 +<a name="l00078"></a>00078 <a class="code" href="classServerConfig.html#ServerConfig_28_29">ServerConfig</a>(); +<a name="l00079"></a>00079 <span class="keywordtype">void</span> <a class="code" href="classServerConfig.html#ClearStack_28_29">ClearStack</a>(); +<a name="l00080"></a>00080 <span class="keywordtype">void</span> <a class="code" href="classServerConfig.html#Read_28bool_20bail_2C_20userrec_20_2Auser_29">Read</a>(<span class="keywordtype">bool</span> bail, <a class="code" href="classuserrec.html">userrec</a>* user); +<a name="l00081"></a>00081 <span class="keywordtype">bool</span> <a class="code" href="classServerConfig.html#LoadConf_28const_20char_20_2Afilename_2C_20std_3A_3Astringstream_20_2Atarget_2C_20std_3A_3Astringstream_20_2Aerrorstream_29">LoadConf</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* filename, std::stringstream *target, std::stringstream* errorstream); +<a name="l00082"></a>00082 <span class="keywordtype">int</span> <a class="code" href="classServerConfig.html#ConfValue_28char_20_2Atag_2C_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_2C_20std_3A_3Astringstream_20_2Aconfig_29">ConfValue</a>(<span class="keywordtype">char</span>* tag, <span class="keywordtype">char</span>* var, <span class="keywordtype">int</span> index, <span class="keywordtype">char</span> *result, std::stringstream *config); +<a name="l00083"></a>00083 <span class="keywordtype">int</span> <a class="code" href="classServerConfig.html#ReadConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_2C_20const_20char_20_2Avar_2C_20int_20index_2C_20char_20_2Aresult_29">ReadConf</a>(std::stringstream *<a class="code" href="classServerConfig.html#config_5Ff">config_f</a>,<span class="keyword">const</span> <span class="keywordtype">char</span>* tag, <span class="keyword">const</span> <span class="keywordtype">char</span>* var, <span class="keywordtype">int</span> index, <span class="keywordtype">char</span> *result); +<a name="l00084"></a>00084 <span class="keywordtype">int</span> <a class="code" href="classServerConfig.html#ConfValueEnum_28char_20_2Atag_2C_20std_3A_3Astringstream_20_2Aconfig_29">ConfValueEnum</a>(<span class="keywordtype">char</span>* tag,std::stringstream *config); +<a name="l00085"></a>00085 <span class="keywordtype">int</span> <a class="code" href="classServerConfig.html#EnumConf_28std_3A_3Astringstream_20_2Aconfig_5Ff_2C_20const_20char_20_2Atag_29">EnumConf</a>(std::stringstream *<a class="code" href="classServerConfig.html#config_5Ff">config_f</a>,<span class="keyword">const</span> <span class="keywordtype">char</span>* tag); +<a name="l00086"></a>00086 <span class="keywordtype">int</span> <a class="code" href="classServerConfig.html#EnumValues_28std_3A_3Astringstream_20_2Aconfig_2C_20const_20char_20_2Atag_2C_20int_20index_29">EnumValues</a>(std::stringstream *config, <span class="keyword">const</span> <span class="keywordtype">char</span>* tag, <span class="keywordtype">int</span> index); +<a name="l00087"></a>00087 }; +<a name="l00088"></a>00088 +<a name="l00089"></a>00089 +<a name="l00090"></a>00090 <span class="keywordtype">void</span> <a class="code" href="inspircd__io_8h.html#Exit_28int_29">Exit</a> (<span class="keywordtype">int</span>); +<a name="l00091"></a>00091 <span class="keywordtype">void</span> <a class="code" href="inspircd__io_8h.html#Start_28void_29">Start</a> (<span class="keywordtype">void</span>); +<a name="l00092"></a>00092 <span class="keywordtype">int</span> <a class="code" href="inspircd__io_8h.html#DaemonSeed_28void_29">DaemonSeed</a> (<span class="keywordtype">void</span>); +<a name="l00093"></a>00093 <span class="keywordtype">bool</span> <a class="code" href="inspircd__io_8h.html#FileExists_28const_20char_20_2Afile_29">FileExists</a> (<span class="keyword">const</span> <span class="keywordtype">char</span>* file); +<a name="l00094"></a>00094 <span class="keywordtype">int</span> <a class="code" href="inspircd__io_8h.html#OpenTCPSocket_28void_29">OpenTCPSocket</a> (<span class="keywordtype">void</span>); +<a name="l00095"></a>00095 <span class="keywordtype">int</span> <a class="code" href="inspircd__io_8h.html#BindSocket_28int_20sockfd_2C_20struct_20sockaddr_5Fin_20client_2C_20struct_20sockaddr_5Fin_20server_2C_20int_20port_2C_20char_20_2Aaddr_29">BindSocket</a> (<span class="keywordtype">int</span> sockfd, <span class="keyword">struct</span> sockaddr_in client, <span class="keyword">struct</span> sockaddr_in server, <span class="keywordtype">int</span> port, <span class="keywordtype">char</span>* addr); +<a name="l00096"></a>00096 +<a name="l00097"></a>00097 <span class="comment">/*bool LoadConf(const char* filename, std::stringstream *target, std::stringstream* errorstream);</span> +<a name="l00098"></a>00098 <span class="comment">int ConfValue(char* tag, char* var, int index, char *result, std::stringstream *config);</span> +<a name="l00099"></a>00099 <span class="comment">int ReadConf(std::stringstream *config_f,const char* tag, const char* var, int index, char *result);</span> +<a name="l00100"></a>00100 <span class="comment">int ConfValueEnum(char* tag,std::stringstream *config);</span> +<a name="l00101"></a>00101 <span class="comment">int EnumConf(std::stringstream *config_f,const char* tag);</span> +<a name="l00102"></a>00102 <span class="comment">int EnumValues(std::stringstream *config, const char* tag, int index);*/</span> +<a name="l00103"></a>00103 +<a name="l00104"></a>00104 <span class="keywordtype">void</span> <a class="code" href="inspircd__io_8h.html#WritePID_28std_3A_3Astring_20filename_29">WritePID</a>(<a class="code" href="namespaceirc.html#string">std::string</a> filename); +<a name="l00105"></a>00105 +<a name="l00106"></a>00106 <span class="preprocessor">#endif</span> +</pre></div><hr size="1"><address style="align: right;"><small>Generated on Wed Dec 14 14:49:16 2005 for InspIRCd by +<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> |