From 88dd74fc84b574f17673338c6d42123570f464da Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 12 May 2005 23:06:51 +0000 Subject: Added docs for new smaller memory footprint classes git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1371 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classconnection.html | 262 ++++++++++------------------------- 1 file changed, 72 insertions(+), 190 deletions(-) (limited to 'docs/module-doc/classconnection.html') diff --git a/docs/module-doc/classconnection.html b/docs/module-doc/classconnection.html index 784fc69e3..0a13449ff 100644 --- a/docs/module-doc/classconnection.html +++ b/docs/module-doc/classconnection.html @@ -23,10 +23,10 @@ Inherited by serverrec, and bool CreateListener (char *host, int p)  Create a listening socket on 'host' using port number 'p'.

-bool BeginLink (char *targethost, int port, char *password, char *servername, int myport) +bool BeginLink (char *targethost, int port, char *password, char *servername, int myport)  Begin an outbound link to another ircd at targethost.

-bool MeshCookie (char *targethost, int port, unsigned long cookie, char *servername) +bool MeshCookie (char *targethost, int port, unsigned long cookie, char *servername)  Begin an outbound mesh link to another ircd on a network you are already an authenticated member of.

void TerminateLink (char *targethost) @@ -48,60 +48,48 @@ Inherited by serverrec, and int fd  File descriptor of the connection.

-char host [256] +char host [160]  Hostname of connection.

-char ip [32] +char ip [16]  IP of connection.

-char inbuf [MAXBUF] +long bytes_in - Inbuf of connection.

-long bytes_in + Stats counter for bytes inbound.

+long bytes_out - Stats counter for bytes inbound.

-long bytes_out + Stats counter for bytes outbound.

+long cmds_in - Stats counter for bytes outbound.

-long cmds_in + Stats counter for commands inbound.

+long cmds_out - Stats counter for commands inbound.

-long cmds_out + Stats counter for commands outbound.

+bool haspassed - Stats counter for commands outbound.

-bool haspassed + True if server/user has authenticated, false if otherwise.

+int port - True if server/user has authenticated, false if otherwise.

-int port + Port number For a userrec, this is the port they connected to the network on.

+char registered - Port number For a userrec, this is the port they connected to the network on.

-int registered + Used by userrec to indicate the registration status of the connection.

+time_t lastping - Used by userrec to indicate the registration status of the connection.

-short int state + Time the connection was last pinged.

+time_t signon - Reserved for future use.

-time_t lastping + Time the connection was created, set in the constructor.

+time_t idle_lastmsg - Time the connection was last pinged.

-time_t signon + Time that the connection last sent data, used to calculate idle time.

+time_t nping - Time the connection was created, set in the constructor.

-time_t idle_lastmsg + Used by PING checks with clients.

+std::vector< ircd_connector > connectors - Time that the connection last sent data, used to calculate idle time.

-time_t nping - - Used by PING checks with clients.

-char internal_addr [MAXBUF] - - Unused, will be removed in a future alpha/beta.

-int internal_port - - Unused, will be removed in a future alpha/beta.

-std::vector< ircd_connector > connectors - - With a serverrec, this is a list of all established server connections.

+ With a serverrec, this is a list of all established server connections.

Detailed Description

Please note: classes serverrec and userrec both inherit from class connection. @@ -479,13 +467,13 @@ Terminate a link to 'targethost' by calling the

+

@@ -502,18 +490,18 @@ Stats counter for bytes inbound.

-Definition at line 231 of file connection.h. +Definition at line 227 of file connection.h.

Referenced by userrec::userrec().

-
long connection::bytes_in + long connection::bytes_in
-

+

@@ -530,18 +518,18 @@ Stats counter for bytes outbound.

-Definition at line 235 of file connection.h. +Definition at line 231 of file connection.h.

-Referenced by userrec::FlushWriteBuf(), and userrec::userrec(). +Referenced by userrec::FlushWriteBuf(), and userrec::userrec().

-
long connection::bytes_out + long connection::bytes_out
-

+

@@ -558,18 +546,18 @@ Stats counter for commands inbound.

-Definition at line 239 of file connection.h. +Definition at line 235 of file connection.h.

Referenced by userrec::userrec().

-
long connection::cmds_in + long connection::cmds_in
-

+

@@ -586,18 +574,18 @@ Stats counter for commands outbound.

-Definition at line 243 of file connection.h. +Definition at line 239 of file connection.h.

-Referenced by userrec::FlushWriteBuf(), and userrec::userrec(). +Referenced by userrec::FlushWriteBuf(), and userrec::userrec().

-
long connection::cmds_out + long connection::cmds_out
-

+

@@ -614,7 +602,7 @@ With a serverrec, this is a list of all established server connections.

With a userrec this is unused.

-Definition at line 290 of file connection.h. +Definition at line 274 of file connection.h.

-
std::vector<ircd_connector> connection::connectors + std::vector<ircd_connector> connection::connectors

@@ -642,16 +630,16 @@ File descriptor of the connection.

Definition at line 215 of file connection.h.

-Referenced by ConfigReader::DumpErrors(), Server::PseudoToUser(), Server::SendTo(), serverrec::serverrec(), userrec::userrec(), and Server::UserToPseudo(). +Referenced by ConfigReader::DumpErrors(), Server::PseudoToUser(), Server::SendTo(), serverrec::serverrec(), userrec::userrec(), and Server::UserToPseudo(). -

+

@@ -668,7 +656,7 @@ True if server/user has authenticated, false if otherwise.

-Definition at line 247 of file connection.h. +Definition at line 243 of file connection.h.

Referenced by userrec::userrec(). @@ -679,7 +667,7 @@ Referenced by userrec::userre

@@ -698,16 +686,16 @@ Not used if this is a serverrec

Definition at line 219 of file connection.h.

-Referenced by userrec::GetFullRealHost(), Server::PseudoToUser(), userrec::userrec(), and Server::UserToPseudo(). +Referenced by userrec::GetFullRealHost(), Server::PseudoToUser(), userrec::userrec(), and Server::UserToPseudo().

-
bool connection::haspassed + bool connection::haspassed
-
char connection::host[256] + char connection::host[160]
-

+

@@ -724,98 +712,18 @@ Time that the connection last sent data, used to calculate idle time.

-Definition at line 273 of file connection.h. -

-Referenced by userrec::userrec(). - -

-
time_t connection::idle_lastmsg + time_t connection::idle_lastmsg
-

- - - - -
- - -
char connection::inbuf[MAXBUF] -
-
- - - -
-   - - -

-Inbuf of connection. -

-Only used for userrec -

-Definition at line 227 of file connection.h. +Definition at line 265 of file connection.h.

Referenced by userrec::userrec().

-

- - - - -
- - -
char connection::internal_addr[MAXBUF] -
-
- - - - - -
-   - - -

-Unused, will be removed in a future alpha/beta. -

- -

-Definition at line 281 of file connection.h.

-

- - - - -
- - -
int connection::internal_port -
-
- - - - - -
-   - - -

-Unused, will be removed in a future alpha/beta. -

- -

-Definition at line 285 of file connection.h.

@@ -830,20 +738,20 @@ Definition at line 285

IP of connection.

-Reserved for future use. +

Definition at line 223 of file connection.h.

Referenced by userrec::userrec().

-
char connection::ip[32] + char connection::ip[16]
-

+

@@ -860,18 +768,18 @@ Time the connection was last pinged.

-Definition at line 265 of file connection.h. +Definition at line 257 of file connection.h.

Referenced by serverrec::serverrec(), and userrec::userrec().

-
time_t connection::lastping + time_t connection::lastping
-

+

@@ -888,18 +796,18 @@ Used by PING checks with clients.

-Definition at line 277 of file connection.h. +Definition at line 269 of file connection.h.

Referenced by userrec::userrec().

-
time_t connection::nping + time_t connection::nping
-

+

@@ -916,18 +824,18 @@ Port number For a userrec, this is the port they connected to the network on.

For a serverrec this is the current listening port of the serverrec object.

-Definition at line 253 of file connection.h. +Definition at line 249 of file connection.h.

Referenced by userrec::userrec().

-
int connection::port + int connection::port
-

+

@@ -944,18 +852,18 @@ Used by userrec to indicate the registration status of the connection.

-Definition at line 257 of file connection.h. +Definition at line 253 of file connection.h.

Referenced by userrec::userrec().

-
int connection::registered + char connection::registered
-

+

@@ -972,40 +880,14 @@ Time the connection was created, set in the constructor.

-Definition at line 269 of file connection.h. +Definition at line 261 of file connection.h.

Referenced by serverrec::serverrec(), and userrec::userrec().

-
time_t connection::signon + time_t connection::signon
-

- - - - -
- - -
short int connection::state -
-
- - - - - -
-   - - -

-Reserved for future use. -

- -

-Definition at line 261 of file connection.h.

The documentation for this class was generated from the following file: -
Generated on Thu May 12 02:25:20 2005 for InspIRCd by +
Generated on Thu May 12 22:59:02 2005 for InspIRCd by doxygen 1.3.3
-- cgit v1.2.3