diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-04-02 19:28:32 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-04-02 19:28:32 +0000 |
| commit | 4705381691cba08c7d3e6ef982e2335bb7672960 (patch) | |
| tree | 106520219a09d42534fccdff7fdff4b9504793f9 /docs/man/man3 | |
| parent | e877fb41803c301e28179bcd52d9912ebd37dc93 (diff) | |
Added DNS class to documentation
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@952 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/man/man3')
54 files changed, 432 insertions, 162 deletions
diff --git a/docs/man/man3/Admin.3 b/docs/man/man3/Admin.3 index 7fcf1ee74..5136dc6c1 100644 --- a/docs/man/man3/Admin.3 +++ b/docs/man/man3/Admin.3 @@ -1,4 +1,4 @@ -.TH "Admin" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "Admin" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/BanItem.3 b/docs/man/man3/BanItem.3 index aa95d518e..d89113e36 100644 --- a/docs/man/man3/BanItem.3 +++ b/docs/man/man3/BanItem.3 @@ -1,4 +1,4 @@ -.TH "BanItem" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "BanItem" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ConfigReader.3 b/docs/man/man3/ConfigReader.3 index 014c3ff9e..6a0065cfe 100644 --- a/docs/man/man3/ConfigReader.3 +++ b/docs/man/man3/ConfigReader.3 @@ -1,4 +1,4 @@ -.TH "ConfigReader" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConfigReader" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ConnectClass.3 b/docs/man/man3/ConnectClass.3 index 6c9646c36..9f3d55c37 100644 --- a/docs/man/man3/ConnectClass.3 +++ b/docs/man/man3/ConnectClass.3 @@ -1,4 +1,4 @@ -.TH "ConnectClass" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ConnectClass" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/DNS.3 b/docs/man/man3/DNS.3 new file mode 100644 index 000000000..f73724fba --- /dev/null +++ b/docs/man/man3/DNS.3 @@ -0,0 +1,197 @@ +.TH "DNS" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.ad l +.nh +.SH NAME +DNS \- The DNS class allows fast nonblocking resolution of hostnames and ip addresses. + +.PP +.SH SYNOPSIS +.br +.PP +\fC#include <dns.h>\fP +.PP +.SS "Public Member Functions" + +.in +1c +.ti -1c +.RI "\fBDNS\fP ()" +.br +.RI "\fIThe default constructor uses dns addresses read from /etc/resolv.conf. \fP" +.ti -1c +.RI "\fBDNS\fP (std::string dnsserver)" +.br +.RI "\fIThis constructor accepts a dns server address. \fP" +.ti -1c +.RI "\fB~DNS\fP ()" +.br +.RI "\fIThe destructor frees all used structures. \fP" +.ti -1c +.RI "bool \fBReverseLookup\fP (std::string ip)" +.br +.RI "\fIThis method will start the reverse lookup of an ip given in dotted decimal format, e.g. \fP" +.ti -1c +.RI "bool \fBForwardLookup\fP (std::string host)" +.br +.RI "\fIThis method will start the forward lookup of a hostname, e.g. \fP" +.ti -1c +.RI "bool \fBHasResult\fP ()" +.br +.RI "\fIThis method will return true when the lookup is completed. \fP" +.ti -1c +.RI "std::string \fBGetResult\fP ()" +.br +.RI "\fIThis method returns the result of your query as a string, depending upon wether you called \fBDNS::ReverseLookup()\fP or \fBDNS::ForwardLookup\fP. \fP" +.ti -1c +.RI "int \fBGetFD\fP ()" +.br +.RI "\fIThis method returns the file handle used by the dns query socket or zero if the query is invalid for some reason, e.g. \fP" +.in -1c +.SS "Private Member Functions" + +.in +1c +.ti -1c +.RI "void \fBdns_init\fP ()" +.br +.ti -1c +.RI "void \fBdns_init_2\fP (const char *dnsserver)" +.br +.ti -1c +.RI "in_addr * \fBdns_aton4\fP (const char *const ipstring)" +.br +.ti -1c +.RI "char * \fBdns_ntoa4\fP (const in_addr *const ip)" +.br +.ti -1c +.RI "int \fBdns_getip4\fP (const char *const name)" +.br +.ti -1c +.RI "int \fBdns_getip4list\fP (const char *const name)" +.br +.ti -1c +.RI "int \fBdns_getname4\fP (const in_addr *const ip)" +.br +.ti -1c +.RI "char * \fBdns_getresult\fP (const int \fBfd\fP)" +.br +.ti -1c +.RI "in_addr * \fBdns_aton4_s\fP (const char *const ipstring, in_addr *const ip)" +.br +.ti -1c +.RI "char * \fBdns_ntoa4_s\fP (const in_addr *const ip, char *const \fBresult\fP)" +.br +.ti -1c +.RI "char * \fBdns_getresult_s\fP (const int \fBfd\fP, char *const \fBresult\fP)" +.br +.ti -1c +.RI "in_addr * \fBdns_aton4_r\fP (const char *const ipstring)" +.br +.ti -1c +.RI "char * \fBdns_ntoa4_r\fP (const in_addr *const ip)" +.br +.ti -1c +.RI "char * \fBdns_getresult_r\fP (const int \fBfd\fP)" +.br +.in -1c +.SS "Private Attributes" + +.in +1c +.ti -1c +.RI "char * \fBresult\fP" +.br +.ti -1c +.RI "in_addr * \fBbinip\fP" +.br +.ti -1c +.RI "int \fBt\fP" +.br +.ti -1c +.RI "int \fBi\fP" +.br +.ti -1c +.RI "unsigned int \fBfd\fP" +.br +.in -1c +.SH "Detailed Description" +.PP +The DNS class allows fast nonblocking resolution of hostnames and ip addresses. + +It is based heavily upon firedns by Ian Gulliver. +.PP +Definition at line 35 of file dns.h. +.SH "Constructor & Destructor Documentation" +.PP +.SS "DNS::DNS ()" +.PP +The default constructor uses dns addresses read from /etc/resolv.conf. Please note that it will re-read /etc/resolv.conf for each copy of the class you instantiate, causing disk access and slow lookups if you create a lot of them. Consider passing the constructor a server address as a parameter instead. +.SS "DNS::DNS (std::string dnsserver)" +.PP +This constructor accepts a dns server address. The address must be in dotted decimal form, e.g. 1.2.3.4. +.SS "DNS::~\fBDNS\fP ()" +.PP +The destructor frees all used structures. +.SH "Member Function Documentation" +.PP +.SS "in_addr* DNS::dns_aton4 (const char *const ipstring)\fC [private]\fP" +.PP +.SS "in_addr* DNS::dns_aton4_r (const char *const ipstring)\fC [private]\fP" +.PP +.SS "in_addr* DNS::dns_aton4_s (const char *const ipstring, in_addr *const ip)\fC [private]\fP" +.PP +.SS "int DNS::dns_getip4 (const char *const name)\fC [private]\fP" +.PP +.SS "int DNS::dns_getip4list (const char *const name)\fC [private]\fP" +.PP +.SS "int DNS::dns_getname4 (const in_addr *const ip)\fC [private]\fP" +.PP +.SS "char* DNS::dns_getresult (const int fd)\fC [private]\fP" +.PP +.SS "char* DNS::dns_getresult_r (const int fd)\fC [private]\fP" +.PP +.SS "char* DNS::dns_getresult_s (const int fd, char *const result)\fC [private]\fP" +.PP +.SS "void DNS::dns_init ()\fC [private]\fP" +.PP +.SS "void DNS::dns_init_2 (const char * dnsserver)\fC [private]\fP" +.PP +.SS "char* DNS::dns_ntoa4 (const in_addr *const ip)\fC [private]\fP" +.PP +.SS "char* DNS::dns_ntoa4_r (const in_addr *const ip)\fC [private]\fP" +.PP +.SS "char* DNS::dns_ntoa4_s (const in_addr *const ip, char *const result)\fC [private]\fP" +.PP +.SS "bool DNS::ForwardLookup (std::string host)" +.PP +This method will start the forward lookup of a hostname, e.g. www.inspircd.org, and returns true if the lookup was successfully initiated. +.SS "int DNS::GetFD ()" +.PP +This method returns the file handle used by the dns query socket or zero if the query is invalid for some reason, e.g. the dns server not responding. +.SS "std::string DNS::GetResult ()" +.PP +This method returns the result of your query as a string, depending upon wether you called \fBDNS::ReverseLookup()\fP or \fBDNS::ForwardLookup\fP. +.SS "bool DNS::HasResult ()" +.PP +This method will return true when the lookup is completed. It uses poll internally to determine the status of the socket. +.SS "bool DNS::ReverseLookup (std::string ip)" +.PP +This method will start the reverse lookup of an ip given in dotted decimal format, e.g. 1.2.3.4, and returns true if the lookup was successfully initiated. +.SH "Member Data Documentation" +.PP +.SS "in_addr* \fBDNS::binip\fP\fC [private]\fP" +.PP +Definition at line 39 of file dns.h. +.SS "unsigned int \fBDNS::fd\fP\fC [private]\fP" +.PP +Definition at line 42 of file dns.h. +.SS "int \fBDNS::i\fP\fC [private]\fP" +.PP +Definition at line 40 of file dns.h. +.SS "char* \fBDNS::result\fP\fC [private]\fP" +.PP +Definition at line 38 of file dns.h. +.SS "int \fBDNS::t\fP\fC [private]\fP" +.PP +Definition at line 40 of file dns.h. + +.SH "Author" +.PP +Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/ExemptItem.3 b/docs/man/man3/ExemptItem.3 index 7015b6ac8..120febbc9 100644 --- a/docs/man/man3/ExemptItem.3 +++ b/docs/man/man3/ExemptItem.3 @@ -1,4 +1,4 @@ -.TH "ExemptItem" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExemptItem" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ExtMode.3 b/docs/man/man3/ExtMode.3 index e8b2efc37..b43786de2 100644 --- a/docs/man/man3/ExtMode.3 +++ b/docs/man/man3/ExtMode.3 @@ -1,4 +1,4 @@ -.TH "ExtMode" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ExtMode" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Extensible.3 b/docs/man/man3/Extensible.3 index edfabcddf..9b735c22f 100644 --- a/docs/man/man3/Extensible.3 +++ b/docs/man/man3/Extensible.3 @@ -1,4 +1,4 @@ -.TH "Extensible" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "Extensible" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3 index 48adcd0d4..3cb35ebd7 100644 --- a/docs/man/man3/FileReader.3 +++ b/docs/man/man3/FileReader.3 @@ -1,4 +1,4 @@ -.TH "FileReader" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "FileReader" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/GLine.3 b/docs/man/man3/GLine.3 index 46ffa4850..3fc99ec2b 100644 --- a/docs/man/man3/GLine.3 +++ b/docs/man/man3/GLine.3 @@ -1,4 +1,4 @@ -.TH "GLine" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "GLine" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/HostItem.3 b/docs/man/man3/HostItem.3 index 11abe5702..f176b6c9b 100644 --- a/docs/man/man3/HostItem.3 +++ b/docs/man/man3/HostItem.3 @@ -1,4 +1,4 @@ -.TH "HostItem" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "HostItem" 3 "2 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 09b2ac2f8..e6f60886b 100644 --- a/docs/man/man3/InAddr_HashComp.3 +++ b/docs/man/man3/InAddr_HashComp.3 @@ -1,4 +1,4 @@ -.TH "InAddr_HashComp" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "InAddr_HashComp" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/InviteItem.3 b/docs/man/man3/InviteItem.3 index 06220485b..6581c363f 100644 --- a/docs/man/man3/InviteItem.3 +++ b/docs/man/man3/InviteItem.3 @@ -1,4 +1,4 @@ -.TH "InviteItem" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "InviteItem" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Invited.3 b/docs/man/man3/Invited.3 index eeac38031..19f5d7964 100644 --- a/docs/man/man3/Invited.3 +++ b/docs/man/man3/Invited.3 @@ -1,4 +1,4 @@ -.TH "Invited" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "Invited" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/KLine.3 b/docs/man/man3/KLine.3 index a5eeaf01e..a63b3ce13 100644 --- a/docs/man/man3/KLine.3 +++ b/docs/man/man3/KLine.3 @@ -1,4 +1,4 @@ -.TH "KLine" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "KLine" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ModeParameter.3 b/docs/man/man3/ModeParameter.3 index c17d1015f..3306c65f4 100644 --- a/docs/man/man3/ModeParameter.3 +++ b/docs/man/man3/ModeParameter.3 @@ -1,4 +1,4 @@ -.TH "ModeParameter" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModeParameter" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Module.3 b/docs/man/man3/Module.3 index 60239b1da..3db75227e 100644 --- a/docs/man/man3/Module.3 +++ b/docs/man/man3/Module.3 @@ -1,4 +1,4 @@ -.TH "Module" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "Module" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ModuleFactory.3 b/docs/man/man3/ModuleFactory.3 index f97975e77..c209bc48a 100644 --- a/docs/man/man3/ModuleFactory.3 +++ b/docs/man/man3/ModuleFactory.3 @@ -1,4 +1,4 @@ -.TH "ModuleFactory" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ModuleFactory" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/QLine.3 b/docs/man/man3/QLine.3 index d2348dfb6..e563152c3 100644 --- a/docs/man/man3/QLine.3 +++ b/docs/man/man3/QLine.3 @@ -1,4 +1,4 @@ -.TH "QLine" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "QLine" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Server.3 b/docs/man/man3/Server.3 index 4a1d87703..a41d9992a 100644 --- a/docs/man/man3/Server.3 +++ b/docs/man/man3/Server.3 @@ -1,4 +1,4 @@ -.TH "Server" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "Server" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/StrHashComp.3 b/docs/man/man3/StrHashComp.3 index 8075bdb0b..46cbfc684 100644 --- a/docs/man/man3/StrHashComp.3 +++ b/docs/man/man3/StrHashComp.3 @@ -1,4 +1,4 @@ -.TH "StrHashComp" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "StrHashComp" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/Version.3 b/docs/man/man3/Version.3 index 5985dbbdd..c2de24cbc 100644 --- a/docs/man/man3/Version.3 +++ b/docs/man/man3/Version.3 @@ -1,4 +1,4 @@ -.TH "Version" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "Version" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/XLine.3 b/docs/man/man3/XLine.3 index 3d5b6054f..f826b07f1 100644 --- a/docs/man/man3/XLine.3 +++ b/docs/man/man3/XLine.3 @@ -1,4 +1,4 @@ -.TH "XLine" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "XLine" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ZLine.3 b/docs/man/man3/ZLine.3 index 32e769183..83789ac14 100644 --- a/docs/man/man3/ZLine.3 +++ b/docs/man/man3/ZLine.3 @@ -1,4 +1,4 @@ -.TH "ZLine" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ZLine" 3 "2 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 52cdcb283..e3a22b878 100644 --- a/docs/man/man3/base.h.3 +++ b/docs/man/man3/base.h.3 @@ -1,4 +1,4 @@ -.TH "base.h" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "base.h" 3 "2 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 5ec80e496..c78d20ccd 100644 --- a/docs/man/man3/channels.cpp.3 +++ b/docs/man/man3/channels.cpp.3 @@ -1,4 +1,4 @@ -.TH "channels.cpp" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.cpp" 3 "2 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 6049c3b97..b7741ef34 100644 --- a/docs/man/man3/channels.h.3 +++ b/docs/man/man3/channels.h.3 @@ -1,4 +1,4 @@ -.TH "channels.h" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "channels.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/chanrec.3 b/docs/man/man3/chanrec.3 index 1df9f409e..9c34f89f5 100644 --- a/docs/man/man3/chanrec.3 +++ b/docs/man/man3/chanrec.3 @@ -1,4 +1,4 @@ -.TH "chanrec" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "chanrec" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/classbase.3 b/docs/man/man3/classbase.3 index 224750ca6..c2be7ecc6 100644 --- a/docs/man/man3/classbase.3 +++ b/docs/man/man3/classbase.3 @@ -1,4 +1,4 @@ -.TH "classbase" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "classbase" 3 "2 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 66e93853b..1ca49d97f 100644 --- a/docs/man/man3/command_t.3 +++ b/docs/man/man3/command_t.3 @@ -1,4 +1,4 @@ -.TH "command_t" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "command_t" 3 "2 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 84ac9f721..064913891 100644 --- a/docs/man/man3/commands.h.3 +++ b/docs/man/man3/commands.h.3 @@ -1,4 +1,4 @@ -.TH "commands.h" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "commands.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/connection.3 b/docs/man/man3/connection.3 index bfac322a2..51123dc92 100644 --- a/docs/man/man3/connection.3 +++ b/docs/man/man3/connection.3 @@ -1,4 +1,4 @@ -.TH "connection" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection" 3 "2 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 60cae1c8c..85798d51e 100644 --- a/docs/man/man3/connection.h.3 +++ b/docs/man/man3/connection.h.3 @@ -1,4 +1,4 @@ -.TH "connection.h" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection.h" 3 "2 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 97dcca9bd..2d7b20a28 100644 --- a/docs/man/man3/ctables.h.3 +++ b/docs/man/man3/ctables.h.3 @@ -1,4 +1,4 @@ -.TH "ctables.h" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ctables.h" 3 "2 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 new file mode 100644 index 000000000..104d3d407 --- /dev/null +++ b/docs/man/man3/dns.h.3 @@ -0,0 +1,31 @@ +.TH "dns.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.ad l +.nh +.SH NAME +dns.h \- +.SH SYNOPSIS +.br +.PP +\fC#include <sys/types.h>\fP +.br +\fC#include <sys/socket.h>\fP +.br +\fC#include <netinet/in.h>\fP +.br +\fC#include <string>\fP +.br + +.SS "Compounds" + +.in +1c +.ti -1c +.RI "class \fBDNS\fP" +.br +.RI "\fIThe DNS class allows fast nonblocking resolution of hostnames and ip addresses. \fP" +.ti -1c +.RI "struct \fBdns_ip4list\fP" +.br +.in -1c +.SH "Author" +.PP +Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/dns_ip4list.3 b/docs/man/man3/dns_ip4list.3 new file mode 100644 index 000000000..df12a2e34 --- /dev/null +++ b/docs/man/man3/dns_ip4list.3 @@ -0,0 +1,32 @@ +.TH "dns_ip4list" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- +.ad l +.nh +.SH NAME +dns_ip4list \- +.SH SYNOPSIS +.br +.PP +\fC#include <dns.h>\fP +.PP +.SS "Public Attributes" + +.in +1c +.ti -1c +.RI "in_addr \fBip\fP" +.br +.ti -1c +.RI "\fBdns_ip4list\fP * \fBnext\fP" +.br +.in -1c +.SH "Member Data Documentation" +.PP +.SS "in_addr \fBdns_ip4list::ip\fP" +.PP +Definition at line 27 of file dns.h. +.SS "\fBdns_ip4list\fP* \fBdns_ip4list::next\fP" +.PP +Definition at line 28 of file dns.h. + +.SH "Author" +.PP +Generated automatically by Doxygen for InspIRCd from the source code. diff --git a/docs/man/man3/ircd_connector.3 b/docs/man/man3/ircd_connector.3 index 4e798af32..c3ab7cd80 100644 --- a/docs/man/man3/ircd_connector.3 +++ b/docs/man/man3/ircd_connector.3 @@ -1,4 +1,4 @@ -.TH "ircd_connector" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ircd_connector" 3 "2 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 6cff66abd..71da5e323 100644 --- a/docs/man/man3/message.h.3 +++ b/docs/man/man3/message.h.3 @@ -1,4 +1,4 @@ -.TH "message.h" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "message.h" 3 "2 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 0d31d4cb9..308b4c8ba 100644 --- a/docs/man/man3/mode.h.3 +++ b/docs/man/man3/mode.h.3 @@ -1,4 +1,4 @@ -.TH "mode.h" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "mode.h" 3 "2 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 d6b4d814a..6cd0c1d53 100644 --- a/docs/man/man3/modules.cpp.3 +++ b/docs/man/man3/modules.cpp.3 @@ -1,4 +1,4 @@ -.TH "modules.cpp" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.cpp" 3 "2 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 ab5b6073d..0b756cd74 100644 --- a/docs/man/man3/modules.h.3 +++ b/docs/man/man3/modules.h.3 @@ -1,4 +1,4 @@ -.TH "modules.h" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "modules.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/nspace.3 b/docs/man/man3/nspace.3 index 44fc7b9e1..06233a744 100644 --- a/docs/man/man3/nspace.3 +++ b/docs/man/man3/nspace.3 @@ -1,4 +1,4 @@ -.TH "nspace" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace" 3 "2 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 627f54a1f..ceb957551 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 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< in_addr >" 3 "2 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 da90cbe5f..9e5858072 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 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "nspace::nspace::hash< string >" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/packet.3 b/docs/man/man3/packet.3 index 37efe0bda..75c78921f 100644 --- a/docs/man/man3/packet.3 +++ b/docs/man/man3/packet.3 @@ -1,4 +1,4 @@ -.TH "packet" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "packet" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/serverrec.3 b/docs/man/man3/serverrec.3 index 56b423f27..e84e3877a 100644 --- a/docs/man/man3/serverrec.3 +++ b/docs/man/man3/serverrec.3 @@ -1,4 +1,4 @@ -.TH "serverrec" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "serverrec" 3 "2 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 49b6f9644..43d03344b 100644 --- a/docs/man/man3/servers.cpp.3 +++ b/docs/man/man3/servers.cpp.3 @@ -1,4 +1,4 @@ -.TH "servers.cpp" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.cpp" 3 "2 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 847b2d3e2..c0c76ee9c 100644 --- a/docs/man/man3/servers.h.3 +++ b/docs/man/man3/servers.h.3 @@ -1,4 +1,4 @@ -.TH "servers.h" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "servers.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/std.3 b/docs/man/man3/std.3 index e1c2a2624..fe9a1733e 100644 --- a/docs/man/man3/std.3 +++ b/docs/man/man3/std.3 @@ -1,4 +1,4 @@ -.TH "std" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "std" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/ucrec.3 b/docs/man/man3/ucrec.3 index a10552373..da49bdac2 100644 --- a/docs/man/man3/ucrec.3 +++ b/docs/man/man3/ucrec.3 @@ -1,4 +1,4 @@ -.TH "ucrec" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "ucrec" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/userrec.3 b/docs/man/man3/userrec.3 index d9ea1aa2e..952fcb26c 100644 --- a/docs/man/man3/userrec.3 +++ b/docs/man/man3/userrec.3 @@ -1,4 +1,4 @@ -.TH "userrec" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "userrec" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -96,6 +96,10 @@ Inherits \fBconnection\fP. .RI "char \fBoper\fP [NICKMAX]" .br .RI "\fIThe oper type they logged in as, if they are an oper. \fP" +.ti -1c +.RI "bool \fBdns_done\fP" +.br +.RI "\fITrue when \fBDNS\fP lookups are completed. \fP" .in -1c .SS "Private Attributes" @@ -118,7 +122,7 @@ Definition at line 89 of file users.h. .PP Definition at line 26 of file users.cpp. .PP -References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, dhost, connection::fd, flood, fullname, connection::haspassed, connection::host, ident, connection::idle_lastmsg, connection::inbuf, invites, connection::ip, connection::lastping, modes, nick, connection::nping, oper, connection::port, connection::registered, result, server, connection::signon, timeout, and ucrec::uc_modes. +References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, dhost, dns_done, connection::fd, flood, fullname, connection::haspassed, connection::host, ident, connection::idle_lastmsg, connection::inbuf, invites, connection::ip, connection::lastping, modes, nick, connection::nping, oper, connection::port, connection::registered, result, server, connection::signon, timeout, and ucrec::uc_modes. .PP .nf 27 { @@ -138,166 +142,167 @@ References awaymsg, connection::bytes_in, connection::bytes_out, ucrec::channel, 41 fd = lastping = signon = idle_lastmsg = nping = registered = 0; 42 flood = port = bytes_in = bytes_out = cmds_in = cmds_out = 0; 43 haspassed = false; -44 strcpy(result,''); -45 for (int i = 0; i < MAXCHANS; i++) -46 { -47 this->chans[i].channel = NULL; -48 this->chans[i].uc_modes = 0; -49 } -50 invites.clear(); -51 } +44 dns_done = false; +45 strcpy(result,''); +46 for (int i = 0; i < MAXCHANS; i++) +47 { +48 this->chans[i].channel = NULL; +49 this->chans[i].uc_modes = 0; +50 } +51 invites.clear(); +52 } .fi .SS "virtual userrec::~\fBuserrec\fP ()\fC [inline, virtual]\fP" .PP -Definition at line 160 of file users.h. +Definition at line 164 of file users.h. .PP .nf -160 { } +164 { } .fi .SH "Member Function Documentation" .PP .SS "char * userrec::GetFullHost ()\fC [virtual]\fP" .PP -Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. Definition at line 55 of file users.cpp. +Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. Definition at line 56 of file users.cpp. .PP References dhost, ident, nick, and result. .PP .nf -56 { -57 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost); -58 return result; -59 } +57 { +58 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,dhost); +59 return result; +60 } .fi .SS "char * userrec::GetFullRealHost ()\fC [virtual]\fP" .PP -Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname.Definition at line 62 of file users.cpp. +Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form. If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname.Definition at line 63 of file users.cpp. .PP References connection::host, ident, nick, and result. .PP .nf -63 { -64 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host); -65 return result; -66 } +64 { +65 snprintf(result,MAXBUF,'%s!%s@%s',nick,ident,host); +66 return result; +67 } .fi .SS "bool userrec::HasPermission (char * command)" .PP -Returns true or false for if a user can execute a privilaged oper command. This is done by looking up their oper type from \fBuserrec::oper\fP, then referencing this to their oper classes and checking the commands they can execute.Definition at line 111 of file users.cpp. +Returns true or false for if a user can execute a privilaged oper command. This is done by looking up their oper type from \fBuserrec::oper\fP, then referencing this to their oper classes and checking the commands they can execute.Definition at line 112 of file users.cpp. .PP References config_f, and DEBUG. .PP .nf -112 { -113 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; -114 char* myclass; -115 char* mycmd; -116 char* savept; -117 char* savept2; -118 -119 // are they even an oper at all? -120 if (strchr(this->modes,'o')) -121 { -122 log(DEBUG,'*** HasPermission: %s is an oper',this->nick); -123 for (int j =0; j < ConfValueEnum('type',&config_f); j++) -124 { -125 ConfValue('type','name',j,TypeName,&config_f); -126 if (!strcmp(TypeName,this->oper)) -127 { -128 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper); -129 ConfValue('type','classes',j,Classes,&config_f); -130 char* myclass = strtok_r(Classes,' ',&savept); -131 while (myclass) -132 { -133 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass); -134 for (int k =0; k < ConfValueEnum('class',&config_f); k++) -135 { -136 ConfValue('class','name',k,ClassName,&config_f); -137 if (!strcmp(ClassName,myclass)) -138 { -139 ConfValue('class','commands',k,CommandList,&config_f); -140 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList); -141 +113 { +114 char TypeName[MAXBUF],Classes[MAXBUF],ClassName[MAXBUF],CommandList[MAXBUF]; +115 char* myclass; +116 char* mycmd; +117 char* savept; +118 char* savept2; +119 +120 // are they even an oper at all? +121 if (strchr(this->modes,'o')) +122 { +123 log(DEBUG,'*** HasPermission: %s is an oper',this->nick); +124 for (int j =0; j < ConfValueEnum('type',&config_f); j++) +125 { +126 ConfValue('type','name',j,TypeName,&config_f); +127 if (!strcmp(TypeName,this->oper)) +128 { +129 log(DEBUG,'*** HasPermission: %s is an oper of type '%s'',this->nick,this->oper); +130 ConfValue('type','classes',j,Classes,&config_f); +131 char* myclass = strtok_r(Classes,' ',&savept); +132 while (myclass) +133 { +134 log(DEBUG,'*** HasPermission: checking classtype '%s'',myclass); +135 for (int k =0; k < ConfValueEnum('class',&config_f); k++) +136 { +137 ConfValue('class','name',k,ClassName,&config_f); +138 if (!strcmp(ClassName,myclass)) +139 { +140 ConfValue('class','commands',k,CommandList,&config_f); +141 log(DEBUG,'*** HasPermission: found class named %s with commands: '%s'',ClassName,CommandList); 142 -143 mycmd = strtok_r(CommandList,' ',&savept2); -144 while (mycmd) -145 { -146 if (!strcasecmp(mycmd,command)) -147 { -148 log(DEBUG,'*** Command %s found, returning true',command); -149 return true; -150 } -151 mycmd = strtok_r(NULL,' ',&savept2); -152 } -153 } -154 } -155 myclass = strtok_r(NULL,' ',&savept); -156 } -157 } -158 } -159 } -160 return false; -161 } +143 +144 mycmd = strtok_r(CommandList,' ',&savept2); +145 while (mycmd) +146 { +147 if (!strcasecmp(mycmd,command)) +148 { +149 log(DEBUG,'*** Command %s found, returning true',command); +150 return true; +151 } +152 mycmd = strtok_r(NULL,' ',&savept2); +153 } +154 } +155 } +156 myclass = strtok_r(NULL,' ',&savept); +157 } +158 } +159 } +160 } +161 return false; +162 } .fi .SS "void userrec::InviteTo (char * channel)\fC [virtual]\fP" .PP -Adds a channel to a users invite list (invites them to a channel). Definition at line 82 of file users.cpp. +Adds a channel to a users invite list (invites them to a channel). Definition at line 83 of file users.cpp. .PP References Invited::channel, and invites. .PP .nf -83 { -84 Invited i; -85 strlcpy(i.channel,channel,CHANMAX); -86 invites.push_back(i); -87 } +84 { +85 Invited i; +86 strlcpy(i.channel,channel,CHANMAX); +87 invites.push_back(i); +88 } .fi .SS "bool userrec::IsInvited (char * channel)\fC [virtual]\fP" .PP -Returns true if a user is invited to a channel. Definition at line 68 of file users.cpp. +Returns true if a user is invited to a channel. Definition at line 69 of file users.cpp. .PP References invites. .PP .nf -69 { -70 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -71 { -72 if (i->channel) { -73 if (!strcasecmp(i->channel,channel)) -74 { -75 return true; -76 } -77 } -78 } -79 return false; -80 } +70 { +71 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +72 { +73 if (i->channel) { +74 if (!strcasecmp(i->channel,channel)) +75 { +76 return true; +77 } +78 } +79 } +80 return false; +81 } .fi .SS "void userrec::RemoveInvite (char * channel)\fC [virtual]\fP" .PP -Removes a channel from a users invite list. This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.Definition at line 89 of file users.cpp. +Removes a channel from a users invite list. This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.Definition at line 90 of file users.cpp. .PP References DEBUG, and invites. .PP .nf -90 { -91 log(DEBUG,'Removing invites'); -92 if (channel) -93 { -94 if (invites.size()) -95 { -96 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) -97 { -98 if (i->channel) -99 { -100 if (!strcasecmp(i->channel,channel)) -101 { -102 invites.erase(i); -103 return; -104 } -105 } -106 } -107 } -108 } -109 } +91 { +92 log(DEBUG,'Removing invites'); +93 if (channel) +94 { +95 if (invites.size()) +96 { +97 for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++) +98 { +99 if (i->channel) +100 { +101 if (!strcasecmp(i->channel,channel)) +102 { +103 invites.erase(i); +104 return; +105 } +106 } +107 } +108 } +109 } +110 } .fi .SH "Member Data Documentation" .PP @@ -316,6 +321,11 @@ Referenced by userrec(). 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. .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. +.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. diff --git a/docs/man/man3/users.cpp.3 b/docs/man/man3/users.cpp.3 index d55c5a6d5..ee6bd305f 100644 --- a/docs/man/man3/users.cpp.3 +++ b/docs/man/man3/users.cpp.3 @@ -1,4 +1,4 @@ -.TH "users.cpp" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.cpp" 3 "2 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 d9bff1f1d..a59f1d846 100644 --- a/docs/man/man3/users.h.3 +++ b/docs/man/man3/users.h.3 @@ -1,4 +1,4 @@ -.TH "users.h" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "users.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME diff --git a/docs/man/man3/xline.h.3 b/docs/man/man3/xline.h.3 index 445d39b1e..d7647c7aa 100644 --- a/docs/man/man3/xline.h.3 +++ b/docs/man/man3/xline.h.3 @@ -1,4 +1,4 @@ -.TH "xline.h" 3 "28 Mar 2005" "InspIRCd" \" -*- nroff -*- +.TH "xline.h" 3 "2 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME |