diff options
Diffstat (limited to 'docs/man/man3/connection.3')
-rw-r--r-- | docs/man/man3/connection.3 | 89 |
1 files changed, 67 insertions, 22 deletions
diff --git a/docs/man/man3/connection.3 b/docs/man/man3/connection.3 index cce6dc268..e243173d6 100644 --- a/docs/man/man3/connection.3 +++ b/docs/man/man3/connection.3 @@ -1,4 +1,4 @@ -.TH "connection" 3 "30 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection" 3 "27 Nov 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -12,7 +12,7 @@ connection \- Please note: classes serverrec and userrec both inherit from class .PP Inherits \fBExtensible\fP. .PP -Inherited by \fBserverrec\fP, and \fBuserrec\fP. +Inherited by \fBuserrec\fP. .PP .SS "Public Member Functions" @@ -84,84 +84,129 @@ Inherited by \fBserverrec\fP, and \fBuserrec\fP. .in -1c .SH "Detailed Description" .PP -Please note: classes serverrec and userrec both inherit from class connection. Definition at line 296 of file connection.h. +Please note: classes serverrec and userrec both inherit from class connection. +.PP +Definition at line 37 of file connection.h. .SH "Constructor & Destructor Documentation" .PP -.SS "connection::connection ()" +.SS "connection::connection ()\fC [inline]\fP" .PP Default constructor. +.PP +Definition at line 100 of file connection.h. +.PP +References fd. +.PP +.nf +101 { +102 this->fd = -1; +103 } +.fi +.PP .SH "Member Data Documentation" .PP .SS "int \fBconnection::bytes_in\fP" .PP -Stats counter for bytes inbound. Definition at line 313 of file connection.h. +Stats counter for bytes inbound. +.PP +Definition at line 54 of file connection.h. .PP Referenced by userrec::userrec(). .SS "int \fBconnection::bytes_out\fP" .PP -Stats counter for bytes outbound. Definition at line 317 of file connection.h. +Stats counter for bytes outbound. +.PP +Definition at line 58 of file connection.h. .PP Referenced by userrec::FlushWriteBuf(), and userrec::userrec(). .SS "int \fBconnection::cmds_in\fP" .PP -Stats counter for commands inbound. Definition at line 321 of file connection.h. +Stats counter for commands inbound. +.PP +Definition at line 62 of file connection.h. .PP Referenced by userrec::userrec(). .SS "int \fBconnection::cmds_out\fP" .PP -Stats counter for commands outbound. Definition at line 325 of file connection.h. +Stats counter for commands outbound. +.PP +Definition at line 66 of file connection.h. .PP Referenced by userrec::FlushWriteBuf(), and userrec::userrec(). .SS "int \fBconnection::fd\fP" .PP -File descriptor of the connection. Definition at line 301 of file connection.h. +File descriptor of the connection. .PP -Referenced by serverrec::BeginLink(), serverrec::CreateListener(), ConfigReader::DumpErrors(), serverrec::MeshCookie(), Server::PseudoToUser(), userrec::ReadData(), Server::SendTo(), serverrec::serverrec(), userrec::userrec(), and Server::UserToPseudo(). +Definition at line 42 of file connection.h. +.PP +Referenced by connection(), ConfigReader::DumpErrors(), Server::PseudoToUser(), Server::SendTo(), userrec::userrec(), and Server::UserToPseudo(). .SS "bool \fBconnection::haspassed\fP" .PP -True if server/user has authenticated, false if otherwise. Definition at line 329 of file connection.h. +True if server/user has authenticated, false if otherwise. +.PP +Definition at line 70 of file connection.h. .PP Referenced by userrec::userrec(). .SS "char \fBconnection::host\fP[160]" .PP -Hostname of connection. Not used if this is a serverrecDefinition at line 305 of file connection.h. +Hostname of connection. +.PP +Not used if this is a serverrec +.PP +Definition at line 46 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 351 of file connection.h. +Time that the connection last sent data, used to calculate idle time. +.PP +Definition at line 92 of file connection.h. .PP Referenced by userrec::userrec(). .SS "char \fBconnection::ip\fP[16]" .PP -IP of connection. Definition at line 309 of file connection.h. +IP of connection. +.PP +Definition at line 50 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 343 of file connection.h. +Time the connection was last pinged. .PP -Referenced by serverrec::serverrec(), and userrec::userrec(). +Definition at line 84 of file connection.h. +.PP +Referenced by userrec::userrec(). .SS "time_t \fBconnection::nping\fP" .PP -Used by PING checks with clients. Definition at line 355 of file connection.h. +Used by PING checks with clients. +.PP +Definition at line 96 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 335 of file connection.h. +Port number For a userrec, this is the port they connected to the network on. .PP -Referenced by serverrec::CreateListener(), and userrec::userrec(). +For a serverrec this is the current listening port of the serverrec object. +.PP +Definition at line 76 of file connection.h. +.PP +Referenced by userrec::userrec(). .SS "char \fBconnection::registered\fP" .PP -Used by userrec to indicate the registration status of the connection. Definition at line 339 of file connection.h. +Used by userrec to indicate the registration status of the connection. +.PP +Definition at line 80 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 347 of file connection.h. +Time the connection was created, set in the constructor. +.PP +Definition at line 88 of file connection.h. .PP -Referenced by serverrec::serverrec(), and userrec::userrec(). +Referenced by userrec::userrec(). .SH "Author" .PP |