diff options
Diffstat (limited to 'docs/module-doc/classInspSocket.html')
| -rw-r--r-- | docs/module-doc/classInspSocket.html | 414 |
1 files changed, 276 insertions, 138 deletions
diff --git a/docs/module-doc/classInspSocket.html b/docs/module-doc/classInspSocket.html index b4c7e7fba..e8b83e847 100644 --- a/docs/module-doc/classInspSocket.html +++ b/docs/module-doc/classInspSocket.html @@ -5,7 +5,10 @@ </head><body> <!-- Generated by Doxygen 1.4.4-20050815 --> <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div> -<h1>InspSocket Class Reference</h1><!-- doxytag: class="InspSocket" --><code>#include <<a class="el" href="socket_8h-source.html">socket.h</a>></code> +<h1>InspSocket Class Reference</h1><!-- doxytag: class="InspSocket" -->InspSocket is an extendable socket class which modules can use for TCP socket support. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="socket_8h-source.html">socket.h</a>></code> <p> Collaboration diagram for InspSocket:<p><center><img src="classInspSocket__coll__graph.gif" border="0" usemap="#InspSocket__coll__map" alt="Collaboration graph"></center> <center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="classInspSocket-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> @@ -13,78 +16,113 @@ Collaboration diagram for InspSocket:<p><center><img src="classInspSocket__coll_ <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#InspSocket_28_29">InspSocket</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The default constructor does nothing and should not be used. <a href="#InspSocket_28_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#InspSocket_28int_20newfd_2C_20char_20_2Aip_29">InspSocket</a> (int newfd, char *ip)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This constructor is used to associate an existing connecting with an InspSocket class. <a href="#InspSocket_28int_20newfd_2C_20char_20_2Aip_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#InspSocket_28std_3A_3Astring_20host_2C_20int_20port_2C_20bool_20listening_2C_20unsigned_20long_20maxtime_29">InspSocket</a> (<a class="el" href="namespaceirc.html#string">std::string</a> <a class="el" href="classInspSocket.html#host">host</a>, int <a class="el" href="classInspSocket.html#port">port</a>, bool listening, unsigned long maxtime)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This constructor is used to create a new socket, either listening for connections, or an outbound connection to another host. <a href="#InspSocket_28std_3A_3Astring_20host_2C_20int_20port_2C_20bool_20listening_2C_20unsigned_20long_20maxtime_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#OnConnected_28_29">OnConnected</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This method is called when an outbound connection on your socket is completed. <a href="#OnConnected_28_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#OnError_28InspSocketError_20e_29">OnError</a> (<a class="el" href="socket_8h.html#InspSocketError">InspSocketError</a> e)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This method is called when an error occurs. <a href="#OnError_28InspSocketError_20e_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#OnDisconnect_28_29">OnDisconnect</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">When an established connection is terminated, the OnDisconnect method is triggered. <a href="#OnDisconnect_28_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#OnDataReady_28_29">OnDataReady</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">When there is data waiting to be read on a socket, the <a class="el" href="classInspSocket.html#OnDataReady_28_29">OnDataReady()</a> method is called. <a href="#OnDataReady_28_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#OnTimeout_28_29">OnTimeout</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">When an outbound connection fails, and the attempt times out, you will receive this event. <a href="#OnTimeout_28_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#OnClose_28_29">OnClose</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Whenever close() is called, <a class="el" href="classInspSocket.html#OnClose_28_29">OnClose()</a> will be called first. <a href="#OnClose_28_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#Read_28_29">Read</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Reads all pending bytes from the socket into a char* array which can be up to 16 kilobytes in length. <a href="#Read_28_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#GetIP_28_29">GetIP</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the IP address associated with this connection, or an empty string if no IP address exists. <a href="#GetIP_28_29"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#Timeout_28time_5Ft_20current_29">Timeout</a> (time_t current)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This function checks if the socket has timed out yet, given the current time in the parameter. <a href="#Timeout_28time_5Ft_20current_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#Write_28std_3A_3Astring_20data_29">Write</a> (<a class="el" href="namespaceirc.html#string">std::string</a> data)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a <a class="el" href="namespaceirc.html#string">std::string</a> to the socket. <a href="#Write_28std_3A_3Astring_20data_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#OnIncomingConnection_28int_20newfd_2C_20char_20_2Aip_29">OnIncomingConnection</a> (int newfd, char *ip)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">If your socket is a listening socket, when a new connection comes in on the socket this method will be called. <a href="#OnIncomingConnection_28int_20newfd_2C_20char_20_2Aip_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#SetState_28InspSocketState_20s_29">SetState</a> (<a class="el" href="socket_8h.html#InspSocketState">InspSocketState</a> s)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Changes the socket's state. <a href="#SetState_28InspSocketState_20s_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="socket_8h.html#InspSocketState">InspSocketState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#GetState_28_29">GetState</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current socket state. <a href="#GetState_28_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#Poll_28_29">Poll</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Only the core should call this function. <a href="#Poll_28_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#GetFd_28_29">GetFd</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This method returns the socket's file descriptor as assigned by the operating system, or -1 if no descriptor has been assigned. <a href="#GetFd_28_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#Close_28_29">Close</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">This method causes the socket to close, and may also be triggered by other methods such as OnTimeout and OnError. <a href="#Close_28_29"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#_7EInspSocket_28_29">~InspSocket</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The destructor may implicitly call <a class="el" href="classInspSocket.html#OnClose_28_29">OnClose()</a>, and will close() and shutdown() the file descriptor used for this socket. <a href="#_7EInspSocket_28_29"></a><br></td></tr> <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#fd">fd</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The file descriptor of this socket. <a href="#fd"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#host">host</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The hostname connected to. <a href="#host"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#port">port</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The port connected to, or the port this socket is listening on. <a href="#port"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="socket_8h.html#InspSocketState">InspSocketState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#state">state</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The state for this socket, either listening, connecting, connected or error. <a href="#state"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">sockaddr_in </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#addr">addr</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The host being connected to, in sockaddr form. <a href="#addr"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">in_addr </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#addy">addy</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The host being connected to, in in_addr form. <a href="#addy"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">time_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#timeout_5Fend">timeout_end</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">When this time is reached, the socket times out if it is in the CONNECTING state. <a href="#timeout_5Fend"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#timeout">timeout</a></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">pollfd </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#polls">polls</a></td></tr> - +<tr><td class="mdescLeft"> </td><td class="mdescRight">This value is true if the socket has timed out. <a href="#timeout"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#ibuf_5B_31_36_33_38_34_5D">ibuf</a> [16384]</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Socket input buffer, used by read(). <a href="#ibuf_5B_31_36_33_38_34_5D"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespaceirc.html#string">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#IP">IP</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The IP address being connected to stored in string form for easy retrieval by accessors. <a href="#IP"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">sockaddr_in </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#client">client</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Client sockaddr structure used by accept(). <a href="#client"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">sockaddr_in </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#server">server</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classServer.html">Server</a> sockaddr structure used by accept(). <a href="#server"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">socklen_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classInspSocket.html#length">length</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Used by accept() to indicate the sizes of the sockaddr_in structures. <a href="#length"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> - +InspSocket is an extendable socket class which modules can use for TCP socket support. +<p> +It is fully integrated into InspIRCds socket loop and attaches its sockets to the core's instance of the <a class="el" href="classSocketEngine.html">SocketEngine</a> class, meaning that any sockets you create have the same power and abilities as a socket created by the core itself. To use InspSocket, you must inherit a class from it, and use the InspSocket constructors to establish connections and bindings. <p> <p> -Definition at line <a class="el" href="socket_8h-source.html#l00030">30</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +Definition at line <a class="el" href="socket_8h-source.html#l00047">47</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="InspSocket_28_29"></a><!-- doxytag: member="InspSocket::InspSocket" ref="InspSocket_28_29" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> @@ -109,11 +147,13 @@ Definition at line <a class="el" href="socket_8h-source.html#l00030">30</a> of f <td> <p> +The default constructor does nothing and should not be used. +<p> <p> Definition at line <a class="el" href="socket_8cpp-source.html#l00049">49</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. <p> -References <a class="el" href="socket_8h.html#InspSocketStateI_5FDISCONNECTED">I_DISCONNECTED</a>, and <a class="el" href="socket_8h-source.html#l00036">state</a>.<div class="fragment"><pre class="fragment"><a name="l00050"></a>00050 { +References <a class="el" href="socket_8h.html#InspSocketStateI_5FDISCONNECTED">I_DISCONNECTED</a>, and <a class="el" href="socket_8h-source.html#l00072">state</a>.<div class="fragment"><pre class="fragment"><a name="l00050"></a>00050 { <a name="l00051"></a>00051 this-><a class="code" href="classInspSocket.html#state">state</a> = <a class="code" href="socket_8h.html#InspSocketStateI_5FDISCONNECTED">I_DISCONNECTED</a>; <a name="l00052"></a>00052 } </pre></div> @@ -155,11 +195,13 @@ References <a class="el" href="socket_8h.html#InspSocketStateI_5FDISCONNECTED">I <td> <p> - +This constructor is used to associate an existing connecting with an InspSocket class. +<p> +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. <p> Definition at line <a class="el" href="socket_8cpp-source.html#l00054">54</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. <p> -References <a class="el" href="socketengine_8cpp-source.html#l00065">SocketEngine::AddFd()</a>, <a class="el" href="socket_8h-source.html#l00033">fd</a>, <a class="el" href="socket_8h.html#InspSocketStateI_5FCONNECTED">I_CONNECTED</a>, <a class="el" href="socket_8h-source.html#l00043">IP</a>, <a class="el" href="socket_8h-source.html#l00036">state</a>, and <a class="el" href="socketengine_8h-source.html#l00044">X_ESTAB_MODULE</a>.<div class="fragment"><pre class="fragment"><a name="l00055"></a>00055 { +References <a class="el" href="socketengine_8cpp-source.html#l00065">SocketEngine::AddFd()</a>, <a class="el" href="socket_8h-source.html#l00054">fd</a>, <a class="el" href="socket_8h.html#InspSocketStateI_5FCONNECTED">I_CONNECTED</a>, <a class="el" href="socket_8h-source.html#l00113">IP</a>, <a class="el" href="socket_8h-source.html#l00072">state</a>, and <a class="el" href="socketengine_8h-source.html#l00044">X_ESTAB_MODULE</a>.<div class="fragment"><pre class="fragment"><a name="l00055"></a>00055 { <a name="l00056"></a>00056 this-><a class="code" href="classInspSocket.html#fd">fd</a> = newfd; <a name="l00057"></a>00057 this-><a class="code" href="classInspSocket.html#state">state</a> = <a class="code" href="socket_8h.html#InspSocketStateI_5FCONNECTED">I_CONNECTED</a>; <a name="l00058"></a>00058 this-><a class="code" href="classInspSocket.html#IP">IP</a> = ip; @@ -216,11 +258,21 @@ References <a class="el" href="socketengine_8cpp-source.html#l00065">SocketEngin <td> <p> +This constructor is used to create a new socket, either listening for connections, or an outbound connection to another host. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>host</em> </td><td>The hostname to connect to, or bind to </td></tr> + <tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>The port number to connect to, or bind to </td></tr> + <tr><td valign="top"></td><td valign="top"><em>listening</em> </td><td>true to listen on the given host:port pair, or false to connect to them </td></tr> + <tr><td valign="top"></td><td valign="top"><em>maxtime</em> </td><td>Number of seconds to wait, if connecting, before the connection times out and an <a class="el" href="classInspSocket.html#OnTimeout_28_29">OnTimeout()</a> event is generated</td></tr> + </table> +</dl> <p> Definition at line <a class="el" href="socket_8cpp-source.html#l00062">62</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. <p> -References <a class="el" href="socketengine_8cpp-source.html#l00065">SocketEngine::AddFd()</a>, <a class="el" href="socket_8h-source.html#l00037">addr</a>, <a class="el" href="socket_8h-source.html#l00038">addy</a>, <a class="el" href="socket_8cpp-source.html#l00139">Close()</a>, <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, <a class="el" href="socket_8h-source.html#l00033">fd</a>, <a class="el" href="socket_8h.html#InspSocketStateI_5FCONNECTING">I_CONNECTING</a>, <a class="el" href="socket_8h.html#InspSocketErrorI_5FERR_5FBIND">I_ERR_BIND</a>, <a class="el" href="socket_8h.html#InspSocketErrorI_5FERR_5FCONNECT">I_ERR_CONNECT</a>, <a class="el" href="socket_8h.html#InspSocketErrorI_5FERR_5FSOCKET">I_ERR_SOCKET</a>, <a class="el" href="socket_8h.html#InspSocketStateI_5FERROR">I_ERROR</a>, <a class="el" href="socket_8h.html#InspSocketStateI_5FLISTENING">I_LISTENING</a>, <a class="el" href="socket_8h-source.html#l00043">IP</a>, <a class="el" href="socket_8cpp-source.html#l00258">OnError()</a>, <a class="el" href="socket_8h-source.html#l00036">state</a>, <a class="el" href="socket_8h-source.html#l00040">timeout</a>, <a class="el" href="socket_8h-source.html#l00039">timeout_end</a>, and <a class="el" href="socketengine_8h-source.html#l00044">X_ESTAB_MODULE</a>.<div class="fragment"><pre class="fragment"><a name="l00063"></a>00063 { +References <a class="el" href="socketengine_8cpp-source.html#l00065">SocketEngine::AddFd()</a>, <a class="el" href="socket_8h-source.html#l00078">addr</a>, <a class="el" href="socket_8h-source.html#l00084">addy</a>, <a class="el" href="socket_8cpp-source.html#l00139">Close()</a>, <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, <a class="el" href="socket_8h-source.html#l00054">fd</a>, <a class="el" href="socket_8h.html#InspSocketStateI_5FCONNECTING">I_CONNECTING</a>, <a class="el" href="socket_8h.html#InspSocketErrorI_5FERR_5FBIND">I_ERR_BIND</a>, <a class="el" href="socket_8h.html#InspSocketErrorI_5FERR_5FCONNECT">I_ERR_CONNECT</a>, <a class="el" href="socket_8h.html#InspSocketErrorI_5FERR_5FSOCKET">I_ERR_SOCKET</a>, <a class="el" href="socket_8h.html#InspSocketStateI_5FERROR">I_ERROR</a>, <a class="el" href="socket_8h.html#InspSocketStateI_5FLISTENING">I_LISTENING</a>, <a class="el" href="socket_8h-source.html#l00113">IP</a>, <a class="el" href="socket_8cpp-source.html#l00262">OnError()</a>, <a class="el" href="socket_8h-source.html#l00072">state</a>, <a class="el" href="socket_8h-source.html#l00097">timeout</a>, <a class="el" href="socket_8h-source.html#l00091">timeout_end</a>, and <a class="el" href="socketengine_8h-source.html#l00044">X_ESTAB_MODULE</a>.<div class="fragment"><pre class="fragment"><a name="l00063"></a>00063 { <a name="l00064"></a>00064 <span class="keywordflow">if</span> (listening) { <a name="l00065"></a>00065 <span class="keywordflow">if</span> ((this->fd = OpenTCPSocket()) == ERROR) <a name="l00066"></a>00066 { @@ -324,13 +376,15 @@ References <a class="el" href="socketengine_8cpp-source.html#l00065">SocketEngin <td> <p> +The destructor may implicitly call <a class="el" href="classInspSocket.html#OnClose_28_29">OnClose()</a>, and will close() and shutdown() the file descriptor used for this socket. +<p> <p> -Definition at line <a class="el" href="socket_8cpp-source.html#l00265">265</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. +Definition at line <a class="el" href="socket_8cpp-source.html#l00269">269</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. <p> -References <a class="el" href="socket_8cpp-source.html#l00139">Close()</a>.<div class="fragment"><pre class="fragment"><a name="l00266"></a>00266 { -<a name="l00267"></a>00267 this-><a class="code" href="classInspSocket.html#Close_28_29">Close</a>(); -<a name="l00268"></a>00268 } +References <a class="el" href="socket_8cpp-source.html#l00139">Close()</a>.<div class="fragment"><pre class="fragment"><a name="l00270"></a>00270 { +<a name="l00271"></a>00271 this-><a class="code" href="classInspSocket.html#Close_28_29">Close</a>(); +<a name="l00272"></a>00272 } </pre></div> <p> </td> @@ -361,13 +415,15 @@ References <a class="el" href="socket_8cpp-source.html#l00139">Close()</a>.<div <td> <p> +This method causes the socket to close, and may also be triggered by other methods such as OnTimeout and OnError. +<p> <p> Definition at line <a class="el" href="socket_8cpp-source.html#l00139">139</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. <p> -References <a class="el" href="socket_8h-source.html#l00033">fd</a>, and <a class="el" href="socket_8cpp-source.html#l00263">OnClose()</a>. +References <a class="el" href="socket_8h-source.html#l00054">fd</a>, and <a class="el" href="socket_8cpp-source.html#l00267">OnClose()</a>. <p> -Referenced by <a class="el" href="socket_8cpp-source.html#l00062">InspSocket()</a>, and <a class="el" href="socket_8cpp-source.html#l00265">~InspSocket()</a>.<div class="fragment"><pre class="fragment"><a name="l00140"></a>00140 { +Referenced by <a class="el" href="socket_8cpp-source.html#l00062">InspSocket()</a>, and <a class="el" href="socket_8cpp-source.html#l00269">~InspSocket()</a>.<div class="fragment"><pre class="fragment"><a name="l00140"></a>00140 { <a name="l00141"></a>00141 <span class="keywordflow">if</span> (this->fd != -1) <a name="l00142"></a>00142 { <a name="l00143"></a>00143 this-><a class="code" href="classInspSocket.html#OnClose_28_29">OnClose</a>(); @@ -405,13 +461,15 @@ Referenced by <a class="el" href="socket_8cpp-source.html#l00062">InspSocket()</ <td> <p> +This method returns the socket's file descriptor as assigned by the operating system, or -1 if no descriptor has been assigned. +<p> <p> -Definition at line <a class="el" href="socket_8cpp-source.html#l00252">252</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. +Definition at line <a class="el" href="socket_8cpp-source.html#l00256">256</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. <p> -References <a class="el" href="socket_8h-source.html#l00033">fd</a>.<div class="fragment"><pre class="fragment"><a name="l00253"></a>00253 { -<a name="l00254"></a>00254 <span class="keywordflow">return</span> this-><a class="code" href="classInspSocket.html#fd">fd</a>; -<a name="l00255"></a>00255 } +References <a class="el" href="socket_8h-source.html#l00054">fd</a>.<div class="fragment"><pre class="fragment"><a name="l00257"></a>00257 { +<a name="l00258"></a>00258 <span class="keywordflow">return</span> this-><a class="code" href="classInspSocket.html#fd">fd</a>; +<a name="l00259"></a>00259 } </pre></div> <p> </td> @@ -441,11 +499,13 @@ References <a class="el" href="socket_8h-source.html#l00033">fd</a>.<div class=" <td> <p> +Returns the IP address associated with this connection, or an empty string if no IP address exists. +<p> <p> Definition at line <a class="el" href="socket_8cpp-source.html#l00150">150</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. <p> -References <a class="el" href="socket_8h-source.html#l00043">IP</a>.<div class="fragment"><pre class="fragment"><a name="l00151"></a>00151 { +References <a class="el" href="socket_8h-source.html#l00113">IP</a>.<div class="fragment"><pre class="fragment"><a name="l00151"></a>00151 { <a name="l00152"></a>00152 <span class="keywordflow">return</span> this-><a class="code" href="classInspSocket.html#IP">IP</a>; <a name="l00153"></a>00153 } </pre></div> @@ -477,13 +537,15 @@ References <a class="el" href="socket_8h-source.html#l00043">IP</a>.<div class=" <td> <p> +Returns the current socket state. +<p> <p> -Definition at line <a class="el" href="socket_8cpp-source.html#l00247">247</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. +Definition at line <a class="el" href="socket_8cpp-source.html#l00251">251</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. <p> -References <a class="el" href="socket_8h-source.html#l00036">state</a>.<div class="fragment"><pre class="fragment"><a name="l00248"></a>00248 { -<a name="l00249"></a>00249 <span class="keywordflow">return</span> this-><a class="code" href="classInspSocket.html#state">state</a>; -<a name="l00250"></a>00250 } +References <a class="el" href="socket_8h-source.html#l00072">state</a>.<div class="fragment"><pre class="fragment"><a name="l00252"></a>00252 { +<a name="l00253"></a>00253 <span class="keywordflow">return</span> this-><a class="code" href="classInspSocket.html#state">state</a>; +<a name="l00254"></a>00254 } </pre></div> <p> </td> @@ -513,11 +575,13 @@ References <a class="el" href="socket_8h-source.html#l00036">state</a>.<div clas <td> <p> - +Whenever close() is called, <a class="el" href="classInspSocket.html#OnClose_28_29">OnClose()</a> will be called first. <p> -Definition at line <a class="el" href="socket_8cpp-source.html#l00263">263</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. +Please note that this means OnClose will be called alongside <a class="el" href="classInspSocket.html#OnError_28InspSocketError_20e_29">OnError()</a>, <a class="el" href="classInspSocket.html#OnTimeout_28_29">OnTimeout()</a>, and <a class="el" href="classInspSocket.html#Close_28_29">Close()</a>, and also when cancelling a listening socket by calling the destructor indirectly. <p> -Referenced by <a class="el" href="socket_8cpp-source.html#l00139">Close()</a>.<div class="fragment"><pre class="fragment"><a name="l00263"></a>00263 { <span class="keywordflow">return</span>; } +Definition at line <a class="el" href="socket_8cpp-source.html#l00267">267</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. +<p> +Referenced by <a class="el" href="socket_8cpp-source.html#l00139">Close()</a>.<div class="fragment"><pre class="fragment"><a name="l00267"></a>00267 { <span class="keywordflow">return</span>; } </pre></div> <p> </td> @@ -547,11 +611,14 @@ Referenced by <a class="el" href="socket_8cpp-source.html#l00139">Close()</a>.<d <td> <p> +This method is called when an outbound connection on your socket is completed. +<p> +<dl compact><dt><b>Returns:</b></dt><dd>false to abort the connection, true to continue</dd></dl> <p> -Definition at line <a class="el" href="socket_8cpp-source.html#l00257">257</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. +Definition at line <a class="el" href="socket_8cpp-source.html#l00261">261</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. <p> -Referenced by <a class="el" href="socket_8cpp-source.html#l00197">Poll()</a>.<div class="fragment"><pre class="fragment"><a name="l00257"></a>00257 { <span class="keywordflow">return</span> <span class="keyword">true</span>; } +Referenced by <a class="el" href="socket_8cpp-source.html#l00214">Poll()</a>.<div class="fragment"><pre class="fragment"><a name="l00261"></a>00261 { <span class="keywordflow">return</span> <span class="keyword">true</span>; } </pre></div> <p> </td> @@ -581,11 +648,14 @@ Referenced by <a class="el" href="socket_8cpp-source.html#l00197">Poll()</a>.<di <td> <p> +When there is data waiting to be read on a socket, the <a class="el" href="classInspSocket.html#OnDataReady_28_29">OnDataReady()</a> method is called. +<p> +Within this method, you *MUST* call the <a class="el" href="classInspSocket.html#Read_28_29">Read()</a> 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 <a class="el" href="classInspSocket.html#Close_28_29">InspSocket::Close()</a> and deletes it. <dl compact><dt><b>Returns:</b></dt><dd>false to close the socket</dd></dl> <p> -Definition at line <a class="el" href="socket_8cpp-source.html#l00261">261</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. +Definition at line <a class="el" href="socket_8cpp-source.html#l00265">265</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. <p> -Referenced by <a class="el" href="socket_8cpp-source.html#l00197">Poll()</a>.<div class="fragment"><pre class="fragment"><a name="l00261"></a>00261 { <span class="keywordflow">return</span> <span class="keyword">true</span>; } +Referenced by <a class="el" href="socket_8cpp-source.html#l00214">Poll()</a>.<div class="fragment"><pre class="fragment"><a name="l00265"></a>00265 { <span class="keywordflow">return</span> <span class="keyword">true</span>; } </pre></div> <p> </td> @@ -615,9 +685,11 @@ Referenced by <a class="el" href="socket_8cpp-source.html#l00197">Poll()</a>.<di <td> <p> +When an established connection is terminated, the OnDisconnect method is triggered. +<p> <p> -Definition at line <a class="el" href="socket_8cpp-source.html#l00259">259</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00259"></a>00259 { <span class="keywordflow">return</span> 0; } +Definition at line <a class="el" href="socket_8cpp-source.html#l00263">263</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00263"></a>00263 { <span class="keywordflow">return</span> 0; } </pre></div> <p> </td> @@ -648,11 +720,18 @@ Definition at line <a class="el" href="socket_8cpp-source.html#l00259">259</a> o <td> <p> +This method is called when an error occurs. +<p> +A closed socket in itself is not an error, however errors also generate close events. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>e</em> </td><td>The error type which occured</td></tr> + </table> +</dl> <p> -Definition at line <a class="el" href="socket_8cpp-source.html#l00258">258</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. +Definition at line <a class="el" href="socket_8cpp-source.html#l00262">262</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. <p> -Referenced by <a class="el" href="socket_8cpp-source.html#l00062">InspSocket()</a>, and <a class="el" href="socket_8cpp-source.html#l00197">Poll()</a>.<div class="fragment"><pre class="fragment"><a name="l00258"></a>00258 { <span class="keywordflow">return</span>; } +Referenced by <a class="el" href="socket_8cpp-source.html#l00062">InspSocket()</a>, and <a class="el" href="socket_8cpp-source.html#l00197">Timeout()</a>.<div class="fragment"><pre class="fragment"><a name="l00262"></a>00262 { <span class="keywordflow">return</span>; } </pre></div> <p> </td> @@ -692,11 +771,15 @@ Referenced by <a class="el" href="socket_8cpp-source.html#l00062">InspSocket()</ <td> <p> - +If your socket is a listening socket, when a new connection comes in on the socket this method will be called. <p> -Definition at line <a class="el" href="socket_8cpp-source.html#l00260">260</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. +Given the new file descriptor in the parameters, and the IP, it is recommended you copy them to a new instance of your socket class, e.g.:<p> +MySocket* newsocket = new MySocket(newfd,ip);<p> +Once you have done this, you can then associate the new socket with the core using <a class="el" href="classServer.html#AddSocket_28InspSocket_20_2Asock_29">Server::AddSocket()</a>. <p> -Referenced by <a class="el" href="socket_8cpp-source.html#l00197">Poll()</a>.<div class="fragment"><pre class="fragment"><a name="l00260"></a>00260 { <span class="keywordflow">return</span> 0; } +Definition at line <a class="el" href="socket_8cpp-source.html#l00264">264</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. +<p> +Referenced by <a class="el" href="socket_8cpp-source.html#l00214">Poll()</a>.<div class="fragment"><pre class="fragment"><a name="l00264"></a>00264 { <span class="keywordflow">return</span> 0; } </pre></div> <p> </td> @@ -726,11 +809,13 @@ Referenced by <a class="el" href="socket_8cpp-source.html#l00197">Poll()</a>.<di <td> <p> - +When an outbound connection fails, and the attempt times out, you will receive this event. <p> -Definition at line <a class="el" href="socket_8cpp-source.html#l00262">262</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. +The mthod will trigger once maxtime secons are reached (as given in the constructor) just before the socket's descriptor is closed. +<p> +Definition at line <a class="el" href="socket_8cpp-source.html#l00266">266</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. <p> -Referenced by <a class="el" href="socket_8cpp-source.html#l00197">Poll()</a>.<div class="fragment"><pre class="fragment"><a name="l00262"></a>00262 { <span class="keywordflow">return</span>; } +Referenced by <a class="el" href="socket_8cpp-source.html#l00197">Timeout()</a>.<div class="fragment"><pre class="fragment"><a name="l00266"></a>00266 { <span class="keywordflow">return</span>; } </pre></div> <p> </td> @@ -760,52 +845,41 @@ Referenced by <a class="el" href="socket_8cpp-source.html#l00197">Poll()</a>.<di <td> <p> - -<p> -Definition at line <a class="el" href="socket_8cpp-source.html#l00197">197</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. -<p> -References <a class="el" href="socketengine_8cpp-source.html#l00065">SocketEngine::AddFd()</a>, <a class="el" href="socket_8h-source.html#l00044">client</a>, <a class="el" href="socketengine_8cpp-source.html#l00103">SocketEngine::DelFd()</a>, <a class="el" href="socket_8h.html#InspSocketStateI_5FCONNECTED">I_CONNECTED</a>, <a class="el" href="socket_8h.html#InspSocketStateI_5FCONNECTING">I_CONNECTING</a>, <a class="el" href="socket_8h.html#InspSocketErrorI_5FERR_5FTIMEOUT">I_ERR_TIMEOUT</a>, <a class="el" href="socket_8h.html#InspSocketStateI_5FERROR">I_ERROR</a>, <a class="el" href="socket_8h.html#InspSocketStateI_5FLISTENING">I_LISTENING</a>, <a class="el" href="socket_8h-source.html#l00046">length</a>, <a class="el" href="socket_8cpp-source.html#l00257">OnConnected()</a>, <a class="el" href="socket_8cpp-source.html#l00261">OnDataReady()</a>, <a class="el" href="socket_8cpp-source.html#l00258">OnError()</a>, <a class="el" href="socket_8cpp-source.html#l00260">OnIncomingConnection()</a>, <a class="el" href="socket_8cpp-source.html#l00262">OnTimeout()</a>, <a class="el" href="socket_8cpp-source.html#l00241">SetState()</a>, <a class="el" href="socket_8h-source.html#l00036">state</a>, <a class="el" href="socket_8h-source.html#l00040">timeout</a>, <a class="el" href="socket_8h-source.html#l00039">timeout_end</a>, and <a class="el" href="socketengine_8h-source.html#l00044">X_ESTAB_MODULE</a>.<div class="fragment"><pre class="fragment"><a name="l00198"></a>00198 { -<a name="l00199"></a>00199 <span class="keywordflow">if</span> ((time(NULL) > <a class="code" href="classInspSocket.html#timeout_5Fend">timeout_end</a>) && (this->state == <a class="code" href="socket_8h.html#InspSocketStateI_5FCONNECTING">I_CONNECTING</a>)) -<a name="l00200"></a>00200 { -<a name="l00201"></a>00201 <span class="comment">// for non-listening sockets, the timeout can occur</span> -<a name="l00202"></a>00202 <span class="comment">// which causes termination of the connection after</span> -<a name="l00203"></a>00203 <span class="comment">// the given number of seconds without a successful</span> -<a name="l00204"></a>00204 <span class="comment">// connection.</span> -<a name="l00205"></a>00205 this-><a class="code" href="classInspSocket.html#OnTimeout_28_29">OnTimeout</a>(); -<a name="l00206"></a>00206 this-><a class="code" href="classInspSocket.html#OnError_28InspSocketError_20e_29">OnError</a>(<a class="code" href="socket_8h.html#InspSocketErrorI_5FERR_5FTIMEOUT">I_ERR_TIMEOUT</a>); -<a name="l00207"></a>00207 <a class="code" href="classInspSocket.html#timeout">timeout</a> = <span class="keyword">true</span>; -<a name="l00208"></a>00208 this-><a class="code" href="classInspSocket.html#state">state</a> = <a class="code" href="socket_8h.html#InspSocketStateI_5FERROR">I_ERROR</a>; -<a name="l00209"></a>00209 <span class="keywordflow">return</span> <span class="keyword">false</span>; -<a name="l00210"></a>00210 } -<a name="l00211"></a>00211 -<a name="l00212"></a>00212 <span class="keywordtype">int</span> incoming = -1; -<a name="l00213"></a>00213 -<a name="l00214"></a>00214 <span class="keywordflow">switch</span> (this->state) -<a name="l00215"></a>00215 { -<a name="l00216"></a>00216 <span class="keywordflow">case</span> <a class="code" href="socket_8h.html#InspSocketStateI_5FCONNECTING">I_CONNECTING</a>: -<a name="l00217"></a>00217 this-><a class="code" href="classInspSocket.html#SetState_28InspSocketState_20s_29">SetState</a>(<a class="code" href="socket_8h.html#InspSocketStateI_5FCONNECTED">I_CONNECTED</a>); -<a name="l00218"></a>00218 <span class="comment">/* Our socket was in write-state, so delete it and re-add it</span> -<a name="l00219"></a>00219 <span class="comment"> * in read-state.</span> -<a name="l00220"></a>00220 <span class="comment"> */</span> -<a name="l00221"></a>00221 <a class="code" href="modules_8cpp.html#SE">SE</a>-><a class="code" href="classSocketEngine.html#DelFd_28int_20fd_29">DelFd</a>(this->fd); -<a name="l00222"></a>00222 <a class="code" href="modules_8cpp.html#SE">SE</a>-><a class="code" href="classSocketEngine.html#AddFd_28int_20fd_2C_20bool_20readable_2C_20char_20type_29">AddFd</a>(this->fd,<span class="keyword">true</span>,<a class="code" href="socketengine_8h.html#X_5FESTAB_5FMODULE">X_ESTAB_MODULE</a>); -<a name="l00223"></a>00223 <span class="keywordflow">return</span> this-><a class="code" href="classInspSocket.html#OnConnected_28_29">OnConnected</a>(); -<a name="l00224"></a>00224 <span class="keywordflow">break</span>; -<a name="l00225"></a>00225 <span class="keywordflow">case</span> <a class="code" href="socket_8h.html#InspSocketStateI_5FLISTENING">I_LISTENING</a>: -<a name="l00226"></a>00226 <a class="code" href="classInspSocket.html#length">length</a> = <span class="keyword">sizeof</span> (<a class="code" href="classInspSocket.html#client">client</a>); -<a name="l00227"></a>00227 incoming = accept (this->fd, (sockaddr*)&<a class="code" href="classInspSocket.html#client">client</a>,&<a class="code" href="classInspSocket.html#length">length</a>); -<a name="l00228"></a>00228 this-><a class="code" href="classInspSocket.html#OnIncomingConnection_28int_20newfd_2C_20char_20_2Aip_29">OnIncomingConnection</a>(incoming,inet_ntoa(<a class="code" href="classInspSocket.html#client">client</a>.sin_addr)); -<a name="l00229"></a>00229 <span class="keywordflow">return</span> <span class="keyword">true</span>; -<a name="l00230"></a>00230 <span class="keywordflow">break</span>; -<a name="l00231"></a>00231 <span class="keywordflow">case</span> <a class="code" href="socket_8h.html#InspSocketStateI_5FCONNECTED">I_CONNECTED</a>: -<a name="l00232"></a>00232 <span class="keywordflow">return</span> this-><a class="code" href="classInspSocket.html#OnDataReady_28_29">OnDataReady</a>(); -<a name="l00233"></a>00233 <span class="keywordflow">break</span>; -<a name="l00234"></a>00234 <span class="keywordflow">default</span>: -<a name="l00235"></a>00235 <span class="keywordflow">break</span>; -<a name="l00236"></a>00236 } -<a name="l00237"></a>00237 -<a name="l00238"></a>00238 <span class="keywordflow">return</span> <span class="keyword">true</span>; -<a name="l00239"></a>00239 } +Only the core should call this function. +<p> +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. +<p> +Definition at line <a class="el" href="socket_8cpp-source.html#l00214">214</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. +<p> +References <a class="el" href="socketengine_8cpp-source.html#l00065">SocketEngine::AddFd()</a>, <a class="el" href="socket_8h-source.html#l00119">client</a>, <a class="el" href="socketengine_8cpp-source.html#l00103">SocketEngine::DelFd()</a>, <a class="el" href="socket_8h.html#InspSocketStateI_5FCONNECTED">I_CONNECTED</a>, <a class="el" href="socket_8h.html#InspSocketStateI_5FCONNECTING">I_CONNECTING</a>, <a class="el" href="socket_8h.html#InspSocketStateI_5FLISTENING">I_LISTENING</a>, <a class="el" href="socket_8h-source.html#l00131">length</a>, <a class="el" href="socket_8cpp-source.html#l00261">OnConnected()</a>, <a class="el" href="socket_8cpp-source.html#l00265">OnDataReady()</a>, <a class="el" href="socket_8cpp-source.html#l00264">OnIncomingConnection()</a>, <a class="el" href="socket_8cpp-source.html#l00245">SetState()</a>, and <a class="el" href="socketengine_8h-source.html#l00044">X_ESTAB_MODULE</a>.<div class="fragment"><pre class="fragment"><a name="l00215"></a>00215 { +<a name="l00216"></a>00216 <span class="keywordtype">int</span> incoming = -1; +<a name="l00217"></a>00217 +<a name="l00218"></a>00218 <span class="keywordflow">switch</span> (this->state) +<a name="l00219"></a>00219 { +<a name="l00220"></a>00220 <span class="keywordflow">case</span> <a class="code" href="socket_8h.html#InspSocketStateI_5FCONNECTING">I_CONNECTING</a>: +<a name="l00221"></a>00221 this-><a class="code" href="classInspSocket.html#SetState_28InspSocketState_20s_29">SetState</a>(<a class="code" href="socket_8h.html#InspSocketStateI_5FCONNECTED">I_CONNECTED</a>); +<a name="l00222"></a>00222 <span class="comment">/* Our socket was in write-state, so delete it and re-add it</span> +<a name="l00223"></a>00223 <span class="comment"> * in read-state.</span> +<a name="l00224"></a>00224 <span class="comment"> */</span> +<a name="l00225"></a>00225 <a class="code" href="modules_8cpp.html#SE">SE</a>-><a class="code" href="classSocketEngine.html#DelFd_28int_20fd_29">DelFd</a>(this->fd); +<a name="l00226"></a>00226 <a class="code" href="modules_8cpp.html#SE">SE</a>-><a class="code" href="classSocketEngine.html#AddFd_28int_20fd_2C_20bool_20readable_2C_20char_20type_29">AddFd</a>(this->fd,<span class="keyword">true</span>,<a class="code" href="socketengine_8h.html#X_5FESTAB_5FMODULE">X_ESTAB_MODULE</a>); +<a name="l00227"></a>00227 <span class="keywordflow">return</span> this-><a class="code" href="classInspSocket.html#OnConnected_28_29">OnConnected</a>(); +<a name="l00228"></a>00228 <span class="keywordflow">break</span>; +<a name="l00229"></a>00229 <span class="keywordflow">case</span> <a class="code" href="socket_8h.html#InspSocketStateI_5FLISTENING">I_LISTENING</a>: +<a name="l00230"></a>00230 <a class="code" href="classInspSocket.html#length">length</a> = <span class="keyword">sizeof</span> (<a class="code" href="classInspSocket.html#client">client</a>); +<a name="l00231"></a>00231 incoming = accept (this->fd, (sockaddr*)&<a class="code" href="classInspSocket.html#client">client</a>,&<a class="code" href="classInspSocket.html#length">length</a>); +<a name="l00232"></a>00232 this-><a class="code" href="classInspSocket.html#OnIncomingConnection_28int_20newfd_2C_20char_20_2Aip_29">OnIncomingConnection</a>(incoming,inet_ntoa(<a class="code" href="classInspSocket.html#client">client</a>.sin_addr)); +<a name="l00233"></a>00233 <span class="keywordflow">return</span> <span class="keyword">true</span>; +<a name="l00234"></a>00234 <span class="keywordflow">break</span>; +<a name="l00235"></a>00235 <span class="keywordflow">case</span> <a class="code" href="socket_8h.html#InspSocketStateI_5FCONNECTED">I_CONNECTED</a>: +<a name="l00236"></a>00236 <span class="keywordflow">return</span> this-><a class="code" href="classInspSocket.html#OnDataReady_28_29">OnDataReady</a>(); +<a name="l00237"></a>00237 <span class="keywordflow">break</span>; +<a name="l00238"></a>00238 <span class="keywordflow">default</span>: +<a name="l00239"></a>00239 <span class="keywordflow">break</span>; +<a name="l00240"></a>00240 } +<a name="l00241"></a>00241 +<a name="l00242"></a>00242 <span class="keywordflow">return</span> <span class="keyword">true</span>; +<a name="l00243"></a>00243 } </pre></div> <p> </td> @@ -835,11 +909,13 @@ References <a class="el" href="socketengine_8cpp-source.html#l00065">SocketEngin <td> <p> +Reads all pending bytes from the socket into a char* array which can be up to 16 kilobytes in length. +<p> <p> Definition at line <a class="el" href="socket_8cpp-source.html#l00155">155</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, and <a class="el" href="socket_8h-source.html#l00042">ibuf</a>.<div class="fragment"><pre class="fragment"><a name="l00156"></a>00156 { +References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, and <a class="el" href="socket_8h-source.html#l00106">ibuf</a>.<div class="fragment"><pre class="fragment"><a name="l00156"></a>00156 { <a name="l00157"></a>00157 <span class="keywordtype">int</span> n = recv(this->fd,this->ibuf,<span class="keyword">sizeof</span>(this->ibuf),0); <a name="l00158"></a>00158 <span class="keywordflow">if</span> (n > 0) <a name="l00159"></a>00159 { @@ -882,16 +958,70 @@ References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, and <a <td> <p> +Changes the socket's state. +<p> +The core uses this to change socket states, and you should not call it directly. +<p> +Definition at line <a class="el" href="socket_8cpp-source.html#l00245">245</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, and <a class="el" href="socket_8h-source.html#l00072">state</a>. +<p> +Referenced by <a class="el" href="socket_8cpp-source.html#l00214">Poll()</a>.<div class="fragment"><pre class="fragment"><a name="l00246"></a>00246 { +<a name="l00247"></a>00247 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"Socket state change"</span>); +<a name="l00248"></a>00248 this-><a class="code" href="classInspSocket.html#state">state</a> = s; +<a name="l00249"></a>00249 } +</pre></div> +<p> + </td> + </tr> +</table> +<a class="anchor" name="Timeout_28time_5Ft_20current_29"></a><!-- doxytag: member="InspSocket::Timeout" ref="Timeout_28time_5Ft_20current_29" args="(time_t current)" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">bool InspSocket::Timeout </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">time_t </td> + <td class="mdname1" valign="top" nowrap> <em>current</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> <p> -Definition at line <a class="el" href="socket_8cpp-source.html#l00241">241</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. +This function checks if the socket has timed out yet, given the current time in the parameter. <p> -References <a class="el" href="modules_8h-source.html#l00023">DEBUG</a>, and <a class="el" href="socket_8h-source.html#l00036">state</a>. +<dl compact><dt><b>Returns:</b></dt><dd>true if timed out, false if not timed out</dd></dl> + +<p> +Definition at line <a class="el" href="socket_8cpp-source.html#l00197">197</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>. <p> -Referenced by <a class="el" href="socket_8cpp-source.html#l00197">Poll()</a>.<div class="fragment"><pre class="fragment"><a name="l00242"></a>00242 { -<a name="l00243"></a>00243 log(<a class="code" href="modules_8h.html#DEBUG">DEBUG</a>,<span class="stringliteral">"Socket state change"</span>); -<a name="l00244"></a>00244 this-><a class="code" href="classInspSocket.html#state">state</a> = s; -<a name="l00245"></a>00245 } +References <a class="el" href="socket_8h.html#InspSocketStateI_5FCONNECTING">I_CONNECTING</a>, <a class="el" href="socket_8h.html#InspSocketErrorI_5FERR_5FTIMEOUT">I_ERR_TIMEOUT</a>, <a class="el" href="socket_8h.html#InspSocketStateI_5FERROR">I_ERROR</a>, <a class="el" href="socket_8cpp-source.html#l00262">OnError()</a>, <a class="el" href="socket_8cpp-source.html#l00266">OnTimeout()</a>, <a class="el" href="socket_8h-source.html#l00072">state</a>, <a class="el" href="socket_8h-source.html#l00097">timeout</a>, and <a class="el" href="socket_8h-source.html#l00091">timeout_end</a>.<div class="fragment"><pre class="fragment"><a name="l00198"></a>00198 { +<a name="l00199"></a>00199 <span class="keywordflow">if</span> ((this->state == <a class="code" href="socket_8h.html#InspSocketStateI_5FCONNECTING">I_CONNECTING</a>) && (current > <a class="code" href="classInspSocket.html#timeout_5Fend">timeout_end</a>)) +<a name="l00200"></a>00200 { +<a name="l00201"></a>00201 <span class="comment">// for non-listening sockets, the timeout can occur</span> +<a name="l00202"></a>00202 <span class="comment">// which causes termination of the connection after</span> +<a name="l00203"></a>00203 <span class="comment">// the given number of seconds without a successful</span> +<a name="l00204"></a>00204 <span class="comment">// connection.</span> +<a name="l00205"></a>00205 this-><a class="code" href="classInspSocket.html#OnTimeout_28_29">OnTimeout</a>(); +<a name="l00206"></a>00206 this-><a class="code" href="classInspSocket.html#OnError_28InspSocketError_20e_29">OnError</a>(<a class="code" href="socket_8h.html#InspSocketErrorI_5FERR_5FTIMEOUT">I_ERR_TIMEOUT</a>); +<a name="l00207"></a>00207 <a class="code" href="classInspSocket.html#timeout">timeout</a> = <span class="keyword">true</span>; +<a name="l00208"></a>00208 this-><a class="code" href="classInspSocket.html#state">state</a> = <a class="code" href="socket_8h.html#InspSocketStateI_5FERROR">I_ERROR</a>; +<a name="l00209"></a>00209 <span class="keywordflow">return</span> <span class="keyword">true</span>; +<a name="l00210"></a>00210 } +<a name="l00211"></a>00211 <span class="keywordflow">return</span> <span class="keyword">false</span>; +<a name="l00212"></a>00212 } </pre></div> <p> </td> @@ -922,6 +1052,13 @@ Referenced by <a class="el" href="socket_8cpp-source.html#l00197">Poll()</a>.<di <td> <p> +Writes a <a class="el" href="namespaceirc.html#string">std::string</a> to the socket. +<p> +No carriage returns or linefeeds are appended to the string. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The data to send</td></tr> + </table> +</dl> <p> Definition at line <a class="el" href="socket_8cpp-source.html#l00174">174</a> of file <a class="el" href="socket_8cpp-source.html">socket.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00175"></a>00175 { @@ -971,9 +1108,11 @@ Definition at line <a class="el" href="socket_8cpp-source.html#l00174">174</a> o <td> <p> +The host being connected to, in sockaddr form. +<p> <p> -Definition at line <a class="el" href="socket_8h-source.html#l00037">37</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. +Definition at line <a class="el" href="socket_8h-source.html#l00078">78</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. <p> Referenced by <a class="el" href="socket_8cpp-source.html#l00062">InspSocket()</a>. </td> </tr> @@ -998,9 +1137,11 @@ Referenced by <a class="el" href="socket_8cpp-source.html#l00062">InspSocket()</ <td> <p> +The host being connected to, in in_addr form. +<p> <p> -Definition at line <a class="el" href="socket_8h-source.html#l00038">38</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. +Definition at line <a class="el" href="socket_8h-source.html#l00084">84</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. <p> Referenced by <a class="el" href="socket_8cpp-source.html#l00062">InspSocket()</a>. </td> </tr> @@ -1025,11 +1166,13 @@ Referenced by <a class="el" href="socket_8cpp-source.html#l00062">InspSocket()</ <td> <p> +Client sockaddr structure used by accept(). +<p> <p> -Definition at line <a class="el" href="socket_8h-source.html#l00044">44</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. +Definition at line <a class="el" href="socket_8h-source.html#l00119">119</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. <p> -Referenced by <a class="el" href="socket_8cpp-source.html#l00197">Poll()</a>. </td> +Referenced by <a class="el" href="socket_8cpp-source.html#l00214">Poll()</a>. </td> </tr> </table> <a class="anchor" name="fd"></a><!-- doxytag: member="InspSocket::fd" ref="fd" args="" --><p> @@ -1052,11 +1195,13 @@ Referenced by <a class="el" href="socket_8cpp-source.html#l00197">Poll()</a>. <td> <p> +The file descriptor of this socket. +<p> <p> -Definition at line <a class="el" href="socket_8h-source.html#l00033">33</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. +Definition at line <a class="el" href="socket_8h-source.html#l00054">54</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. <p> -Referenced by <a class="el" href="socket_8cpp-source.html#l00139">Close()</a>, <a class="el" href="socket_8cpp-source.html#l00252">GetFd()</a>, and <a class="el" href="socket_8cpp-source.html#l00054">InspSocket()</a>. </td> +Referenced by <a class="el" href="socket_8cpp-source.html#l00139">Close()</a>, <a class="el" href="socket_8cpp-source.html#l00256">GetFd()</a>, and <a class="el" href="socket_8cpp-source.html#l00054">InspSocket()</a>. </td> </tr> </table> <a class="anchor" name="host"></a><!-- doxytag: member="InspSocket::host" ref="host" args="" --><p> @@ -1079,9 +1224,11 @@ Referenced by <a class="el" href="socket_8cpp-source.html#l00139">Close()</a>, < <td> <p> +The hostname connected to. +<p> <p> -Definition at line <a class="el" href="socket_8h-source.html#l00034">34</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. </td> +Definition at line <a class="el" href="socket_8h-source.html#l00059">59</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. </td> </tr> </table> <a class="anchor" name="ibuf_5B_31_36_33_38_34_5D"></a><!-- doxytag: member="InspSocket::ibuf" ref="ibuf_5B_31_36_33_38_34_5D" args="[16384]" --><p> @@ -1104,9 +1251,11 @@ Definition at line <a class="el" href="socket_8h-source.html#l00034">34</a> of f <td> <p> - +Socket input buffer, used by read(). <p> -Definition at line <a class="el" href="socket_8h-source.html#l00042">42</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. +The class which extends InspSocket is expected to implement an extendable buffer which can grow much larger than 16k, this buffer is just designed to be temporary storage. space. +<p> +Definition at line <a class="el" href="socket_8h-source.html#l00106">106</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. <p> Referenced by <a class="el" href="socket_8cpp-source.html#l00155">Read()</a>. </td> </tr> @@ -1131,9 +1280,11 @@ Referenced by <a class="el" href="socket_8cpp-source.html#l00155">Read()</a>. <td> <p> +The IP address being connected to stored in string form for easy retrieval by accessors. +<p> <p> -Definition at line <a class="el" href="socket_8h-source.html#l00043">43</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. +Definition at line <a class="el" href="socket_8h-source.html#l00113">113</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. <p> Referenced by <a class="el" href="socket_8cpp-source.html#l00150">GetIP()</a>, and <a class="el" href="socket_8cpp-source.html#l00054">InspSocket()</a>. </td> </tr> @@ -1158,36 +1309,13 @@ Referenced by <a class="el" href="socket_8cpp-source.html#l00150">GetIP()</a>, a <td> <p> - -<p> -Definition at line <a class="el" href="socket_8h-source.html#l00046">46</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. +Used by accept() to indicate the sizes of the sockaddr_in structures. <p> -Referenced by <a class="el" href="socket_8cpp-source.html#l00197">Poll()</a>. </td> - </tr> -</table> -<a class="anchor" name="polls"></a><!-- doxytag: member="InspSocket::polls" ref="polls" args="" --><p> -<table class="mdTable" cellpadding="2" cellspacing="0"> - <tr> - <td class="mdRow"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td class="md" nowrap valign="top">pollfd <a class="el" href="classInspSocket.html#polls">InspSocket::polls</a><code> [private]</code> </td> - </tr> - </table> - </td> - </tr> -</table> -<table cellspacing="5" cellpadding="0" border="0"> - <tr> - <td> - - </td> - <td> <p> - +Definition at line <a class="el" href="socket_8h-source.html#l00131">131</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. <p> -Definition at line <a class="el" href="socket_8h-source.html#l00041">41</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. </td> +Referenced by <a class="el" href="socket_8cpp-source.html#l00214">Poll()</a>. </td> </tr> </table> <a class="anchor" name="port"></a><!-- doxytag: member="InspSocket::port" ref="port" args="" --><p> @@ -1210,9 +1338,11 @@ Definition at line <a class="el" href="socket_8h-source.html#l00041">41</a> of f <td> <p> +The port connected to, or the port this socket is listening on. +<p> <p> -Definition at line <a class="el" href="socket_8h-source.html#l00035">35</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. </td> +Definition at line <a class="el" href="socket_8h-source.html#l00065">65</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. </td> </tr> </table> <a class="anchor" name="server"></a><!-- doxytag: member="InspSocket::server" ref="server" args="" --><p> @@ -1235,9 +1365,11 @@ Definition at line <a class="el" href="socket_8h-source.html#l00035">35</a> of f <td> <p> +<a class="el" href="classServer.html">Server</a> sockaddr structure used by accept(). +<p> <p> -Definition at line <a class="el" href="socket_8h-source.html#l00045">45</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. </td> +Definition at line <a class="el" href="socket_8h-source.html#l00125">125</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. </td> </tr> </table> <a class="anchor" name="state"></a><!-- doxytag: member="InspSocket::state" ref="state" args="" --><p> @@ -1260,11 +1392,13 @@ Definition at line <a class="el" href="socket_8h-source.html#l00045">45</a> of f <td> <p> +The state for this socket, either listening, connecting, connected or error. +<p> <p> -Definition at line <a class="el" href="socket_8h-source.html#l00036">36</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. +Definition at line <a class="el" href="socket_8h-source.html#l00072">72</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. <p> -Referenced by <a class="el" href="socket_8cpp-source.html#l00247">GetState()</a>, <a class="el" href="socket_8cpp-source.html#l00049">InspSocket()</a>, <a class="el" href="socket_8cpp-source.html#l00197">Poll()</a>, and <a class="el" href="socket_8cpp-source.html#l00241">SetState()</a>. </td> +Referenced by <a class="el" href="socket_8cpp-source.html#l00251">GetState()</a>, <a class="el" href="socket_8cpp-source.html#l00049">InspSocket()</a>, <a class="el" href="socket_8cpp-source.html#l00245">SetState()</a>, and <a class="el" href="socket_8cpp-source.html#l00197">Timeout()</a>. </td> </tr> </table> <a class="anchor" name="timeout"></a><!-- doxytag: member="InspSocket::timeout" ref="timeout" args="" --><p> @@ -1287,11 +1421,13 @@ Referenced by <a class="el" href="socket_8cpp-source.html#l00247">GetState()</a> <td> <p> +This value is true if the socket has timed out. +<p> <p> -Definition at line <a class="el" href="socket_8h-source.html#l00040">40</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. +Definition at line <a class="el" href="socket_8h-source.html#l00097">97</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. <p> -Referenced by <a class="el" href="socket_8cpp-source.html#l00062">InspSocket()</a>, and <a class="el" href="socket_8cpp-source.html#l00197">Poll()</a>. </td> +Referenced by <a class="el" href="socket_8cpp-source.html#l00062">InspSocket()</a>, and <a class="el" href="socket_8cpp-source.html#l00197">Timeout()</a>. </td> </tr> </table> <a class="anchor" name="timeout_5Fend"></a><!-- doxytag: member="InspSocket::timeout_end" ref="timeout_5Fend" args="" --><p> @@ -1314,16 +1450,18 @@ Referenced by <a class="el" href="socket_8cpp-source.html#l00062">InspSocket()</ <td> <p> +When this time is reached, the socket times out if it is in the CONNECTING state. +<p> <p> -Definition at line <a class="el" href="socket_8h-source.html#l00039">39</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. +Definition at line <a class="el" href="socket_8h-source.html#l00091">91</a> of file <a class="el" href="socket_8h-source.html">socket.h</a>. <p> -Referenced by <a class="el" href="socket_8cpp-source.html#l00062">InspSocket()</a>, and <a class="el" href="socket_8cpp-source.html#l00197">Poll()</a>. </td> +Referenced by <a class="el" href="socket_8cpp-source.html#l00062">InspSocket()</a>, and <a class="el" href="socket_8cpp-source.html#l00197">Timeout()</a>. </td> </tr> </table> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="socket_8h-source.html">socket.h</a><li><a class="el" href="socket_8cpp-source.html">socket.cpp</a></ul> -<hr size="1"><address style="align: right;"><small>Generated on Mon Dec 12 13:31:12 2005 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Mon Dec 12 18:31:02 2005 for InspIRCd by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address> </body> |