Added docs for new smaller memory footprint classes

[user/henk/code/inspircd.git] / docs / man / man3 / connection.3

diff --git a/docs/man/man3/connection.3 b/docs/man/man3/connection.3
index ce72610f8cce75c433d3cfcf84a27bcf5eef42fd..3ada34c2dbcbcf4b9fcba84fc17d2e2e23b7747c 100644 (file)
--- a/docs/man/man3/connection.3
+++ b/docs/man/man3/connection.3
@@ -62,18 +62,14 @@ Inherited by \fBserverrec\fP, and \fBuserrec\fP.
 .br
 .RI "\fIFile descriptor of the connection. \fP"
 .ti -1c
-.RI "char \fBhost\fP [256]"
+.RI "char \fBhost\fP [160]"
 .br
 .RI "\fIHostname of connection. \fP"
 .ti -1c
-.RI "char \fBip\fP [32]"
+.RI "char \fBip\fP [16]"
 .br
 .RI "\fIIP of connection. \fP"
 .ti -1c
-.RI "char \fBinbuf\fP [MAXBUF]"
-.br
-.RI "\fIInbuf of connection. \fP"
-.ti -1c
 .RI "long \fBbytes_in\fP"
 .br
 .RI "\fIStats counter for bytes inbound. \fP"
@@ -98,14 +94,10 @@ Inherited by \fBserverrec\fP, and \fBuserrec\fP.
 .br
 .RI "\fIPort number For a userrec, this is the port they connected to the network on. \fP"
 .ti -1c
-.RI "int \fBregistered\fP"
+.RI "char \fBregistered\fP"
 .br
 .RI "\fIUsed by userrec to indicate the registration status of the connection. \fP"
 .ti -1c
-.RI "short int \fBstate\fP"
-.br
-.RI "\fIReserved for future use. \fP"
-.ti -1c
 .RI "time_t \fBlastping\fP"
 .br
 .RI "\fITime the connection was last pinged. \fP"
@@ -122,14 +114,6 @@ Inherited by \fBserverrec\fP, and \fBuserrec\fP.
 .br
 .RI "\fIUsed by PING checks with clients. \fP"
 .ti -1c
-.RI "char \fBinternal_addr\fP [MAXBUF]"
-.br
-.RI "\fIUnused, will be removed in a future alpha/beta. \fP"
-.ti -1c
-.RI "int \fBinternal_port\fP"
-.br
-.RI "\fIUnused, will be removed in a future alpha/beta. \fP"
-.ti -1c
 .RI "std::vector< \fBircd_connector\fP > \fBconnectors\fP"
 .br
 .RI "\fIWith a serverrec, this is a list of all established server connections. \fP"
@@ -172,27 +156,27 @@ Terminate a link to 'targethost' by calling the \fBircd_connector::CloseConnecti
 .PP 
 .SS "long \fBconnection::bytes_in\fP"
 .PP
-Stats counter for bytes inbound. Definition at line 231 of file connection.h.
+Stats counter for bytes inbound. Definition at line 227 of file connection.h.
 .PP
 Referenced by userrec::userrec().
 .SS "long \fBconnection::bytes_out\fP"
 .PP
-Stats counter for bytes outbound. Definition at line 235 of file connection.h.
+Stats counter for bytes outbound. Definition at line 231 of file connection.h.
 .PP
 Referenced by userrec::FlushWriteBuf(), and userrec::userrec().
 .SS "long \fBconnection::cmds_in\fP"
 .PP
-Stats counter for commands inbound. Definition at line 239 of file connection.h.
+Stats counter for commands inbound. Definition at line 235 of file connection.h.
 .PP
 Referenced by userrec::userrec().
 .SS "long \fBconnection::cmds_out\fP"
 .PP
-Stats counter for commands outbound. Definition at line 243 of file connection.h.
+Stats counter for commands outbound. Definition at line 239 of file connection.h.
 .PP
 Referenced by userrec::FlushWriteBuf(), and userrec::userrec().
 .SS "std::vector<\fBircd_connector\fP> \fBconnection::connectors\fP"
 .PP
-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.
+With a serverrec, this is a list of all established server connections. With a userrec this is unused.Definition at line 274 of file connection.h.
 .SS "int \fBconnection::fd\fP"
 .PP
 File descriptor of the connection. Definition at line 215 of file connection.h.
@@ -200,63 +184,49 @@ 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().
 .SS "bool \fBconnection::haspassed\fP"
 .PP
-True if server/user has authenticated, false if otherwise. Definition at line 247 of file connection.h.
+True if server/user has authenticated, false if otherwise. Definition at line 243 of file connection.h.
 .PP
 Referenced by userrec::userrec().
-.SS "char \fBconnection::host\fP[256]"
+.SS "char \fBconnection::host\fP[160]"
 .PP
 Hostname of connection. Not used if this is a serverrecDefinition at line 219 of file connection.h.
 .PP
 Referenced by userrec::GetFullRealHost(), Server::PseudoToUser(), userrec::userrec(), and Server::UserToPseudo().
 .SS "time_t \fBconnection::idle_lastmsg\fP"
 .PP
-Time that the connection last sent data, used to calculate idle time. Definition at line 273 of file connection.h.
+Time that the connection last sent data, used to calculate idle time. Definition at line 265 of file connection.h.
 .PP
 Referenced by userrec::userrec().
-.SS "char \fBconnection::inbuf\fP[MAXBUF]"
+.SS "char \fBconnection::ip\fP[16]"
 .PP
-Inbuf of connection. Only used for userrecDefinition at line 227 of file connection.h.
-.PP
-Referenced by userrec::userrec().
-.SS "char \fBconnection::internal_addr\fP[MAXBUF]"
-.PP
-Unused, will be removed in a future alpha/beta. Definition at line 281 of file connection.h.
-.SS "int \fBconnection::internal_port\fP"
-.PP
-Unused, will be removed in a future alpha/beta. Definition at line 285 of file connection.h.
-.SS "char \fBconnection::ip\fP[32]"
-.PP
-IP of connection. Reserved for future use.Definition at line 223 of file connection.h.
+IP of connection. Definition at line 223 of file connection.h.
 .PP
 Referenced by userrec::userrec().
 .SS "time_t \fBconnection::lastping\fP"
 .PP
-Time the connection was last pinged. Definition at line 265 of file connection.h.
+Time the connection was last pinged. Definition at line 257 of file connection.h.
 .PP
 Referenced by serverrec::serverrec(), and userrec::userrec().
 .SS "time_t \fBconnection::nping\fP"
 .PP
-Used by PING checks with clients. Definition at line 277 of file connection.h.
+Used by PING checks with clients. Definition at line 269 of file connection.h.
 .PP
 Referenced by userrec::userrec().
 .SS "int \fBconnection::port\fP"
 .PP
-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.
+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 249 of file connection.h.
 .PP
 Referenced by userrec::userrec().
-.SS "int \fBconnection::registered\fP"
+.SS "char \fBconnection::registered\fP"
 .PP
-Used by userrec to indicate the registration status of the connection. Definition at line 257 of file connection.h.
+Used by userrec to indicate the registration status of the connection. Definition at line 253 of file connection.h.
 .PP
 Referenced by userrec::userrec().
 .SS "time_t \fBconnection::signon\fP"
 .PP
-Time the connection was created, set in the constructor. Definition at line 269 of file connection.h.
+Time the connection was created, set in the constructor. Definition at line 261 of file connection.h.
 .PP
 Referenced by serverrec::serverrec(), and userrec::userrec().
-.SS "short int \fBconnection::state\fP"
-.PP
-Reserved for future use. Definition at line 261 of file connection.h.
 
 .SH "Author"
 .PP