docs/api/rb/Selenium/WebDriver/SocketPoller.html - external/selenium - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>
   Class: Selenium::WebDriver::SocketPoller

     &mdash; Documentation by YARD 0.8.1

 </title>

   <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />

   <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />

 <script type="text/javascript" charset="utf-8">
   hasFrames = window.top.frames.main ? true : false;
   relpath = '../../';
   framesUrl = "../../frames.html#!" + escape(window.location.href);
 </script>


   <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>

   <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>


   </head>
   <body>
     <div id="header">
       <div id="menu">

     <a href="../../_index.html">Index (S)</a> &raquo;
     <span class='title'><span class='object_link'><a href="../../Selenium.html" title="Selenium (module)">Selenium</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../WebDriver.html" title="Selenium::WebDriver (module)">WebDriver</a></span></span>
      &raquo;
     <span class="title">SocketPoller</span>


   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
 </div>

       <div id="search">

     <a class="full_list_link" id="class_list_link"
         href="../../class_list.html">
       Class List
     </a>

     <a class="full_list_link" id="method_list_link"
         href="../../method_list.html">
       Method List
     </a>

     <a class="full_list_link" id="file_list_link"
         href="../../file_list.html">
       File List
     </a>

 </div>
       <div class="clear"></div>
     </div>

     <iframe id="search_frame"></iframe>

     <div id="content"><h1>Class: Selenium::WebDriver::SocketPoller


 </h1>

 <dl class="box">

     <dt class="r1">Inherits:</dt>
     <dd class="r1">
       <span class="inheritName">Object</span>

         <ul class="fullTree">
           <li>Object</li>

             <li class="next">Selenium::WebDriver::SocketPoller</li>

         </ul>
         <a href="#" class="inheritanceTree">show all</a>

       </dd>


     <dt class="r2 last">Defined in:</dt>
     <dd class="r2 last">rb/lib/selenium/webdriver/common/socket_poller.rb</dd>

 </dl>
 <div class="clear"></div>


   <h2>Constant Summary</h2>


     <h2>
       Instance Method Summary
       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
     </h2>

     <ul class="summary">

         <li class="public ">
   <span class="summary_signature">

       <a href="#closed%3F-instance_method" title="#closed? (instance method)">- (Boolean) <strong>closed?</strong> </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Returns true if the server has stopped listening within the given timeout,
 false otherwise.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#connected%3F-instance_method" title="#connected? (instance method)">- (Boolean) <strong>connected?</strong> </a>


   </span>


     <span class="summary_desc"><div class='inline'>
 <p>Returns true if the server is listening within the given timeout, false
 otherwise.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#initialize-instance_method" title="#initialize (instance method)">- (SocketPoller) <strong>initialize</strong>(host, port, timeout = 0, interval = 0.25) </a>


   </span>


     <span class="note title constructor">constructor</span>


     <span class="summary_desc"><div class='inline'>
 <p>A new instance of SocketPoller.</p>
 </div></span>

 </li>


         <li class="public ">
   <span class="summary_signature">

       <a href="#listening%3F-instance_method" title="#listening? (instance method)">- (Boolean) <strong>listening?</strong> </a>


   </span>


     <span class="summary_desc"><div class='inline'></div></span>

 </li>


     </ul>


 <div id="constructor_details" class="method_details_list">
   <h2>Constructor Details</h2>

     <div class="method_details first">
   <h3 class="signature first" id="initialize-instance_method">

     - (<tt><span class='object_link'><a href="" title="Selenium::WebDriver::SocketPoller (class)">SocketPoller</a></span></tt>) <strong>initialize</strong>(host, port, timeout = 0, interval = 0.25)


 </h3><div class="docstring">
   <div class="discussion">

 <p>A new instance of SocketPoller</p>


   </div>
 </div>
 <div class="tags">


 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 8
 9
 10
 11
 12
 13</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/socket_poller.rb', line 8</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_host'>host</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</span><span class='comma'>,</span> <span class='id identifier rubyid_timeout'>timeout</span> <span class='op'>=</span> <span class='int'>0</span><span class='comma'>,</span> <span class='id identifier rubyid_interval'>interval</span> <span class='op'>=</span> <span class='float'>0.25</span><span class='rparen'>)</span>
   <span class='ivar'>@host</span>     <span class='op'>=</span> <span class='id identifier rubyid_host'>host</span>
   <span class='ivar'>@port</span>     <span class='op'>=</span> <span class='const'>Integer</span><span class='lparen'>(</span><span class='id identifier rubyid_port'>port</span><span class='rparen'>)</span>
   <span class='ivar'>@timeout</span>  <span class='op'>=</span> <span class='const'>Float</span><span class='lparen'>(</span><span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
   <span class='ivar'>@interval</span> <span class='op'>=</span> <span class='id identifier rubyid_interval'>interval</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

 </div>


   <div id="instance_method_details" class="method_details_list">
     <h2>Instance Method Details</h2>


       <div class="method_details first">
   <h3 class="signature first" id="closed?-instance_method">

     - (<tt>Boolean</tt>) <strong>closed?</strong>


 </h3><div class="docstring">
   <div class="discussion">

 <p>Returns true if the server has stopped listening within the given timeout,
 false otherwise.</p>


   </div>
 </div>
 <div class="tags">

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt>Boolean</tt>)</span>


     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 33
 34
 35</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/socket_poller.rb', line 33</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_closed?'>closed?</span>
   <span class='id identifier rubyid_with_timeout'>with_timeout</span> <span class='lbrace'>{</span> <span class='kw'>not</span> <span class='id identifier rubyid_listening?'>listening?</span> <span class='rbrace'>}</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="connected?-instance_method">

     - (<tt>Boolean</tt>) <strong>connected?</strong>


 </h3><div class="docstring">
   <div class="discussion">

 <p>Returns true if the server is listening within the given timeout, false
 otherwise.</p>


   </div>
 </div>
 <div class="tags">

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt>Boolean</tt>)</span>


     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 22
 23
 24</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/socket_poller.rb', line 22</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_connected?'>connected?</span>
   <span class='id identifier rubyid_with_timeout'>with_timeout</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_listening?'>listening?</span> <span class='rbrace'>}</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="listening?-instance_method">

     - (<tt>Boolean</tt>) <strong>listening?</strong>


 </h3><div class="docstring">
   <div class="discussion">


   </div>
 </div>
 <div class="tags">

 <p class="tag_title">Returns:</p>
 <ul class="return">

     <li>


         <span class='type'>(<tt>Boolean</tt>)</span>


     </li>

 </ul>

 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">


 50
 51
 52
 53
 54
 55</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/socket_poller.rb', line 50</span>

 <span class='kw'>def</span> <span class='id identifier rubyid_listening?'>listening?</span>
   <span class='const'>TCPSocket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@host</span><span class='comma'>,</span> <span class='ivar'>@port</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
   <span class='kw'>true</span>
 <span class='kw'>rescue</span> <span class='op'>*</span><span class='const'>NOT_CONNECTED_ERRORS</span>
   <span class='kw'>false</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

   </div>

 </div>

     <div id="footer">
   Generated on Thu Jul 19 12:32:31 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.1 (ruby-1.9.3).
 </div>

   </body>
 </html>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<title>
	Class: Selenium::WebDriver::SocketPoller

	— Documentation by YARD 0.8.1

	</title>

	<link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />

	<link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />

	<script type="text/javascript" charset="utf-8">
	hasFrames = window.top.frames.main ? true : false;
	relpath = '../../';
	framesUrl = "../../frames.html#!" + escape(window.location.href);
	</script>


	<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>

	<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>


	</head>
	<body>
	<div id="header">
	<div id="menu">

	<a href="../../_index.html">Index (S)</a> »
	<span class='title'><span class='object_link'><a href="../../Selenium.html" title="Selenium (module)">Selenium</a></span></span> » <span class='title'><span class='object_link'><a href="../WebDriver.html" title="Selenium::WebDriver (module)">WebDriver</a></span></span>
	»
	<span class="title">SocketPoller</span>


	<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
	</div>

	<div id="search">

	<a class="full_list_link" id="class_list_link"
	href="../../class_list.html">
	Class List
	</a>

	<a class="full_list_link" id="method_list_link"
	href="../../method_list.html">
	Method List
	</a>

	<a class="full_list_link" id="file_list_link"
	href="../../file_list.html">
	File List
	</a>

	</div>
	<div class="clear"></div>
	</div>

	<iframe id="search_frame"></iframe>

	<div id="content"><h1>Class: Selenium::WebDriver::SocketPoller



	</h1>

	<dl class="box">

	<dt class="r1">Inherits:</dt>
	<dd class="r1">
	<span class="inheritName">Object</span>

	<ul class="fullTree">
	<li>Object</li>

	<li class="next">Selenium::WebDriver::SocketPoller</li>

	</ul>
	<a href="#" class="inheritanceTree">show all</a>

	</dd>









	<dt class="r2 last">Defined in:</dt>
	<dd class="r2 last">rb/lib/selenium/webdriver/common/socket_poller.rb</dd>

	</dl>
	<div class="clear"></div>


	<h2>Constant Summary</h2>









	<h2>
	Instance Method Summary
	<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
	</h2>

	<ul class="summary">

	<li class="public ">
	<span class="summary_signature">

	<a href="#closed%3F-instance_method" title="#closed? (instance method)">- (Boolean) <strong>closed?</strong> </a>



	</span>









	<span class="summary_desc"><div class='inline'>
	<p>Returns true if the server has stopped listening within the given timeout,
	false otherwise.</p>
	</div></span>

	</li>


	<li class="public ">
	<span class="summary_signature">

	<a href="#connected%3F-instance_method" title="#connected? (instance method)">- (Boolean) <strong>connected?</strong> </a>



	</span>









	<span class="summary_desc"><div class='inline'>
	<p>Returns true if the server is listening within the given timeout, false
	otherwise.</p>
	</div></span>

	</li>


	<li class="public ">
	<span class="summary_signature">

	<a href="#initialize-instance_method" title="#initialize (instance method)">- (SocketPoller) <strong>initialize</strong>(host, port, timeout = 0, interval = 0.25) </a>



	</span>


	<span class="note title constructor">constructor</span>








	<span class="summary_desc"><div class='inline'>
	<p>A new instance of SocketPoller.</p>
	</div></span>

	</li>


	<li class="public ">
	<span class="summary_signature">

	<a href="#listening%3F-instance_method" title="#listening? (instance method)">- (Boolean) <strong>listening?</strong> </a>



	</span>









	<span class="summary_desc"><div class='inline'></div></span>

	</li>


	</ul>


	<div id="constructor_details" class="method_details_list">
	<h2>Constructor Details</h2>

	<div class="method_details first">
	<h3 class="signature first" id="initialize-instance_method">

	- (<tt><span class='object_link'><a href="" title="Selenium::WebDriver::SocketPoller (class)">SocketPoller</a></span></tt>) <strong>initialize</strong>(host, port, timeout = 0, interval = 0.25)





	</h3><div class="docstring">
	<div class="discussion">

	<p>A new instance of SocketPoller</p>


	</div>
	</div>
	<div class="tags">


	</div><table class="source_code">
	<tr>
	<td>
	<pre class="lines">


	8
	9
	10
	11
	12
	13</pre>
	</td>
	<td>
	<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/socket_poller.rb', line 8</span>

	<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_host'>host</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</span><span class='comma'>,</span> <span class='id identifier rubyid_timeout'>timeout</span> <span class='op'>=</span> <span class='int'>0</span><span class='comma'>,</span> <span class='id identifier rubyid_interval'>interval</span> <span class='op'>=</span> <span class='float'>0.25</span><span class='rparen'>)</span>
	<span class='ivar'>@host</span> <span class='op'>=</span> <span class='id identifier rubyid_host'>host</span>
	<span class='ivar'>@port</span> <span class='op'>=</span> <span class='const'>Integer</span><span class='lparen'>(</span><span class='id identifier rubyid_port'>port</span><span class='rparen'>)</span>
	<span class='ivar'>@timeout</span> <span class='op'>=</span> <span class='const'>Float</span><span class='lparen'>(</span><span class='id identifier rubyid_timeout'>timeout</span><span class='rparen'>)</span>
	<span class='ivar'>@interval</span> <span class='op'>=</span> <span class='id identifier rubyid_interval'>interval</span>
	<span class='kw'>end</span></pre>
	</td>
	</tr>
	</table>
	</div>

	</div>


	<div id="instance_method_details" class="method_details_list">
	<h2>Instance Method Details</h2>


	<div class="method_details first">
	<h3 class="signature first" id="closed?-instance_method">

	- (<tt>Boolean</tt>) <strong>closed?</strong>





	</h3><div class="docstring">
	<div class="discussion">

	<p>Returns true if the server has stopped listening within the given timeout,
	false otherwise.</p>


	</div>
	</div>
	<div class="tags">

	<p class="tag_title">Returns:</p>
	<ul class="return">

	<li>


	<span class='type'>(<tt>Boolean</tt>)</span>



	</li>

	</ul>

	</div><table class="source_code">
	<tr>
	<td>
	<pre class="lines">


	33
	34
	35</pre>
	</td>
	<td>
	<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/socket_poller.rb', line 33</span>

	<span class='kw'>def</span> <span class='id identifier rubyid_closed?'>closed?</span>
	<span class='id identifier rubyid_with_timeout'>with_timeout</span> <span class='lbrace'>{</span> <span class='kw'>not</span> <span class='id identifier rubyid_listening?'>listening?</span> <span class='rbrace'>}</span>
	<span class='kw'>end</span></pre>
	</td>
	</tr>
	</table>
	</div>

	<div class="method_details ">
	<h3 class="signature " id="connected?-instance_method">

	- (<tt>Boolean</tt>) <strong>connected?</strong>





	</h3><div class="docstring">
	<div class="discussion">

	<p>Returns true if the server is listening within the given timeout, false
	otherwise.</p>


	</div>
	</div>
	<div class="tags">

	<p class="tag_title">Returns:</p>
	<ul class="return">

	<li>


	<span class='type'>(<tt>Boolean</tt>)</span>



	</li>

	</ul>

	</div><table class="source_code">
	<tr>
	<td>
	<pre class="lines">


	22
	23
	24</pre>
	</td>
	<td>
	<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/socket_poller.rb', line 22</span>

	<span class='kw'>def</span> <span class='id identifier rubyid_connected?'>connected?</span>
	<span class='id identifier rubyid_with_timeout'>with_timeout</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_listening?'>listening?</span> <span class='rbrace'>}</span>
	<span class='kw'>end</span></pre>
	</td>
	</tr>
	</table>
	</div>

	<div class="method_details ">
	<h3 class="signature " id="listening?-instance_method">

	- (<tt>Boolean</tt>) <strong>listening?</strong>





	</h3><div class="docstring">
	<div class="discussion">


	</div>
	</div>
	<div class="tags">

	<p class="tag_title">Returns:</p>
	<ul class="return">

	<li>


	<span class='type'>(<tt>Boolean</tt>)</span>



	</li>

	</ul>

	</div><table class="source_code">
	<tr>
	<td>
	<pre class="lines">


	50
	51
	52
	53
	54
	55</pre>
	</td>
	<td>
	<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/socket_poller.rb', line 50</span>

	<span class='kw'>def</span> <span class='id identifier rubyid_listening?'>listening?</span>
	<span class='const'>TCPSocket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@host</span><span class='comma'>,</span> <span class='ivar'>@port</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
	<span class='kw'>true</span>
	<span class='kw'>rescue</span> <span class='op'>*</span><span class='const'>NOT_CONNECTED_ERRORS</span>
	<span class='kw'>false</span>
	<span class='kw'>end</span></pre>
	</td>
	</tr>
	</table>
	</div>

	</div>

	</div>

	<div id="footer">
	Generated on Thu Jul 19 12:32:31 2012 by
	<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
	0.8.1 (ruby-1.9.3).
	</div>

	</body>
	</html>