diff options
Diffstat (limited to 'doc/html/classsf_1_1SocketHelper.htm')
| -rwxr-xr-x | doc/html/classsf_1_1SocketHelper.htm | 186 |
1 files changed, 186 insertions, 0 deletions
diff --git a/doc/html/classsf_1_1SocketHelper.htm b/doc/html/classsf_1_1SocketHelper.htm new file mode 100755 index 0000000..4327048 --- /dev/null +++ b/doc/html/classsf_1_1SocketHelper.htm @@ -0,0 +1,186 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> + <head> + <title>SFML - Simple and Fast Multimedia Library</title> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" /> + <link href="doxygen.css" rel="stylesheet" type="text/css" /> + <link href="tabs.css" rel="stylesheet" type="text/css" /> + </head> + <body> + <div id="logo"> + <img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" /> + </div> +<!-- Generated by Doxygen 1.5.2 --> +<div class="tabs"> + <ul> + <li><a href="index.htm"><span>Main Page</span></a></li> + <li><a href="namespaces.htm"><span>Namespaces</span></a></li> + <li class="current"><a href="classes.htm"><span>Classes</span></a></li> + <li><a href="files.htm"><span>Files</span></a></li> + </ul> +</div> +<div class="tabs"> + <ul> + <li><a href="classes.htm"><span>Alphabetical List</span></a></li> + <li><a href="annotated.htm"><span>Class List</span></a></li> + <li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li> + <li><a href="functions.htm"><span>Class Members</span></a></li> + </ul> +</div> +<div class="nav"> +<a class="el" href="namespacesf.htm">sf</a>::<a class="el" href="classsf_1_1SocketHelper.htm">SocketHelper</a></div> +<h1>sf::SocketHelper Class Reference</h1><!-- doxytag: class="sf::SocketHelper" -->This class defines helper functions to do all the non-portable socket stuff. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="Win32_2SocketHelper_8hpp-source.htm">SocketHelper.hpp</a>></code> +<p> +<a href="classsf_1_1SocketHelper-members.htm">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Types</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="097d978a4a15af5f17089099edc23afa"></a><!-- doxytag: member="sf::SocketHelper::SocketType" ref="097d978a4a15af5f17089099edc23afa" args="" --> +typedef SOCKET </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketHelper.htm#097d978a4a15af5f17089099edc23afa">SocketType</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a18a7737423675d9dc270a0bc7e159de"></a><!-- doxytag: member="sf::SocketHelper::LengthType" ref="a18a7737423675d9dc270a0bc7e159de" args="" --> +typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketHelper.htm#a18a7737423675d9dc270a0bc7e159de">LengthType</a></td></tr> + +<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classsf_1_1SocketHelper.htm#097d978a4a15af5f17089099edc23afa">SocketType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketHelper.htm#417a223f0362d7d33cddb47c5464dd21">InvalidSocket</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value of the invalid socket. <a href="#417a223f0362d7d33cddb47c5464dd21"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketHelper.htm#feb8116b59837e7759b1424c998cc186">Close</a> (<a class="el" href="classsf_1_1SocketHelper.htm#097d978a4a15af5f17089099edc23afa">SocketType</a> Socket)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Close / destroy a socket. <a href="#feb8116b59837e7759b1424c998cc186"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketHelper.htm#ae3b238fa3a38edbef099dc63c22c192">SetBlocking</a> (<a class="el" href="classsf_1_1SocketHelper.htm#097d978a4a15af5f17089099edc23afa">SocketType</a> Socket, bool Block)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a socket as blocking or non-blocking. <a href="#ae3b238fa3a38edbef099dc63c22c192"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="namespacesf_1_1Socket.htm#51bf0fd51057b98a10fbb866246176dc">Socket::Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SocketHelper.htm#e2ff906f79b41d5ad3a208811a8b2868">GetErrorStatus</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the last socket error status. <a href="#e2ff906f79b41d5ad3a208811a8b2868"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This class defines helper functions to do all the non-portable socket stuff. +<p> +This class is meant for internal use only +<p> + +<p> +Definition at line <a class="el" href="Win32_2SocketHelper_8hpp-source.htm#l00041">41</a> of file <a class="el" href="Win32_2SocketHelper_8hpp-source.htm">Win32/SocketHelper.hpp</a>.<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="417a223f0362d7d33cddb47c5464dd21"></a><!-- doxytag: member="sf::SocketHelper::InvalidSocket" ref="417a223f0362d7d33cddb47c5464dd21" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="classsf_1_1SocketHelper.htm#097d978a4a15af5f17089099edc23afa">SocketType</a> sf::SocketHelper::InvalidSocket </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Return the value of the invalid socket. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Unique value of the invalid socket </dd></dl> + +</div> +</div><p> +<a class="anchor" name="feb8116b59837e7759b1424c998cc186"></a><!-- doxytag: member="sf::SocketHelper::Close" ref="feb8116b59837e7759b1424c998cc186" args="(SocketType Socket)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static bool sf::SocketHelper::Close </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classsf_1_1SocketHelper.htm#097d978a4a15af5f17089099edc23afa">SocketType</a> </td> + <td class="paramname"> <em>Socket</em> </td> + <td> ) </td> + <td width="100%"><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Close / destroy a socket. +<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><a class="el" href="namespacesf_1_1Socket.htm">Socket</a></em> </td><td>: <a class="el" href="namespacesf_1_1Socket.htm">Socket</a> to close</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>True on success </dd></dl> + +</div> +</div><p> +<a class="anchor" name="ae3b238fa3a38edbef099dc63c22c192"></a><!-- doxytag: member="sf::SocketHelper::SetBlocking" ref="ae3b238fa3a38edbef099dc63c22c192" args="(SocketType Socket, bool Block)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static void sf::SocketHelper::SetBlocking </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classsf_1_1SocketHelper.htm#097d978a4a15af5f17089099edc23afa">SocketType</a> </td> + <td class="paramname"> <em>Socket</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">bool </td> + <td class="paramname"> <em>Block</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td width="100%"><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set a socket as blocking or non-blocking. +<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><a class="el" href="namespacesf_1_1Socket.htm">Socket</a></em> </td><td>: <a class="el" href="namespacesf_1_1Socket.htm">Socket</a> to modify </td></tr> + <tr><td valign="top"></td><td valign="top"><em>Block</em> </td><td>: New blocking state of the socket </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="e2ff906f79b41d5ad3a208811a8b2868"></a><!-- doxytag: member="sf::SocketHelper::GetErrorStatus" ref="e2ff906f79b41d5ad3a208811a8b2868" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">static <a class="el" href="namespacesf_1_1Socket.htm#51bf0fd51057b98a10fbb866246176dc">Socket::Status</a> sf::SocketHelper::GetErrorStatus </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Get the last socket error status. +<p> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Status corresponding to the last socket error </dd></dl> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="Win32_2SocketHelper_8hpp-source.htm">Win32/SocketHelper.hpp</a></ul> + + <p id="footer"> + :: Copyright © 2007-2008 Laurent Gomila, all rights reserved :: + Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.5.2</a> :: + </p> + + </body> +</html> |