diff options
Diffstat (limited to 'doc/html/classsf_1_1SelectorBase.htm')
| -rwxr-xr-x | doc/html/classsf_1_1SelectorBase.htm | 165 |
1 files changed, 93 insertions, 72 deletions
diff --git a/doc/html/classsf_1_1SelectorBase.htm b/doc/html/classsf_1_1SelectorBase.htm index da83ca4..bd4a87c 100755 --- a/doc/html/classsf_1_1SelectorBase.htm +++ b/doc/html/classsf_1_1SelectorBase.htm @@ -10,45 +10,54 @@ <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> +<!-- Generated by Doxygen 1.5.8 --> +<div class="navigation" id="top"> + <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="annotated.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="annotated.htm"><span>Class List</span></a></li> + <li><a href="classes.htm"><span>Class Index</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="navpath"><b>sf</b>::<a class="el" href="classsf_1_1SelectorBase.htm">SelectorBase</a> + </div> </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_1SelectorBase.htm">SelectorBase</a></div> +<div class="contents"> <h1>sf::SelectorBase Class Reference</h1><!-- doxytag: class="sf::SelectorBase" -->Private base class for selectors. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="SelectorBase_8hpp-source.htm">SelectorBase.hpp</a>></code> <p> -<p>Inheritance diagram for sf::SelectorBase: +<div class="dynheader"> +Inheritance diagram for sf::SelectorBase:</div> +<div class="dynsection"> + <p><center><img src="classsf_1_1SelectorBase.png" usemap="#sf::SelectorBase_map" border="0" alt=""></center> <map name="sf::SelectorBase_map"> <area href="classsf_1_1Selector.htm" alt="sf::Selector< Type >" shape="rect" coords="0,56,127,80"> </map> +</div> + +<p> <a href="classsf_1_1SelectorBase-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 Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SelectorBase.htm#9e09a7275fbbffc8519dc8462a7bbf8d">SelectorBase</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#9e09a7275fbbffc8519dc8462a7bbf8d"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SelectorBase.htm#42b4a3dc10eec94f7c2631f624ea087f">Add</a> (<a class="el" href="classsf_1_1SocketHelper.htm#097d978a4a15af5f17089099edc23afa">SocketHelper::SocketType</a> Socket)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SelectorBase.htm#42b4a3dc10eec94f7c2631f624ea087f">Add</a> (SocketHelper::SocketType Socket)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add a socket to watch. <a href="#42b4a3dc10eec94f7c2631f624ea087f"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SelectorBase.htm#319664dddf8c2170ef5b6908c39de80e">Remove</a> (<a class="el" href="classsf_1_1SocketHelper.htm#097d978a4a15af5f17089099edc23afa">SocketHelper::SocketType</a> Socket)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SelectorBase.htm#319664dddf8c2170ef5b6908c39de80e">Remove</a> (SocketHelper::SocketType Socket)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a socket. <a href="#319664dddf8c2170ef5b6908c39de80e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SelectorBase.htm#e24ec8c1ac981b8411c1c209daf788d0">Clear</a> ()</td></tr> @@ -57,7 +66,7 @@ <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SelectorBase.htm#22ba5625f8b644effa55e1a1c43efa4f">Wait</a> (float Timeout=0.f)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Wait and collect sockets which are ready for reading. <a href="#22ba5625f8b644effa55e1a1c43efa4f"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1SocketHelper.htm#097d978a4a15af5f17089099edc23afa">SocketHelper::SocketType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SelectorBase.htm#36e6a8d623f97a3c91701113931a0389">GetSocketReady</a> (unsigned int Index)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">SocketHelper::SocketType </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1SelectorBase.htm#36e6a8d623f97a3c91701113931a0389">GetSocketReady</a> (unsigned int Index)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">After a call to <a class="el" href="classsf_1_1SelectorBase.htm#22ba5625f8b644effa55e1a1c43efa4f" title="Wait and collect sockets which are ready for reading.">Wait()</a>, get the Index-th socket which is ready for reading. <a href="#36e6a8d623f97a3c91701113931a0389"></a><br></td></tr> </table> @@ -65,10 +74,8 @@ Private base class for selectors. <p> As <a class="el" href="classsf_1_1Selector.htm" title="Selector allow reading from multiple sockets without blocking.">Selector</a> is a template class, this base is needed so that every system call get compiled in SFML (not inlined) -<p> - -<p> -Definition at line <a class="el" href="SelectorBase_8hpp-source.htm#l00043">43</a> of file <a class="el" href="SelectorBase_8hpp-source.htm">SelectorBase.hpp</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<p>Definition at line <a class="el" href="SelectorBase_8hpp-source.htm#l00043">43</a> of file <a class="el" href="SelectorBase_8hpp-source.htm">SelectorBase.hpp</a>.</p> +<hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="9e09a7275fbbffc8519dc8462a7bbf8d"></a><!-- doxytag: member="sf::SelectorBase::SelectorBase" ref="9e09a7275fbbffc8519dc8462a7bbf8d" args="()" --> <div class="memitem"> <div class="memproto"> @@ -78,7 +85,7 @@ Definition at line <a class="el" href="SelectorBase_8hpp-source.htm#l00043">43</ <td>(</td> <td class="paramname"> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> @@ -88,6 +95,8 @@ Definition at line <a class="el" href="SelectorBase_8hpp-source.htm#l00043">43</ Default constructor. <p> +<p>Definition at line <a class="el" href="SelectorBase_8cpp-source.htm#l00040">40</a> of file <a class="el" href="SelectorBase_8cpp-source.htm">SelectorBase.cpp</a>.</p> + </div> </div><p> <hr><h2>Member Function Documentation</h2> @@ -98,10 +107,10 @@ Default constructor. <tr> <td class="memname">void sf::SelectorBase::Add </td> <td>(</td> - <td class="paramtype"><a class="el" href="classsf_1_1SocketHelper.htm#097d978a4a15af5f17089099edc23afa">SocketHelper::SocketType</a> </td> + <td class="paramtype">SocketHelper::SocketType </td> <td class="paramname"> <em>Socket</em> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> @@ -112,126 +121,138 @@ Add a socket to watch. <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 add </td></tr> + <tr><td valign="top"></td><td valign="top"><em>Socket</em> </td><td>: Socket to add </td></tr> </table> </dl> +<p>Definition at line <a class="el" href="SelectorBase_8cpp-source.htm#l00050">50</a> of file <a class="el" href="SelectorBase_8cpp-source.htm">SelectorBase.cpp</a>.</p> + </div> </div><p> -<a class="anchor" name="319664dddf8c2170ef5b6908c39de80e"></a><!-- doxytag: member="sf::SelectorBase::Remove" ref="319664dddf8c2170ef5b6908c39de80e" args="(SocketHelper::SocketType Socket)" --> +<a class="anchor" name="e24ec8c1ac981b8411c1c209daf788d0"></a><!-- doxytag: member="sf::SelectorBase::Clear" ref="e24ec8c1ac981b8411c1c209daf788d0" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">void sf::SelectorBase::Remove </td> + <td class="memname">void sf::SelectorBase::Clear </td> <td>(</td> - <td class="paramtype"><a class="el" href="classsf_1_1SocketHelper.htm#097d978a4a15af5f17089099edc23afa">SocketHelper::SocketType</a> </td> - <td class="paramname"> <em>Socket</em> </td> + <td class="paramname"> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> <div class="memdoc"> <p> -Remove a socket. +Remove all sockets. <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 remove </td></tr> - </table> -</dl> + +<p>Reimplemented in <a class="el" href="classsf_1_1Selector.htm#92dcaf012e8effb02262717b10b1c6f4">sf::Selector< Type ></a>.</p> + +<p>Definition at line <a class="el" href="SelectorBase_8cpp-source.htm#l00072">72</a> of file <a class="el" href="SelectorBase_8cpp-source.htm">SelectorBase.cpp</a>.</p> </div> </div><p> -<a class="anchor" name="e24ec8c1ac981b8411c1c209daf788d0"></a><!-- doxytag: member="sf::SelectorBase::Clear" ref="e24ec8c1ac981b8411c1c209daf788d0" args="()" --> +<a class="anchor" name="36e6a8d623f97a3c91701113931a0389"></a><!-- doxytag: member="sf::SelectorBase::GetSocketReady" ref="36e6a8d623f97a3c91701113931a0389" args="(unsigned int Index)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">void sf::SelectorBase::Clear </td> + <td class="memname">SocketHelper::SocketType sf::SelectorBase::GetSocketReady </td> <td>(</td> - <td class="paramname"> </td> + <td class="paramtype">unsigned int </td> + <td class="paramname"> <em>Index</em> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> <div class="memdoc"> <p> -Remove all sockets. +After a call to <a class="el" href="classsf_1_1SelectorBase.htm#22ba5625f8b644effa55e1a1c43efa4f" title="Wait and collect sockets which are ready for reading.">Wait()</a>, get the Index-th socket which is ready for reading. <p> +After a call to <a class="el" href="classsf_1_1SelectorBase.htm#22ba5625f8b644effa55e1a1c43efa4f" title="Wait and collect sockets which are ready for reading.">Wait()</a>, get the Index-th socket which is ready for reading.<p> +The total number of sockets ready is the integer returned by the previous call to <a class="el" href="classsf_1_1SelectorBase.htm#22ba5625f8b644effa55e1a1c43efa4f" title="Wait and collect sockets which are ready for reading.">Wait()</a><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>Index</em> </td><td>: Index of the socket to get</td></tr> + </table> +</dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>The Index-th socket</dd></dl> +The total number of sockets ready is the integer returned by the previous call to <a class="el" href="classsf_1_1SelectorBase.htm#22ba5625f8b644effa55e1a1c43efa4f" title="Wait and collect sockets which are ready for reading.">Wait()</a> +<p>Reimplemented in <a class="el" href="classsf_1_1Selector.htm#c9000a3e909b4db03961e220d4c6f9d9">sf::Selector< Type ></a>.</p> + +<p>Definition at line <a class="el" href="SelectorBase_8cpp-source.htm#l00108">108</a> of file <a class="el" href="SelectorBase_8cpp-source.htm">SelectorBase.cpp</a>.</p> -<p> -Reimplemented in <a class="el" href="classsf_1_1Selector.htm#92dcaf012e8effb02262717b10b1c6f4">sf::Selector< Type ></a>. </div> </div><p> -<a class="anchor" name="22ba5625f8b644effa55e1a1c43efa4f"></a><!-- doxytag: member="sf::SelectorBase::Wait" ref="22ba5625f8b644effa55e1a1c43efa4f" args="(float Timeout=0.f)" --> +<a class="anchor" name="319664dddf8c2170ef5b6908c39de80e"></a><!-- doxytag: member="sf::SelectorBase::Remove" ref="319664dddf8c2170ef5b6908c39de80e" args="(SocketHelper::SocketType Socket)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">unsigned int sf::SelectorBase::Wait </td> + <td class="memname">void sf::SelectorBase::Remove </td> <td>(</td> - <td class="paramtype">float </td> - <td class="paramname"> <em>Timeout</em> = <code>0.f</code> </td> + <td class="paramtype">SocketHelper::SocketType </td> + <td class="paramname"> <em>Socket</em> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> <div class="memdoc"> <p> -Wait and collect sockets which are ready for reading. +Remove a socket. <p> -This functions will return either when at least one socket is ready, or when the given time is out<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>Timeout</em> </td><td>: Timeout, in seconds (0 by default : no timeout)</td></tr> + <tr><td valign="top"></td><td valign="top"><em>Socket</em> </td><td>: Socket to remove </td></tr> </table> </dl> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of sockets ready to be read </dd></dl> -<p> -Reimplemented in <a class="el" href="classsf_1_1Selector.htm#c259fdd26dd0fb2a29a73b1f08093e0b">sf::Selector< Type ></a>. +<p>Definition at line <a class="el" href="SelectorBase_8cpp-source.htm#l00063">63</a> of file <a class="el" href="SelectorBase_8cpp-source.htm">SelectorBase.cpp</a>.</p> + </div> </div><p> -<a class="anchor" name="36e6a8d623f97a3c91701113931a0389"></a><!-- doxytag: member="sf::SelectorBase::GetSocketReady" ref="36e6a8d623f97a3c91701113931a0389" args="(unsigned int Index)" --> +<a class="anchor" name="22ba5625f8b644effa55e1a1c43efa4f"></a><!-- doxytag: member="sf::SelectorBase::Wait" ref="22ba5625f8b644effa55e1a1c43efa4f" args="(float Timeout=0.f)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname"><a class="el" href="classsf_1_1SocketHelper.htm#097d978a4a15af5f17089099edc23afa">SocketHelper::SocketType</a> sf::SelectorBase::GetSocketReady </td> + <td class="memname">unsigned int sf::SelectorBase::Wait </td> <td>(</td> - <td class="paramtype">unsigned int </td> - <td class="paramname"> <em>Index</em> </td> + <td class="paramtype">float </td> + <td class="paramname"> <em>Timeout</em> = <code>0.f</code> </td> <td> ) </td> - <td width="100%"></td> + <td></td> </tr> </table> </div> <div class="memdoc"> <p> -After a call to <a class="el" href="classsf_1_1SelectorBase.htm#22ba5625f8b644effa55e1a1c43efa4f" title="Wait and collect sockets which are ready for reading.">Wait()</a>, get the Index-th socket which is ready for reading. +Wait and collect sockets which are ready for reading. <p> -The total number of sockets ready is the integer returned by the previous call to <a class="el" href="classsf_1_1SelectorBase.htm#22ba5625f8b644effa55e1a1c43efa4f" title="Wait and collect sockets which are ready for reading.">Wait()</a><p> +This functions will return either when at least one socket is ready, or when the given time is out<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>Index</em> </td><td>: Index of the socket to get</td></tr> + <tr><td valign="top"></td><td valign="top"><em>Timeout</em> </td><td>: Timeout, in seconds (0 by default : no timeout)</td></tr> </table> </dl> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>The Index-th socket </dd></dl> +<dl class="return" compact><dt><b>Returns:</b></dt><dd>Number of sockets ready to be read</dd></dl> +This functions will return either when at least one socket is ready, or when the given time is out +<p>Reimplemented in <a class="el" href="classsf_1_1Selector.htm#c259fdd26dd0fb2a29a73b1f08093e0b">sf::Selector< Type ></a>.</p> + +<p>Definition at line <a class="el" href="SelectorBase_8cpp-source.htm#l00086">86</a> of file <a class="el" href="SelectorBase_8cpp-source.htm">SelectorBase.cpp</a>.</p> -<p> -Reimplemented in <a class="el" href="classsf_1_1Selector.htm#c9000a3e909b4db03961e220d4c6f9d9">sf::Selector< Type ></a>. </div> </div><p> -<hr>The documentation for this class was generated from the following file:<ul> -<li><a class="el" href="SelectorBase_8hpp-source.htm">SelectorBase.hpp</a></ul> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="SelectorBase_8hpp-source.htm">SelectorBase.hpp</a><li><a class="el" href="SelectorBase_8cpp-source.htm">SelectorBase.cpp</a></ul> +</div> <p id="footer"> :: Copyright © 2007-2008 Laurent Gomila, all rights reserved :: |