diff options
Diffstat (limited to 'docs/man/man3')
55 files changed, 124 insertions, 107 deletions
diff --git a/docs/man/man3/Admin.3 b/docs/man/man3/Admin.3 index c98cc1bb4..1f7b31c41 100644 --- a/docs/man/man3/Admin.3 +++ b/docs/man/man3/Admin.3 @@ -1,4 +1,4 @@ -.TH "Admin" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Admin" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/BanItem.3 b/docs/man/man3/BanItem.3 index 570c67b82..3458f2aaa 100644 --- a/docs/man/man3/BanItem.3 +++ b/docs/man/man3/BanItem.3 @@ -1,4 +1,4 @@ -.TH "BanItem" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "BanItem" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3 index 78aa3d341..a2a9afaf2 100644 --- a/docs/man/man3/ConfigReader.3 +++ b/docs/man/man3/ConfigReader.3 @@ -1,4 +1,4 @@ -.TH "ConfigReader" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConfigReader" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -84,7 +84,7 @@ Allows reading of values from configuration files This class allows a module to It may either be instantiated with one parameter or none. Constructing the class using one parameter allows you to specify a path to your own configuration file, otherwise, inspircd.conf is read. .PP -Definition at line 685 of file modules.h. +Definition at line 683 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "ConfigReader::ConfigReader ()" @@ -301,22 +301,22 @@ References readerror. .PP .SS "std::stringstream* \fBConfigReader::cache\fP\fC [protected]\fP" .PP -The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed). It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.Definition at line 693 of file modules.h. +The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed). It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.Definition at line 691 of file modules.h. .PP Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader(). .SS "long \fBConfigReader::error\fP\fC [protected]\fP" .PP -Definition at line 698 of file modules.h. +Definition at line 696 of file modules.h. .PP Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue(). .SS "std::stringstream* \fBConfigReader::errorlog\fP\fC [protected]\fP" .PP -Definition at line 694 of file modules.h. +Definition at line 692 of file modules.h. .PP Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader(). .SS "bool \fBConfigReader::readerror\fP\fC [protected]\fP" .PP -Used to store errors. Definition at line 697 of file modules.h. +Used to store errors. Definition at line 695 of file modules.h. .PP Referenced by ConfigReader(), and Verify(). diff --git a/docs/man/man3/ConnectClass.3 b/docs/man/man3/ConnectClass.3 index 4d8891d60..baa288a3f 100644 --- a/docs/man/man3/ConnectClass.3 +++ b/docs/man/man3/ConnectClass.3 @@ -1,4 +1,4 @@ -.TH "ConnectClass" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConnectClass" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -39,6 +39,10 @@ Inherits \fBclassbase\fP. .br .RI "\fIHost mask for this line. \fP" .ti -1c +.RI "int \fBpingtime\fP" +.br +.RI "\fINumber of seconds between pings for this line. \fP" +.ti -1c .RI "char \fBpass\fP [MAXBUF]" .br .RI "\fI(Optional) Password for this line \fP" @@ -50,17 +54,18 @@ Holds information relevent to <connect allow> and <connect deny> tags in the con .PP .SS "ConnectClass::ConnectClass ()\fC [inline]\fP" .PP -Definition at line 64 of file users.h. +Definition at line 67 of file users.h. .PP -References flood, host, pass, and registration_timeout. +References flood, host, pass, pingtime, and registration_timeout. .PP .nf -65 { -66 registration_timeout = 0; -67 flood = 0; -68 strlcpy(host,'',MAXBUF); -69 strlcpy(pass,'',MAXBUF); -70 } +68 { +69 registration_timeout = 0; +70 flood = 0; +71 pingtime = 0; +72 strlcpy(host,'',MAXBUF); +73 strlcpy(pass,'',MAXBUF); +74 } .fi .SH "Member Data Documentation" .PP @@ -76,7 +81,12 @@ Host mask for this line. Definition at line 59 of file users.h. Referenced by ConnectClass(). .SS "char \fBConnectClass::pass\fP[MAXBUF]" .PP -(Optional) Password for this line Definition at line 62 of file users.h. +(Optional) Password for this line Definition at line 65 of file users.h. +.PP +Referenced by ConnectClass(). +.SS "int \fBConnectClass::pingtime\fP" +.PP +Number of seconds between pings for this line. Definition at line 62 of file users.h. .PP Referenced by ConnectClass(). .SS "int \fBConnectClass::registration_timeout\fP" diff --git a/docs/man/man3/DNS.3 b/docs/man/man3/DNS.3 index e497d01a0..4e842b60d 100644 --- a/docs/man/man3/DNS.3 +++ b/docs/man/man3/DNS.3 @@ -1,4 +1,4 @@ -.TH "DNS" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "DNS" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ELine.3 b/docs/man/man3/ELine.3 index 9ecca8954..7d54fe534 100644 --- a/docs/man/man3/ELine.3 +++ b/docs/man/man3/ELine.3 @@ -1,4 +1,4 @@ -.TH "ELine" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ELine" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ExemptItem.3 b/docs/man/man3/ExemptItem.3 index fbff2f13c..d6bde382b 100644 --- a/docs/man/man3/ExemptItem.3 +++ b/docs/man/man3/ExemptItem.3 @@ -1,4 +1,4 @@ -.TH "ExemptItem" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExemptItem" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ExtMode.3 b/docs/man/man3/ExtMode.3 index b32870c12..e3dcb371c 100644 --- a/docs/man/man3/ExtMode.3 +++ b/docs/man/man3/ExtMode.3 @@ -1,4 +1,4 @@ -.TH "ExtMode" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExtMode" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Extensible.3 b/docs/man/man3/Extensible.3 index 3fc7b5373..5d21ed164 100644 --- a/docs/man/man3/Extensible.3 +++ b/docs/man/man3/Extensible.3 @@ -1,4 +1,4 @@ -.TH "Extensible" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Extensible" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3 index 677e59b5d..0b9e07501 100644 --- a/docs/man/man3/FileReader.3 +++ b/docs/man/man3/FileReader.3 @@ -1,4 +1,4 @@ -.TH "FileReader" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "FileReader" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -57,7 +57,7 @@ Caches a text file into memory and can be used to retrieve lines from it. This class contains methods for read-only manipulation of a text file in memory. Either use the constructor type with one parameter to load a file into memory at construction, or use the LoadFile method to load a file. .PP -Definition at line 774 of file modules.h. +Definition at line 772 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "FileReader::FileReader ()" @@ -150,7 +150,7 @@ References fc, and file_cache. .PP .SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP" .PP -Definition at line 776 of file modules.h. +Definition at line 774 of file modules.h. .PP Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile(). diff --git a/docs/man/man3/GLine.3 b/docs/man/man3/GLine.3 index 3e02d2bc4..2cf341141 100644 --- a/docs/man/man3/GLine.3 +++ b/docs/man/man3/GLine.3 @@ -1,4 +1,4 @@ -.TH "GLine" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "GLine" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/HostItem.3 b/docs/man/man3/HostItem.3 index 1c833f94d..2571be4b8 100644 --- a/docs/man/man3/HostItem.3 +++ b/docs/man/man3/HostItem.3 @@ -1,4 +1,4 @@ -.TH "HostItem" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "HostItem" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/InAddr_HashComp.3 b/docs/man/man3/InAddr_HashComp.3 index 47bc468f3..94ba034da 100644 --- a/docs/man/man3/InAddr_HashComp.3 +++ b/docs/man/man3/InAddr_HashComp.3 @@ -1,4 +1,4 @@ -.TH "InAddr_HashComp" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "InAddr_HashComp" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/InviteItem.3 b/docs/man/man3/InviteItem.3 index a03076a3b..bd77e0626 100644 --- a/docs/man/man3/InviteItem.3 +++ b/docs/man/man3/InviteItem.3 @@ -1,4 +1,4 @@ -.TH "InviteItem" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "InviteItem" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Invited.3 b/docs/man/man3/Invited.3 index 2a47106a2..fab638087 100644 --- a/docs/man/man3/Invited.3 +++ b/docs/man/man3/Invited.3 @@ -1,4 +1,4 @@ -.TH "Invited" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Invited" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/KLine.3 b/docs/man/man3/KLine.3 index 1d7529288..b9a460657 100644 --- a/docs/man/man3/KLine.3 +++ b/docs/man/man3/KLine.3 @@ -1,4 +1,4 @@ -.TH "KLine" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "KLine" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ModeParameter.3 b/docs/man/man3/ModeParameter.3 index 6c8553ede..3401d36cb 100644 --- a/docs/man/man3/ModeParameter.3 +++ b/docs/man/man3/ModeParameter.3 @@ -1,4 +1,4 @@ -.TH "ModeParameter" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModeParameter" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Module.3 b/docs/man/man3/Module.3 index 04c1c9654..d7837affb 100644 --- a/docs/man/man3/Module.3 +++ b/docs/man/man3/Module.3 @@ -1,4 +1,4 @@ -.TH "Module" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Module" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -44,11 +44,11 @@ Inherits \fBclassbase\fP. .br .RI "\fICalled when a user parts a channel. \fP" .ti -1c -.RI "virtual void \fBOnPacketTransmit\fP (char *p)" +.RI "virtual void \fBOnPacketTransmit\fP (std::string &data, std::string serv)" .br .RI "\fICalled before a packet is transmitted across the irc network between two irc servers. \fP" .ti -1c -.RI "virtual void \fBOnPacketReceive\fP (char *p)" +.RI "virtual void \fBOnPacketReceive\fP (std::string &data, std::string serv)" .br .RI "\fICalled after a packet is received from another irc server. \fP" .ti -1c @@ -244,16 +244,16 @@ Called whenever a user opers locally. The userrec will contain the oper mode 'o' .nf 319 { }; .fi -.SS "void Module::OnPacketReceive (char * p)\fC [virtual]\fP" +.SS "void Module::OnPacketReceive (std::string & data, std::string serv)\fC [virtual]\fP" .PP -Called after a packet is received from another irc server. The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd.Definition at line 313 of file modules.cpp. +Called after a packet is received from another irc server. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called immediately after the packet is received but before any other operations with the core of the ircd.Definition at line 313 of file modules.cpp. .PP .nf 313 { } .fi -.SS "void Module::OnPacketTransmit (char * p)\fC [virtual]\fP" +.SS "void Module::OnPacketTransmit (std::string & data, std::string serv)\fC [virtual]\fP" .PP -Called before a packet is transmitted across the irc network between two irc servers. The packet is represented as a char*, as it should be regarded as a buffer, and not a string. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program.Definition at line 312 of file modules.cpp. +Called before a packet is transmitted across the irc network between two irc servers. This allows you to easily represent it in the correct ways to implement encryption, compression, digital signatures and anything else you may want to add. This should be regarded as a pre-processor and will be called before ANY other operations within the ircd core program.Definition at line 312 of file modules.cpp. .PP .nf 312 { } diff --git a/docs/man/man3/ModuleFactory.3 b/docs/man/man3/ModuleFactory.3 index 18d6bb943..45d5e2207 100644 --- a/docs/man/man3/ModuleFactory.3 +++ b/docs/man/man3/ModuleFactory.3 @@ -1,4 +1,4 @@ -.TH "ModuleFactory" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModuleFactory" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -32,22 +32,22 @@ Instantiates classes inherited from \fBModule\fP This class creates a class inhe This is to allow for modules to create many different variants of \fBModule\fP, dependent on architecture, configuration, etc. In most cases, the simple class shown in the example module m_foobar.so will suffice for most modules. .PP -Definition at line 829 of file modules.h. +Definition at line 827 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "ModuleFactory::ModuleFactory ()\fC [inline]\fP" .PP -Definition at line 832 of file modules.h. +Definition at line 830 of file modules.h. .PP .nf -832 { } +830 { } .fi .SS "virtual ModuleFactory::~\fBModuleFactory\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 833 of file modules.h. +Definition at line 831 of file modules.h. .PP .nf -833 { } +831 { } .fi .SH "Member Function Documentation" .PP diff --git a/docs/man/man3/QLine.3 b/docs/man/man3/QLine.3 index f3dbdbea3..efda7f1a9 100644 --- a/docs/man/man3/QLine.3 +++ b/docs/man/man3/QLine.3 @@ -1,4 +1,4 @@ -.TH "QLine" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "QLine" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Server.3 b/docs/man/man3/Server.3 index d3268626a..eaa423117 100644 --- a/docs/man/man3/Server.3 +++ b/docs/man/man3/Server.3 @@ -1,4 +1,4 @@ -.TH "Server" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Server" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -166,7 +166,7 @@ Allows server output and query functions This class contains methods which allow All modules should instantiate at least one copy of this class, and use its member functions to perform their tasks. .PP -Definition at line 378 of file modules.h. +Definition at line 376 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "Server::Server ()" diff --git a/docs/man/man3/StrHashComp.3 b/docs/man/man3/StrHashComp.3 index d4bc096fe..8ca9ffb81 100644 --- a/docs/man/man3/StrHashComp.3 +++ b/docs/man/man3/StrHashComp.3 @@ -1,4 +1,4 @@ -.TH "StrHashComp" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "StrHashComp" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Version.3 b/docs/man/man3/Version.3 index 69a2da861..c0d4fd052 100644 --- a/docs/man/man3/Version.3 +++ b/docs/man/man3/Version.3 @@ -1,4 +1,4 @@ -.TH "Version" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "Version" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/XLine.3 b/docs/man/man3/XLine.3 index 409aba33f..3d9909619 100644 --- a/docs/man/man3/XLine.3 +++ b/docs/man/man3/XLine.3 @@ -1,4 +1,4 @@ -.TH "XLine" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "XLine" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ZLine.3 b/docs/man/man3/ZLine.3 index 6d71ea0c5..940be822d 100644 --- a/docs/man/man3/ZLine.3 +++ b/docs/man/man3/ZLine.3 @@ -1,4 +1,4 @@ -.TH "ZLine" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ZLine" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/base.h.3 b/docs/man/man3/base.h.3 index f07ed0ecd..ad0974665 100644 --- a/docs/man/man3/base.h.3 +++ b/docs/man/man3/base.h.3 @@ -1,4 +1,4 @@ -.TH "base.h" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "base.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/channels.cpp.3 b/docs/man/man3/channels.cpp.3 index 3595b02fb..3ece27eb2 100644 --- a/docs/man/man3/channels.cpp.3 +++ b/docs/man/man3/channels.cpp.3 @@ -1,4 +1,4 @@ -.TH "channels.cpp" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.cpp" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/channels.h.3 b/docs/man/man3/channels.h.3 index 6444b221f..0c2273556 100644 --- a/docs/man/man3/channels.h.3 +++ b/docs/man/man3/channels.h.3 @@ -1,4 +1,4 @@ -.TH "channels.h" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/chanrec.3 b/docs/man/man3/chanrec.3 index d76b09c65..2039c3025 100644 --- a/docs/man/man3/chanrec.3 +++ b/docs/man/man3/chanrec.3 @@ -1,4 +1,4 @@ -.TH "chanrec" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "chanrec" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/classbase.3 b/docs/man/man3/classbase.3 index c5be3f65e..fba93b6cd 100644 --- a/docs/man/man3/classbase.3 +++ b/docs/man/man3/classbase.3 @@ -1,4 +1,4 @@ -.TH "classbase" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "classbase" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/command_t.3 b/docs/man/man3/command_t.3 index f791b6319..ebaa41001 100644 --- a/docs/man/man3/command_t.3 +++ b/docs/man/man3/command_t.3 @@ -1,4 +1,4 @@ -.TH "command_t" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "command_t" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/commands.h.3 b/docs/man/man3/commands.h.3 index d4b6aeec6..ff2b363b8 100644 --- a/docs/man/man3/commands.h.3 +++ b/docs/man/man3/commands.h.3 @@ -1,4 +1,4 @@ -.TH "commands.h" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "commands.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/connection.3 b/docs/man/man3/connection.3 index bb7c727da..1db27f5e4 100644 --- a/docs/man/man3/connection.3 +++ b/docs/man/man3/connection.3 @@ -1,4 +1,4 @@ -.TH "connection" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/connection.h.3 b/docs/man/man3/connection.h.3 index d0d5c75f4..d0e85f663 100644 --- a/docs/man/man3/connection.h.3 +++ b/docs/man/man3/connection.h.3 @@ -1,4 +1,4 @@ -.TH "connection.h" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ctables.h.3 b/docs/man/man3/ctables.h.3 index f87098c19..ba0c82f2a 100644 --- a/docs/man/man3/ctables.h.3 +++ b/docs/man/man3/ctables.h.3 @@ -1,4 +1,4 @@ -.TH "ctables.h" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ctables.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/dns.h.3 b/docs/man/man3/dns.h.3 index 9943ef834..3f7b577b6 100644 --- a/docs/man/man3/dns.h.3 +++ b/docs/man/man3/dns.h.3 @@ -1,4 +1,4 @@ -.TH "dns.h" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/dns_ip4list.3 b/docs/man/man3/dns_ip4list.3 index aadab66bd..c8d7792b1 100644 --- a/docs/man/man3/dns_ip4list.3 +++ b/docs/man/man3/dns_ip4list.3 @@ -1,4 +1,4 @@ -.TH "dns_ip4list" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "dns_ip4list" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ircd_connector.3 b/docs/man/man3/ircd_connector.3 index 594e67b18..fbccfe8c9 100644 --- a/docs/man/man3/ircd_connector.3 +++ b/docs/man/man3/ircd_connector.3 @@ -1,4 +1,4 @@ -.TH "ircd_connector" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ircd_connector" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/message.h.3 b/docs/man/man3/message.h.3 index ea9c93645..502c9d479 100644 --- a/docs/man/man3/message.h.3 +++ b/docs/man/man3/message.h.3 @@ -1,4 +1,4 @@ -.TH "message.h" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "message.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/mode.h.3 b/docs/man/man3/mode.h.3 index 2a1f7dd48..3a4f2395d 100644 --- a/docs/man/man3/mode.h.3 +++ b/docs/man/man3/mode.h.3 @@ -1,4 +1,4 @@ -.TH "mode.h" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "mode.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/modules.cpp.3 b/docs/man/man3/modules.cpp.3 index 6504d9eba..6bacc994d 100644 --- a/docs/man/man3/modules.cpp.3 +++ b/docs/man/man3/modules.cpp.3 @@ -1,4 +1,4 @@ -.TH "modules.cpp" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.cpp" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/modules.h.3 b/docs/man/man3/modules.h.3 index 6a3ccce31..2a1924d97 100644 --- a/docs/man/man3/modules.h.3 +++ b/docs/man/man3/modules.h.3 @@ -1,4 +1,4 @@ -.TH "modules.h" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -215,22 +215,22 @@ Referenced by Module::OnAccessCheck(). Definition at line 38 of file modules.h. .SS "#define CONF_FILE_NOT_FOUND 0x000200" .PP -Definition at line 677 of file modules.h. +Definition at line 675 of file modules.h. .PP Referenced by ConfigReader::ConfigReader(). .SS "#define CONF_NOT_A_NUMBER 0x000010" .PP -Definition at line 674 of file modules.h. +Definition at line 672 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_NOT_UNSIGNED 0x000080" .PP -Definition at line 675 of file modules.h. +Definition at line 673 of file modules.h. .PP Referenced by ConfigReader::ReadInteger(). .SS "#define CONF_VALUE_NOT_FOUND 0x000100" .PP -Definition at line 676 of file modules.h. +Definition at line 674 of file modules.h. .PP Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue(). .SS "#define DEBUG 10" @@ -311,7 +311,7 @@ Low level definition of a \fBFileReader\fP classes file cache area. Definition a Referenced by FileReader::FileReader(), and FileReader::LoadFile(). .SS "typedef DLLFactory<\fBModuleFactory\fP> \fBircd_module\fP" .PP -Definition at line 842 of file modules.h. +Definition at line 840 of file modules.h. .SS "typedef \fBfile_cache\fP \fBstring_list\fP" .PP Definition at line 68 of file modules.h. diff --git a/docs/man/man3/nspace.3 b/docs/man/man3/nspace.3 index 38a8c655d..2a2ce73e7 100644 --- a/docs/man/man3/nspace.3 +++ b/docs/man/man3/nspace.3 @@ -1,4 +1,4 @@ -.TH "nspace" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/nspace_nspace_hash_ in_addr _.3 b/docs/man/man3/nspace_nspace_hash_ in_addr _.3 index f01f2ea77..af95e6cd0 100644 --- a/docs/man/man3/nspace_nspace_hash_ in_addr _.3 +++ b/docs/man/man3/nspace_nspace_hash_ in_addr _.3 @@ -1,4 +1,4 @@ -.TH "nspace::nspace::hash< in_addr >" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< in_addr >" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/nspace_nspace_hash_ string _.3 b/docs/man/man3/nspace_nspace_hash_ string _.3 index 024bdfe5c..69cfab153 100644 --- a/docs/man/man3/nspace_nspace_hash_ string _.3 +++ b/docs/man/man3/nspace_nspace_hash_ string _.3 @@ -1,4 +1,4 @@ -.TH "nspace::nspace::hash< string >" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< string >" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/packet.3 b/docs/man/man3/packet.3 index d351617e7..8c40129a4 100644 --- a/docs/man/man3/packet.3 +++ b/docs/man/man3/packet.3 @@ -1,4 +1,4 @@ -.TH "packet" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "packet" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/serverrec.3 b/docs/man/man3/serverrec.3 index 5db6846d2..a9c894df0 100644 --- a/docs/man/man3/serverrec.3 +++ b/docs/man/man3/serverrec.3 @@ -1,4 +1,4 @@ -.TH "serverrec" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "serverrec" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/servers.cpp.3 b/docs/man/man3/servers.cpp.3 index f975694d8..d0677ae0a 100644 --- a/docs/man/man3/servers.cpp.3 +++ b/docs/man/man3/servers.cpp.3 @@ -1,4 +1,4 @@ -.TH "servers.cpp" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.cpp" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/servers.h.3 b/docs/man/man3/servers.h.3 index 73b812f67..b19bfffc1 100644 --- a/docs/man/man3/servers.h.3 +++ b/docs/man/man3/servers.h.3 @@ -1,4 +1,4 @@ -.TH "servers.h" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/std.3 b/docs/man/man3/std.3 index 015cc75e9..5e60136f9 100644 --- a/docs/man/man3/std.3 +++ b/docs/man/man3/std.3 @@ -1,4 +1,4 @@ -.TH "std" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "std" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ucrec.3 b/docs/man/man3/ucrec.3 index 97567e926..9525851b8 100644 --- a/docs/man/man3/ucrec.3 +++ b/docs/man/man3/ucrec.3 @@ -1,4 +1,4 @@ -.TH "ucrec" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "ucrec" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/userrec.3 b/docs/man/man3/userrec.3 index f223c145d..51e5d70e5 100644 --- a/docs/man/man3/userrec.3 +++ b/docs/man/man3/userrec.3 @@ -1,4 +1,4 @@ -.TH "userrec" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "userrec" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -100,6 +100,10 @@ Inherits \fBconnection\fP. .RI "bool \fBdns_done\fP" .br .RI "\fITrue when \fBDNS\fP lookups are completed. \fP" +.ti -1c +.RI "unsigned long \fBpingmax\fP" +.br +.RI "\fINumber of seconds between PINGs for this user (set from <connect:allow> tag. \fP" .in -1c .SS "Private Attributes" @@ -115,7 +119,7 @@ Holds all information about a user This class stores all information about a use Everything about a connection is stored here primarily, from the user's socket ID (file descriptor) through to the user's nickname and hostname. Use the Find method of the server class to locate a specific user by nickname. .PP -Definition at line 89 of file users.h. +Definition at line 93 of file users.h. .SH "Constructor & Destructor Documentation" .PP .SS "userrec::userrec ()" @@ -154,10 +158,10 @@ References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, .fi .SS "virtual userrec::~\fBuserrec\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 164 of file users.h. +Definition at line 172 of file users.h. .PP .nf -164 { } +172 { } .fi .SH "Member Function Documentation" .PP @@ -308,72 +312,75 @@ References DEBUG, and invites. .PP .SS "char \fBuserrec::awaymsg\fP[512]" .PP -The user's away message. If this string is empty, the user is not marked as away.Definition at line 132 of file users.h. +The user's away message. If this string is empty, the user is not marked as away.Definition at line 136 of file users.h. .PP Referenced by userrec(). .SS "\fBucrec\fP \fBuserrec::chans\fP[MAXCHANS]" .PP -Definition at line 123 of file users.h. +Definition at line 127 of file users.h. .PP Referenced by userrec(). .SS "char \fBuserrec::dhost\fP[256]" .PP -The host displayed to non-opers (used for cloaking etc). This usually matches the value of \fBuserrec::host\fP.Definition at line 111 of file users.h. +The host displayed to non-opers (used for cloaking etc). This usually matches the value of \fBuserrec::host\fP.Definition at line 115 of file users.h. .PP Referenced by GetFullHost(), and userrec(). .SS "bool \fBuserrec::dns_done\fP" .PP -True when \fBDNS\fP lookups are completed. Definition at line 160 of file users.h. +True when \fBDNS\fP lookups are completed. Definition at line 164 of file users.h. .PP Referenced by userrec(). .SS "int \fBuserrec::flood\fP" .PP -Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood. Definition at line 143 of file users.h. +Number of lines the user can place into the buffer (up to the global NetBufferSize bytes) before they are disconnected for excess flood. Definition at line 147 of file users.h. .PP Referenced by userrec(). .SS "char \fBuserrec::fullname\fP[128]" .PP -The users full name. Definition at line 115 of file users.h. +The users full name. Definition at line 119 of file users.h. .PP Referenced by userrec(). .SS "char \fBuserrec::ident\fP[64]" .PP -The users ident reply. Definition at line 106 of file users.h. +The users ident reply. Definition at line 110 of file users.h. .PP Referenced by GetFullHost(), GetFullRealHost(), and userrec(). .SS "\fBInvitedList\fP \fBuserrec::invites\fP\fC [private]\fP" .PP -A list of channels the user has a pending invite to. Definition at line 95 of file users.h. +A list of channels the user has a pending invite to. Definition at line 99 of file users.h. .PP Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec(). .SS "char \fBuserrec::modes\fP[MAXBUF]" .PP -The user's mode string. This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit.Definition at line 121 of file users.h. +The user's mode string. This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit.Definition at line 125 of file users.h. .PP Referenced by userrec(). .SS "char \fBuserrec::nick\fP[NICKMAX]" .PP -The users nickname. An invalid nickname indicates an unregistered connection prior to the NICK command.Definition at line 102 of file users.h. +The users nickname. An invalid nickname indicates an unregistered connection prior to the NICK command.Definition at line 106 of file users.h. .PP Referenced by ConfigReader::DumpErrors(), GetFullHost(), GetFullRealHost(), Server::QuitUser(), and userrec(). .SS "char \fBuserrec::oper\fP[NICKMAX]" .PP -The oper type they logged in as, if they are an oper. This is used to check permissions in operclasses, so that we can say 'yay' or 'nay' to any commands they issue. The value of this is the value of a valid 'type name=' tag.Definition at line 156 of file users.h. +The oper type they logged in as, if they are an oper. This is used to check permissions in operclasses, so that we can say 'yay' or 'nay' to any commands they issue. The value of this is the value of a valid 'type name=' tag.Definition at line 160 of file users.h. .PP Referenced by userrec(). +.SS "unsigned long \fBuserrec::pingmax\fP" +.PP +Number of seconds between PINGs for this user (set from <connect:allow> tag. Definition at line 168 of file users.h. .SS "char \fBuserrec::result\fP[256]" .PP -Stores the result of the last GetFullHost or GetRealHost call. You may use this to increase the speed of use of this class.Definition at line 137 of file users.h. +Stores the result of the last GetFullHost or GetRealHost call. You may use this to increase the speed of use of this class.Definition at line 141 of file users.h. .PP Referenced by GetFullHost(), GetFullRealHost(), and userrec(). .SS "char \fBuserrec::server\fP[256]" .PP -The server the user is connected to. Definition at line 127 of file users.h. +The server the user is connected to. Definition at line 131 of file users.h. .PP Referenced by userrec(). .SS "unsigned long \fBuserrec::timeout\fP" .PP -Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected. Definition at line 149 of file users.h. +Number of seconds this user is given to send USER/NICK If they do not send their details in this time limit they will be disconnected. Definition at line 153 of file users.h. .PP Referenced by userrec(). diff --git a/docs/man/man3/users.cpp.3 b/docs/man/man3/users.cpp.3 index f33f24c81..dac38dea5 100644 --- a/docs/man/man3/users.cpp.3 +++ b/docs/man/man3/users.cpp.3 @@ -1,4 +1,4 @@ -.TH "users.cpp" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.cpp" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/users.h.3 b/docs/man/man3/users.h.3 index c9c548862..c515cd5de 100644 --- a/docs/man/man3/users.h.3 +++ b/docs/man/man3/users.h.3 @@ -1,4 +1,4 @@ -.TH "users.h" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -91,10 +91,10 @@ Definition at line 28 of file users.h. .PP .SS "typedef std::vector<\fBConnectClass\fP> \fBClassVector\fP" .PP -Holds a complete list of all allow and deny tags from the configuration file (connection classes). Definition at line 81 of file users.h. +Holds a complete list of all allow and deny tags from the configuration file (connection classes). Definition at line 85 of file users.h. .SS "typedef std::vector<\fBInvited\fP> \fBInvitedList\fP" .PP -Holds a complete list of all channels to which a user has been invited and has not yet joined. Definition at line 75 of file users.h. +Holds a complete list of all channels to which a user has been invited and has not yet joined. Definition at line 79 of file users.h. .SH "Author" .PP Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/xline.h.3 b/docs/man/man3/xline.h.3 index 738d84d05..d25646cd9 100644 --- a/docs/man/man3/xline.h.3 +++ b/docs/man/man3/xline.h.3 @@ -1,4 +1,4 @@ -.TH "xline.h" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "xline.h" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME |