From 03be04a9a2d86a4568d09d5e1689dd7ef37c863a Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 14 Dec 2005 14:52:12 +0000 Subject: Added extra docs for new config system git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2417 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classInspSocket.html | 408 ++++++++++++++++++----------------- 1 file changed, 206 insertions(+), 202 deletions(-) (limited to 'docs/module-doc/classInspSocket.html') diff --git a/docs/module-doc/classInspSocket.html b/docs/module-doc/classInspSocket.html index e8b83e847..755cb1ca0 100644 --- a/docs/module-doc/classInspSocket.html +++ b/docs/module-doc/classInspSocket.html @@ -151,11 +151,11 @@ The default constructor does nothing and should not be used.

-Definition at line 49 of file socket.cpp. +Definition at line 48 of file socket.cpp.

-References I_DISCONNECTED, and state.

00050 {
-00051         this->state = I_DISCONNECTED;
-00052 }
+References I_DISCONNECTED, and state.
00049 {
+00050         this->state = I_DISCONNECTED;
+00051 }
 

 

     
@@ -199,13 +199,14 @@ This constructor is used to associate an existing connecting with an InspSocket
 

 The given file descriptor must be valid, and when initialized, the InspSocket will be set with the given IP address and placed in CONNECTED state.
 

-Definition at line 54 of file socket.cpp.
+Definition at line 53 of file socket.cpp.
 

-References SocketEngine::AddFd(), fd, I_CONNECTED, IP, state, and X_ESTAB_MODULE.
00055 {
-00056         this->fd = newfd;
-00057         this->state = I_CONNECTED;
-00058         this->IP = ip;
-00059         SE->AddFd(this->fd,true,X_ESTAB_MODULE);
+References SocketEngine::AddFd(), fd, I_CONNECTED, IP, state, and X_ESTAB_MODULE.
00054 {
+00055         this->fd = newfd;
+00056         this->state = I_CONNECTED;
+00057         this->IP = ip;
+00058         SE->AddFd(this->fd,true,X_ESTAB_MODULE);
+00059         socket_ref[this->fd] = this;
 00060 }
 

 

@@ -272,81 +273,83 @@ This constructor is used to create a new socket, either listening for connection
 

 Definition at line 62 of file socket.cpp.
 

-References SocketEngine::AddFd(), addr, addy, Close(), DEBUG, fd, I_CONNECTING, I_ERR_BIND, I_ERR_CONNECT, I_ERR_SOCKET, I_ERROR, I_LISTENING, IP, OnError(), state, timeout, timeout_end, and X_ESTAB_MODULE.
00063 {
+References SocketEngine::AddFd(), addr, addy, BindSocket(), Close(), DEBUG, fd, I_CONNECTING, I_ERR_BIND, I_ERR_CONNECT, I_ERR_SOCKET, I_ERROR, I_LISTENING, IP, OnError(), OpenTCPSocket(), state, timeout, timeout_end, and X_ESTAB_MODULE.
00063 {
 00064         if (listening) {
-00065                 if ((this->fd = OpenTCPSocket()) == ERROR)
+00065                 if ((this->fd = OpenTCPSocket()) == ERROR)
 00066                 {
 00067                         this->fd = -1;
 00068                         this->state = I_ERROR;
 00069                         this->OnError(I_ERR_SOCKET);
-00070                         log(DEBUG,"OpenTCPSocket() error");
+00070                         log(DEBUG,"OpenTCPSocket() error");
 00071                         return;
 00072                 }
 00073                 else
 00074                 {
-00075                         if (BindSocket(this->fd,this->client,this->server,port,(char*)host.c_str()) == ERROR)
+00075                         if (BindSocket(this->fd,this->client,this->server,port,(char*)host.c_str()) == ERROR)
 00076                         {
 00077                                 this->Close();
 00078                                 this->fd = -1;
 00079                                 this->state = I_ERROR;
 00080                                 this->OnError(I_ERR_BIND);
-00081                                 log(DEBUG,"BindSocket() error %s",strerror(errno));
+00081                                 log(DEBUG,"BindSocket() error %s",strerror(errno));
 00082                                 return;
 00083                         }
 00084                         else
 00085                         {
 00086                                 this->state = I_LISTENING;
 00087                                 SE->AddFd(this->fd,true,X_ESTAB_MODULE);
-00088                                 log(DEBUG,"New socket now in I_LISTENING state");
-00089                                 return;
-00090                         }
-00091                 }                       
-00092         } else {
-00093                 char* ip;
-00094                 this->host = host;
-00095                 hostent* hoste = gethostbyname(host.c_str());
-00096                 if (!hoste) {
-00097                         ip = (char*)host.c_str();
-00098                 } else {
-00099                         struct in_addr* ia = (in_addr*)hoste->h_addr;
-00100                         ip = inet_ntoa(*ia);
-00101                 }
-00102 
-00103                 this->IP = ip;
-00104 
-00105                 timeout_end = time(NULL)+maxtime;
-00106                 timeout = false;
-00107                 if ((this->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
-00108                 {
-00109                         this->state = I_ERROR;
-00110                         this->OnError(I_ERR_SOCKET);
-00111                         return;
-00112                 }
-00113                 this->port = port;
-00114                 inet_aton(ip,&addy);
-00115                 addr.sin_family = AF_INET;
-00116                 addr.sin_addr = addy;
-00117                 addr.sin_port = htons(this->port);
-00118 
-00119                 int flags;
-00120                 flags = fcntl(this->fd, F_GETFL, 0);
-00121                 fcntl(this->fd, F_SETFL, flags | O_NONBLOCK);
-00122 
-00123                 if(connect(this->fd, (sockaddr*)&this->addr,sizeof(this->addr)) == -1)
-00124                 {
-00125                         if (errno != EINPROGRESS)
-00126                         {
-00127                                 this->Close();
-00128                                 this->OnError(I_ERR_CONNECT);
-00129                                 this->state = I_ERROR;
-00130                                 return;
-00131                         }
-00132                 }
-00133                 this->state = I_CONNECTING;
-00134                 SE->AddFd(this->fd,false,X_ESTAB_MODULE);
-00135                 return;
-00136         }
-00137 }
+00088                                 socket_ref[this->fd] = this;
+00089                                 log(DEBUG,"New socket now in I_LISTENING state");
+00090                                 return;
+00091                         }
+00092                 }                       
+00093         } else {
+00094                 char* ip;
+00095                 this->host = host;
+00096                 hostent* hoste = gethostbyname(host.c_str());
+00097                 if (!hoste) {
+00098                         ip = (char*)host.c_str();
+00099                 } else {
+00100                         struct in_addr* ia = (in_addr*)hoste->h_addr;
+00101                         ip = inet_ntoa(*ia);
+00102                 }
+00103 
+00104                 this->IP = ip;
+00105 
+00106                 timeout_end = time(NULL)+maxtime;
+00107                 timeout = false;
+00108                 if ((this->fd = socket(AF_INET, SOCK_STREAM, 0)) == -1)
+00109                 {
+00110                         this->state = I_ERROR;
+00111                         this->OnError(I_ERR_SOCKET);
+00112                         return;
+00113                 }
+00114                 this->port = port;
+00115                 inet_aton(ip,&addy);
+00116                 addr.sin_family = AF_INET;
+00117                 addr.sin_addr = addy;
+00118                 addr.sin_port = htons(this->port);
+00119 
+00120                 int flags;
+00121                 flags = fcntl(this->fd, F_GETFL, 0);
+00122                 fcntl(this->fd, F_SETFL, flags | O_NONBLOCK);
+00123 
+00124                 if(connect(this->fd, (sockaddr*)&this->addr,sizeof(this->addr)) == -1)
+00125                 {
+00126                         if (errno != EINPROGRESS)
+00127                         {
+00128                                 this->Close();
+00129                                 this->OnError(I_ERR_CONNECT);
+00130                                 this->state = I_ERROR;
+00131                                 return;
+00132                         }
+00133                 }
+00134                 this->state = I_CONNECTING;
+00135                 SE->AddFd(this->fd,false,X_ESTAB_MODULE);
+00136                 socket_ref[this->fd] = this;
+00137                 return;
+00138         }
+00139 }
 

 

     
@@ -380,11 +383,11 @@ The destructor may implicitly call 269 of file socket.cpp.
+Definition at line 272 of file socket.cpp.
 

-References Close().
00270 {
-00271         this->Close();
-00272 }
+References Close().
00273 {
+00274         this->Close();
+00275 }
 

 

     
@@ -419,19 +422,20 @@ This method causes the socket to close, and may also be triggered by other metho
 

 
 

-Definition at line 139 of file socket.cpp.
+Definition at line 141 of file socket.cpp.
 

-References fd, and OnClose().
+References fd, and OnClose().
 

-Referenced by InspSocket(), and ~InspSocket().
00140 {
-00141         if (this->fd != -1)
-00142         {
-00143                 this->OnClose();
-00144                 shutdown(this->fd,2);
-00145                 close(this->fd);
-00146                 this->fd = -1;
-00147         }
-00148 }
+Referenced by InspSocket(), and ~InspSocket().
00142 {
+00143         if (this->fd != -1)
+00144         {
+00145                 this->OnClose();
+00146                 shutdown(this->fd,2);
+00147                 close(this->fd);
+00148                 socket_ref[this->fd] = NULL;
+00149                 this->fd = -1;
+00150         }
+00151 }
 

 

     
@@ -465,11 +469,11 @@ This method returns the socket's file descriptor as assigned by the operating sy
 

 
 

-Definition at line 256 of file socket.cpp.
+Definition at line 259 of file socket.cpp.
 

-References fd.
00257 {
-00258         return this->fd;
-00259 }
+References fd.
00260 {
+00261         return this->fd;
+00262 }
 

 

     
@@ -503,11 +507,11 @@ Returns the IP address associated with this connection, or an empty string if no
 

 
 

-Definition at line 150 of file socket.cpp.
+Definition at line 153 of file socket.cpp.
 

-References IP.
00151 {
-00152         return this->IP;
-00153 }
+References IP.
00154 {
+00155         return this->IP;
+00156 }
 

 

     
@@ -541,11 +545,11 @@ Returns the current socket state.
 

 
 

-Definition at line 251 of file socket.cpp.
+Definition at line 254 of file socket.cpp.
 

-References state.
00252 {
-00253         return this->state;
-00254 }
+References state.
00255 {
+00256         return this->state;
+00257 }
 

 

     
@@ -579,9 +583,9 @@ Whenever close() is called, OnError(), OnTimeout(), and Close(), and also when cancelling a listening socket by calling the destructor indirectly.
 

-Definition at line 267 of file socket.cpp.
+Definition at line 270 of file socket.cpp.
 

-Referenced by Close().
00267 { return; }
+Referenced by Close().
00270 { return; }
 

 

     
@@ -616,9 +620,9 @@ This method is called when an outbound connection on your socket is completed.
 
Returns:
false to abort the connection, true to continue

 
 

-Definition at line 261 of file socket.cpp.
+Definition at line 264 of file socket.cpp.
 

-Referenced by Poll().
00261 { return true; }
+Referenced by Poll().
00264 { return true; }
 

 

     
@@ -653,9 +657,9 @@ When there is data waiting to be read on a socket, the Read() method to read any pending data. At its lowest level, this event is signalled by the core via the socket engine. If you return false from this function, the core removes your socket from its list and erases it from the socket engine, then calls InspSocket::Close() and deletes it. 
Returns:
false to close the socket

 
 

-Definition at line 265 of file socket.cpp.
+Definition at line 268 of file socket.cpp.
 

-Referenced by Poll().
00265 { return true; }
+Referenced by Poll().
00268 { return true; }
 

 

     
@@ -689,7 +693,7 @@ When an established connection is terminated, the OnDisconnect method is trigger
 

 
 

-Definition at line 263 of file socket.cpp.
00263 { return 0; }
+Definition at line 266 of file socket.cpp.
00266 { return 0; }
 

 

     
@@ -729,9 +733,9 @@ A closed socket in itself is not an error, however errors also generate close ev
 
 
 

-Definition at line 262 of file socket.cpp.
+Definition at line 265 of file socket.cpp.
 

-Referenced by InspSocket(), and Timeout().
00262 { return; }
+Referenced by InspSocket(), and Timeout().
00265 { return; }
 

 

     
@@ -777,9 +781,9 @@ Given the new file descriptor in the parameters, and the IP, it is recommended y
 MySocket* newsocket = new MySocket(newfd,ip);

 Once you have done this, you can then associate the new socket with the core using Server::AddSocket().
 

-Definition at line 264 of file socket.cpp.
+Definition at line 267 of file socket.cpp.
 

-Referenced by Poll().
00264 { return 0; }
+Referenced by Poll().
00267 { return 0; }
 

 

     
@@ -813,9 +817,9 @@ When an outbound connection fails, and the attempt times out, you will receive t
 

 The mthod will trigger once maxtime secons are reached (as given in the constructor) just before the socket's descriptor is closed.
 

-Definition at line 266 of file socket.cpp.
+Definition at line 269 of file socket.cpp.
 

-Referenced by Timeout().
00266 { return; }
+Referenced by Timeout().
00269 { return; }
 

 

     
@@ -849,37 +853,37 @@ Only the core should call this function.
 

 When called, it is assumed the socket is ready to read data, and the method call routes the event to the various methods of InspSocket for you to handle. This can also cause the socket's state to change.
 

-Definition at line 214 of file socket.cpp.
-

-References SocketEngine::AddFd(), client, SocketEngine::DelFd(), I_CONNECTED, I_CONNECTING, I_LISTENING, length, OnConnected(), OnDataReady(), OnIncomingConnection(), SetState(), and X_ESTAB_MODULE.
00215 {
-00216         int incoming = -1;
-00217         
-00218         switch (this->state)
-00219         {
-00220                 case I_CONNECTING:
-00221                         this->SetState(I_CONNECTED);
-00222                         /* Our socket was in write-state, so delete it and re-add it
-00223                          * in read-state.
-00224                          */
-00225                         SE->DelFd(this->fd);
-00226                         SE->AddFd(this->fd,true,X_ESTAB_MODULE);
-00227                         return this->OnConnected();
-00228                 break;
-00229                 case I_LISTENING:
-00230                         length = sizeof (client);
-00231                         incoming = accept (this->fd, (sockaddr*)&client,&length);
-00232                         this->OnIncomingConnection(incoming,inet_ntoa(client.sin_addr));
-00233                         return true;
-00234                 break;
-00235                 case I_CONNECTED:
-00236                         return this->OnDataReady();
+Definition at line 217 of file socket.cpp.
+

+References SocketEngine::AddFd(), client, SocketEngine::DelFd(), I_CONNECTED, I_CONNECTING, I_LISTENING, length, OnConnected(), OnDataReady(), OnIncomingConnection(), SetState(), and X_ESTAB_MODULE.
00218 {
+00219         int incoming = -1;
+00220         
+00221         switch (this->state)
+00222         {
+00223                 case I_CONNECTING:
+00224                         this->SetState(I_CONNECTED);
+00225                         /* Our socket was in write-state, so delete it and re-add it
+00226                          * in read-state.
+00227                          */
+00228                         SE->DelFd(this->fd);
+00229                         SE->AddFd(this->fd,true,X_ESTAB_MODULE);
+00230                         return this->OnConnected();
+00231                 break;
+00232                 case I_LISTENING:
+00233                         length = sizeof (client);
+00234                         incoming = accept (this->fd, (sockaddr*)&client,&length);
+00235                         this->OnIncomingConnection(incoming,inet_ntoa(client.sin_addr));
+00236                         return true;
 00237                 break;
-00238                 default:
-00239                 break;
-00240         }
-00241 
-00242         return true;
-00243 }
+00238                 case I_CONNECTED:
+00239                         return this->OnDataReady();
+00240                 break;
+00241                 default:
+00242                 break;
+00243         }
+00244 
+00245         return true;
+00246 }
 

 

     
@@ -913,21 +917,21 @@ Reads all pending bytes from the socket into a char* array which can be up to 16
 

 
 

-Definition at line 155 of file socket.cpp.
+Definition at line 158 of file socket.cpp.
 

-References DEBUG, and ibuf.
00156 {
-00157         int n = recv(this->fd,this->ibuf,sizeof(this->ibuf),0);
-00158         if (n > 0)
-00159         {
-00160                 ibuf[n] = 0;
-00161                 return ibuf;
-00162         }
-00163         else
-00164         {
-00165                 log(DEBUG,"EOF or error on socket");
-00166                 return NULL;
-00167         }
-00168 }
+References DEBUG, and ibuf.
00159 {
+00160         int n = recv(this->fd,this->ibuf,sizeof(this->ibuf),0);
+00161         if (n > 0)
+00162         {
+00163                 ibuf[n] = 0;
+00164                 return ibuf;
+00165         }
+00166         else
+00167         {
+00168                 log(DEBUG,"EOF or error on socket");
+00169                 return NULL;
+00170         }
+00171 }
 

 

     
@@ -962,14 +966,14 @@ Changes the socket's state.
 

 The core uses this to change socket states, and you should not call it directly.
 

-Definition at line 245 of file socket.cpp.
+Definition at line 248 of file socket.cpp.
 

-References DEBUG, and state.
+References DEBUG, and state.
 

-Referenced by Poll().
00246 {
-00247         log(DEBUG,"Socket state change");
-00248         this->state = s;
-00249 }
+Referenced by Poll().
00249 {
+00250         log(DEBUG,"Socket state change");
+00251         this->state = s;
+00252 }
 

 

     
@@ -1005,23 +1009,23 @@ This function checks if the socket has timed out yet, given the current time in
 
Returns:
true if timed out, false if not timed out

 
 

-Definition at line 197 of file socket.cpp.
-

-References I_CONNECTING, I_ERR_TIMEOUT, I_ERROR, OnError(), OnTimeout(), state, timeout, and timeout_end.
00198 {
-00199         if ((this->state == I_CONNECTING) && (current > timeout_end))
-00200         {
-00201                 // for non-listening sockets, the timeout can occur
-00202                 // which causes termination of the connection after
-00203                 // the given number of seconds without a successful
-00204                 // connection.
-00205                 this->OnTimeout();
-00206                 this->OnError(I_ERR_TIMEOUT);
-00207                 timeout = true;
-00208                 this->state = I_ERROR;
-00209                 return true;
-00210         }
-00211         return false;
-00212 }
+Definition at line 200 of file socket.cpp.
+

+References I_CONNECTING, I_ERR_TIMEOUT, I_ERROR, OnError(), OnTimeout(), state, timeout, and timeout_end.
00201 {
+00202         if ((this->state == I_CONNECTING) && (current > timeout_end))
+00203         {
+00204                 // for non-listening sockets, the timeout can occur
+00205                 // which causes termination of the connection after
+00206                 // the given number of seconds without a successful
+00207                 // connection.
+00208                 this->OnTimeout();
+00209                 this->OnError(I_ERR_TIMEOUT);
+00210                 timeout = true;
+00211                 this->state = I_ERROR;
+00212                 return true;
+00213         }
+00214         return false;
+00215 }
 

 

     
@@ -1061,27 +1065,27 @@ No carriage returns or linefeeds are appended to the string. 

 

 
 

-Definition at line 174 of file socket.cpp.
00175 {
-00176         char* d = (char*)data.c_str();
-00177         unsigned int written = 0;
-00178         int n = 0;
-00179         int s = data.length();
-00180         while ((written < data.length()) && (n >= 0))
-00181         {
-00182                 n = send(this->fd,d,s,0);
-00183                 if (n > 0)
-00184                 {
-00185                         // If we didnt write everything, advance
-00186                         // the pointers so that when we retry
-00187                         // the next time around the loop, we try
-00188                         // to write what we failed to write before.
-00189                         written += n;
-00190                         s -= n;
-00191                         d += n;
-00192                 }
-00193         }
-00194         return written;
-00195 }
+Definition at line 177 of file socket.cpp.
00178 {
+00179         char* d = (char*)data.c_str();
+00180         unsigned int written = 0;
+00181         int n = 0;
+00182         int s = data.length();
+00183         while ((written < data.length()) && (n >= 0))
+00184         {
+00185                 n = send(this->fd,d,s,0);
+00186                 if (n > 0)
+00187                 {
+00188                         // If we didnt write everything, advance
+00189                         // the pointers so that when we retry
+00190                         // the next time around the loop, we try
+00191                         // to write what we failed to write before.
+00192                         written += n;
+00193                         s -= n;
+00194                         d += n;
+00195                 }
+00196         }
+00197         return written;
+00198 }
 

 

     
@@ -1172,7 +1176,7 @@ Client sockaddr structure used by accept().
 

 Definition at line 119 of file socket.h.
 

-Referenced by Poll().    
+Referenced by Poll().    
   
 
 

@@ -1201,7 +1205,7 @@ The file descriptor of this socket.
 

 Definition at line 54 of file socket.h.
 

-Referenced by Close(), GetFd(), and InspSocket().    
+Referenced by Close(), GetFd(), and InspSocket().    
   
 
 

@@ -1257,7 +1261,7 @@ The class which extends InspSocket is expected to implement an extendable buffer
 

 Definition at line 106 of file socket.h.
 

-Referenced by Read().    
+Referenced by Read().    
   
 
 

@@ -1286,7 +1290,7 @@ The IP address being connected to stored in string form for easy retrieval by ac
 

 Definition at line 113 of file socket.h.
 

-Referenced by GetIP(), and InspSocket().    
+Referenced by GetIP(), and InspSocket().    
   
 
 

@@ -1315,7 +1319,7 @@ Used by accept() to indicate the sizes of the sockaddr_in structures.
 

 Definition at line 131 of file socket.h.
 

-Referenced by Poll().    
+Referenced by Poll().    
   
 
 

@@ -1398,7 +1402,7 @@ The state for this socket, either listening, connecting, connected or error.
 

 Definition at line 72 of file socket.h.
 

-Referenced by GetState(), InspSocket(), SetState(), and Timeout().    
+Referenced by GetState(), InspSocket(), SetState(), and Timeout().    
   
 
 

@@ -1427,7 +1431,7 @@ This value is true if the socket has timed out.
 

 Definition at line 97 of file socket.h.
 

-Referenced by InspSocket(), and Timeout().    
+Referenced by InspSocket(), and Timeout().    
   
 
 

@@ -1456,12 +1460,12 @@ When this time is reached, the socket times out if it is in the CONNECTING state
 

 Definition at line 91 of file socket.h.
 

-Referenced by InspSocket(), and Timeout().    
+Referenced by InspSocket(), and Timeout().    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Mon Dec 12 18:31:02 2005 for InspIRCd by 
+
Generated on Wed Dec 14 14:49:31 2005 for InspIRCd by 
 
 doxygen 1.4.4-20050815 

 
-- 
cgit v1.3.1-10-gc9f91