From 66f0cd6469d2643858c2fcd14726d362696bd68d Mon Sep 17 00:00:00 2001 From: brain Date: Tue, 24 May 2005 02:34:33 +0000 Subject: New methods, new docs git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1484 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classconnection.html | 477 +++-------------------------------- 1 file changed, 40 insertions(+), 437 deletions(-) (limited to 'docs/module-doc/classconnection.html') diff --git a/docs/module-doc/classconnection.html b/docs/module-doc/classconnection.html index b1e868b27..59d9ff2dd 100644 --- a/docs/module-doc/classconnection.html +++ b/docs/module-doc/classconnection.html @@ -19,7 +19,8 @@ Inheritance diagram for connection:

[legend]
Collaboration diagram for connection:

Collaboration graph
- + +
[legend]
List of all members. @@ -27,30 +28,6 @@ Inheritance diagram for connection:

 
- - - - - - - - - - - - - - - - - - - - - - - - @@ -61,16 +38,16 @@ Inheritance diagram for connection:

char 
- + - + - + - + @@ -94,16 +71,13 @@ Inheritance diagram for connection:

time_t 
- - -
connection ()
 Default constructor.

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)
 Begin an outbound link to another ircd at targethost.

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)
 Terminate a link to 'targethost' by calling the ircd_connector::CloseConnection method.

bool SendPacket (char *message, const char *host)
 Send 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.

bool RecvPacket (std::deque< std::string > &messages, char *host, std::deque< std::string > &sums)
 Returns the next available packet and returns true if data is available.

ircd_connector * FindHost (std::string host)
 Find the ircd_connector oject related to a certain servername given in 'host'.

bool AddIncoming (int fd, char *targethost, int sourceport)
 Add an incoming connection to the connection pool.


Public Attributes

int fd
ip [16]
 IP of connection.

long bytes_in
int bytes_in
 Stats counter for bytes inbound.

long bytes_out
int bytes_out
 Stats counter for bytes outbound.

long cmds_in
int cmds_in
 Stats counter for commands inbound.

long cmds_out
int cmds_out
 Stats counter for commands outbound.

bool haspassed
nping
 Used by PING checks with clients.

std::vector< ircd_connector > connectors
 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.

-Definition at line 212 of file connection.h.

Constructor & Destructor Documentation

+Definition at line 261 of file connection.h.

Constructor & Destructor Documentation

@@ -134,351 +108,6 @@ Default constructor.
-

Member Function Documentation

-

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
bool connection::AddIncoming ( int  fd,
char *  targethost,
int  sourceport
) 
-
- - - - - -
-   - - -

-Add an incoming connection to the connection pool. -

-(reserved for core use)

-

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
bool connection::BeginLink ( char *  targethost,
int  port,
char *  password,
char *  servername,
int  myport
) 
-
- - - - - -
-   - - -

-Begin an outbound link to another ircd at targethost. -

-

-

- - - - -
- - - - - - - - - - - - - - - - - - - -
bool connection::CreateListener ( char *  host,
int  p
) 
-
- - - - - -
-   - - -

-Create a listening socket on 'host' using port number 'p'. -

-

-

- - - - -
- - - - - - - - - - -
ircd_connector* connection::FindHost ( std::string  host  ) 
-
- - - - - -
-   - - -

-Find the ircd_connector oject related to a certain servername given in 'host'. -

-

-

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
bool connection::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. -

-

-

- - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
bool connection::RecvPacket ( std::deque< std::string > &  messages,
char *  host,
std::deque< std::string > &  sums
) 
-
- - - - - -
-   - - -

-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.

-

- - - - -
- - - - - - - - - - - - - - - - - - - -
bool connection::SendPacket ( char *  message,
const char *  host
) 
-
- - - - - -
-   - - -

-Send 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. -

-

-

- - - - -
- - - - - - - - - - -
void connection::TerminateLink ( char *  targethost  ) 
-
- - - - - -
-   - - -

-Terminate a link to 'targethost' by calling the ircd_connector::CloseConnection method. -

-

Member Data Documentation

@@ -486,7 +115,7 @@ Terminate a link to 'targethost' by calling the
-
long connection::bytes_in + int connection::bytes_in
@@ -503,9 +132,9 @@ Stats counter for bytes inbound.

-Definition at line 229 of file connection.h. +Definition at line 278 of file connection.h.

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

@@ -514,7 +143,7 @@ Referenced by userrec::userre -
long connection::bytes_out + int connection::bytes_out
@@ -531,9 +160,9 @@ Stats counter for bytes outbound.

-Definition at line 233 of file connection.h. +Definition at line 282 of file connection.h.

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

@@ -542,7 +171,7 @@ Referenced by userrec::FlushW -
long connection::cmds_in + int connection::cmds_in
@@ -559,9 +188,9 @@ Stats counter for commands inbound.

-Definition at line 237 of file connection.h. +Definition at line 286 of file connection.h.

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

@@ -570,7 +199,7 @@ Referenced by userrec::userre -
long connection::cmds_out + int connection::cmds_out
@@ -587,35 +216,9 @@ Stats counter for commands outbound.

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

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

- - - - -
- - -
std::vector<ircd_connector> connection::connectors -
-
- - - - +Referenced by userrec::FlushWriteBuf(), and userrec::userrec().
-   - - -

-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 276 of file connection.h.

@@ -641,9 +244,9 @@ File descriptor of the connection.

-Definition at line 217 of file connection.h. +Definition at line 266 of file connection.h.

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

@@ -669,9 +272,9 @@ True if server/user has authenticated, false if otherwise.

-Definition at line 245 of file connection.h. +Definition at line 294 of file connection.h.

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

@@ -697,9 +300,9 @@ Hostname of connection.

Not used if this is a serverrec

-Definition at line 221 of file connection.h. +Definition at line 270 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().

@@ -725,9 +328,9 @@ Time that the connection last sent data, used to calculate idle time.

-Definition at line 267 of file connection.h. +Definition at line 316 of file connection.h.

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

@@ -753,9 +356,9 @@ IP of connection.

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

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

@@ -781,9 +384,9 @@ Time the connection was last pinged.

-Definition at line 259 of file connection.h. +Definition at line 308 of file connection.h.

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

@@ -809,9 +412,9 @@ Used by PING checks with clients.

-Definition at line 271 of file connection.h. +Definition at line 320 of file connection.h.

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

@@ -837,9 +440,9 @@ 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. +Definition at line 300 of file connection.h.

-Referenced by userrec::userrec(). +Referenced by serverrec::CreateListener(), and userrec::userrec().

@@ -865,9 +468,9 @@ Used by userrec to indicate the registration status of the connection.

-Definition at line 255 of file connection.h. +Definition at line 304 of file connection.h.

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

@@ -893,14 +496,14 @@ Time the connection was created, set in the constructor.

-Definition at line 263 of file connection.h. +Definition at line 312 of file connection.h.

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

The documentation for this class was generated from the following file: -
Generated on Sun May 15 18:38:01 2005 for InspIRCd by +
Generated on Tue May 24 02:31:49 2005 for InspIRCd by doxygen 1.3.3
-- cgit v1.3.1-10-gc9f91