diff options
| author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-12-12 13:32:15 +0000 |
|---|---|---|
| committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-12-12 13:32:15 +0000 |
| commit | 097b2479d0393d8a8bada4a50708d7a2404045ca (patch) | |
| tree | 8e624ea3c2035ebf8c64adfd3599a0fe1dce1556 /docs/module-doc/socketengine_8h.html | |
| parent | 277fc183721767efbce4b4cb1fc716c5f67d4752 (diff) | |
Added new docs for class SocketEngine
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2339 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/socketengine_8h.html')
| -rw-r--r-- | docs/module-doc/socketengine_8h.html | 218 |
1 files changed, 218 insertions, 0 deletions
diff --git a/docs/module-doc/socketengine_8h.html b/docs/module-doc/socketengine_8h.html new file mode 100644 index 000000000..f91808a45 --- /dev/null +++ b/docs/module-doc/socketengine_8h.html @@ -0,0 +1,218 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>InspIRCd: socketengine.h File Reference</title> +<link href="inspircd.doxygen.css" rel="stylesheet" type="text/css"> +</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> +<div class="nav"> +<a class="el" href="dir_000000.html">home</a> » <a class="el" href="dir_000001.html">brain</a> » <a class="el" href="dir_000002.html">inspircd-cvs</a> » <a class="el" href="dir_000003.html">inspircd</a> » <a class="el" href="dir_000004.html">include</a></div> +<h1>socketengine.h File Reference</h1><code>#include <vector></code><br> +<code>#include <string></code><br> +<code>#include "inspircd_config.h"</code><br> +<code>#include "globals.h"</code><br> +<code>#include "inspircd.h"</code><br> +<code>#include <sys/types.h></code><br> +<code>#include <sys/event.h></code><br> +<code>#include <sys/time.h></code><br> + +<p> +Include dependency graph for socketengine.h:<p><center><img src="socketengine_8h__incl.gif" border="0" usemap="#socketengine.h_map" alt=""></center> + +<p> +This graph shows which files directly or indirectly include this file:<p><center><img src="socketengine_8h__dep__incl.gif" border="0" usemap="#socketengine.hdep_map" alt=""></center> +<map name="socketengine.hdep_map"> +<area href="modules_8cpp-source.html" shape="rect" coords="180,7,279,33" alt=""> +<area href="socket_8cpp-source.html" shape="rect" coords="187,57,272,84" alt=""> +<area href="socketengine_8cpp-source.html" shape="rect" coords="167,108,292,135" alt=""> +</map> + +<p> +<a href="socketengine_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Classes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classSocketEngine.html">SocketEngine</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The actual socketengine class presents the same interface on all operating systems, but its private members and internal behaviour should be treated as blackboxed, and vary from system to system and upon the config settings chosen by the server admin. <a href="classSocketEngine.html#_details">More...</a><br></td></tr> +<tr><td colspan="2"><br><h2>Variables</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char </td><td class="memItemRight" valign="bottom"><a class="el" href="socketengine_8h.html#X_5FEMPTY_5FSLOT">X_EMPTY_SLOT</a> = 0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Each of these values represents a socket type in our reference table (the reference table itself is only accessible to <a class="el" href="socketengine_8cpp.html">socketengine.cpp</a>). <a href="#X_5FEMPTY_5FSLOT"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char </td><td class="memItemRight" valign="bottom"><a class="el" href="socketengine_8h.html#X_5FLISTEN">X_LISTEN</a> = 1</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char </td><td class="memItemRight" valign="bottom"><a class="el" href="socketengine_8h.html#X_5FESTAB_5FCLIENT">X_ESTAB_CLIENT</a> = 2</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char </td><td class="memItemRight" valign="bottom"><a class="el" href="socketengine_8h.html#X_5FESTAB_5FMODULE">X_ESTAB_MODULE</a> = 3</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char </td><td class="memItemRight" valign="bottom"><a class="el" href="socketengine_8h.html#X_5FESTAB_5FDNS">X_ESTAB_DNS</a> = 4</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char </td><td class="memItemRight" valign="bottom"><a class="el" href="socketengine_8h.html#X_5FREADBIT">X_READBIT</a> = 0x80</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">To indicate that a socket is readable, we mask its top bit with this X_READBIT value. <a href="#X_5FREADBIT"></a><br></td></tr> +</table> +<hr><h2>Variable Documentation</h2> +<a class="anchor" name="X_5FEMPTY_5FSLOT"></a><!-- doxytag: member="socketengine.h::X_EMPTY_SLOT" ref="X_5FEMPTY_5FSLOT" 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">const char <a class="el" href="socketengine_8h.html#X_5FEMPTY_5FSLOT">X_EMPTY_SLOT</a> = 0 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Each of these values represents a socket type in our reference table (the reference table itself is only accessible to <a class="el" href="socketengine_8cpp.html">socketengine.cpp</a>). +<p> + +<p> +Definition at line <a class="el" href="socketengine_8h-source.html#l00041">41</a> of file <a class="el" href="socketengine_8h-source.html">socketengine.h</a>. +<p> +Referenced by <a class="el" href="socketengine_8cpp-source.html#l00057">SocketEngine::GetType()</a>. </td> + </tr> +</table> +<a class="anchor" name="X_5FESTAB_5FCLIENT"></a><!-- doxytag: member="socketengine.h::X_ESTAB_CLIENT" ref="X_5FESTAB_5FCLIENT" 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">const char <a class="el" href="socketengine_8h.html#X_5FESTAB_5FCLIENT">X_ESTAB_CLIENT</a> = 2 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="socketengine_8h-source.html#l00043">43</a> of file <a class="el" href="socketengine_8h-source.html">socketengine.h</a>. </td> + </tr> +</table> +<a class="anchor" name="X_5FESTAB_5FDNS"></a><!-- doxytag: member="socketengine.h::X_ESTAB_DNS" ref="X_5FESTAB_5FDNS" 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">const char <a class="el" href="socketengine_8h.html#X_5FESTAB_5FDNS">X_ESTAB_DNS</a> = 4 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="socketengine_8h-source.html#l00045">45</a> of file <a class="el" href="socketengine_8h-source.html">socketengine.h</a>. </td> + </tr> +</table> +<a class="anchor" name="X_5FESTAB_5FMODULE"></a><!-- doxytag: member="socketengine.h::X_ESTAB_MODULE" ref="X_5FESTAB_5FMODULE" 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">const char <a class="el" href="socketengine_8h.html#X_5FESTAB_5FMODULE">X_ESTAB_MODULE</a> = 3 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="socketengine_8h-source.html#l00044">44</a> of file <a class="el" href="socketengine_8h-source.html">socketengine.h</a>. +<p> +Referenced by <a class="el" href="socket_8cpp-source.html#l00054">InspSocket::InspSocket()</a>, and <a class="el" href="socket_8cpp-source.html#l00197">InspSocket::Poll()</a>. </td> + </tr> +</table> +<a class="anchor" name="X_5FLISTEN"></a><!-- doxytag: member="socketengine.h::X_LISTEN" ref="X_5FLISTEN" 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">const char <a class="el" href="socketengine_8h.html#X_5FLISTEN">X_LISTEN</a> = 1 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="socketengine_8h-source.html#l00042">42</a> of file <a class="el" href="socketengine_8h-source.html">socketengine.h</a>. </td> + </tr> +</table> +<a class="anchor" name="X_5FREADBIT"></a><!-- doxytag: member="socketengine.h::X_READBIT" ref="X_5FREADBIT" 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">const char <a class="el" href="socketengine_8h.html#X_5FREADBIT">X_READBIT</a> = 0x80 </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +To indicate that a socket is readable, we mask its top bit with this X_READBIT value. +<p> +The socket engine can handle two types of socket, readable and writeable (error sockets are dealt with when read() and write() return negative or zero values). +<p> +Definition at line <a class="el" href="socketengine_8h-source.html#l00055">55</a> of file <a class="el" href="socketengine_8h-source.html">socketengine.h</a>. +<p> +Referenced by <a class="el" href="socketengine_8cpp-source.html#l00065">SocketEngine::AddFd()</a>, <a class="el" href="socketengine_8cpp-source.html#l00103">SocketEngine::DelFd()</a>, and <a class="el" href="socketengine_8cpp-source.html#l00146">SocketEngine::Wait()</a>. </td> + </tr> +</table> +<hr size="1"><address style="align: right;"><small>Generated on Mon Dec 12 13:31:11 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> +</html> |