diff options
Diffstat (limited to 'docs/man/man3/connection.3')
| -rw-r--r-- | docs/man/man3/connection.3 | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/docs/man/man3/connection.3 b/docs/man/man3/connection.3 index 089bd108e..e21a84b8d 100644 --- a/docs/man/man3/connection.3 +++ b/docs/man/man3/connection.3 @@ -1,4 +1,4 @@ -.TH "connection" 3 "13 May 2005" "InspIRCd" \" -*- nroff -*- +.TH "connection" 3 "15 May 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -42,7 +42,7 @@ Inherited by \fBserverrec\fP, and \fBuserrec\fP. .br .RI "\fISend a message to a server by name, if the server is unavailable directly route the packet via another server If the server still cannot be reached after attempting to route the message remotely, returns false. \fP" .ti -1c -.RI "bool \fBRecvPacket\fP (std::deque< std::string > &messages, char *\fBhost\fP)" +.RI "bool \fBRecvPacket\fP (std::deque< std::string > &messages, char *\fBhost\fP, std::deque< std::string > &sums)" .br .RI "\fIReturns the next available packet and returns true if data is available. \fP" .ti -1c @@ -120,7 +120,7 @@ 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 210 of file connection.h. +Please note: classes serverrec and userrec both inherit from class connection. Definition at line 212 of file connection.h. .SH "Constructor & Destructor Documentation" .PP .SS "connection::connection ()" @@ -143,7 +143,7 @@ Find the \fBircd_connector\fP oject related to a certain servername given in 'ho .SS "bool connection::MeshCookie (char * targethost, int port, unsigned long cookie, char * servername)" .PP Begin an outbound mesh link to another ircd on a network you are already an authenticated member of. -.SS "bool connection::RecvPacket (std::deque< std::string > & messages, char * host)" +.SS "bool connection::RecvPacket (std::deque< std::string > & messages, char * host, std::deque< std::string > & sums)" .PP Returns the next available packet and returns true if data is available. Writes the servername the data came from to 'host'. If no data is available this function returns false. This function will automatically close broken links and reroute pathways, generating split messages on the network. .SS "bool connection::SendPacket (char * message, const char * host)" @@ -156,75 +156,75 @@ 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 227 of file connection.h. +Stats counter for bytes inbound. Definition at line 229 of file connection.h. .PP Referenced by userrec::userrec(). .SS "long \fBconnection::bytes_out\fP" .PP -Stats counter for bytes outbound. Definition at line 231 of file connection.h. +Stats counter for bytes outbound. Definition at line 233 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 235 of file connection.h. +Stats counter for commands inbound. Definition at line 237 of file connection.h. .PP Referenced by userrec::userrec(). .SS "long \fBconnection::cmds_out\fP" .PP -Stats counter for commands outbound. Definition at line 239 of file connection.h. +Stats counter for commands outbound. Definition at line 241 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 274 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 276 of file connection.h. .SS "int \fBconnection::fd\fP" .PP -File descriptor of the connection. Definition at line 215 of file connection.h. +File descriptor of the connection. Definition at line 217 of file connection.h. .PP 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 243 of file connection.h. +True if server/user has authenticated, false if otherwise. Definition at line 245 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 219 of file connection.h. +Hostname of connection. Not used if this is a serverrecDefinition at line 221 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 265 of file connection.h. +Time that the connection last sent data, used to calculate idle time. Definition at line 267 of file connection.h. .PP Referenced by userrec::userrec(). .SS "char \fBconnection::ip\fP[16]" .PP -IP of connection. Definition at line 223 of file connection.h. +IP of connection. Definition at line 225 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 257 of file connection.h. +Time the connection was last pinged. Definition at line 259 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 269 of file connection.h. +Used by PING checks with clients. Definition at line 271 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 249 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 251 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 253 of file connection.h. +Used by userrec to indicate the registration status of the connection. Definition at line 255 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 261 of file connection.h. +Time the connection was created, set in the constructor. Definition at line 263 of file connection.h. .PP Referenced by serverrec::serverrec(), and userrec::userrec(). |