docs/api/rb/Selenium/WebDriver/PortProber.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::PortProber

     &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 (P)</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">PortProber</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::PortProber


 </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::PortProber</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/port_prober.rb</dd>

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


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

     <ul class="summary">

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

       <a href="#above-class_method" title="above (class method)">+ (Object) <strong>above</strong>(port) </a>


   </span>


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

 </li>


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

       <a href="#free%3F-class_method" title="free? (class method)">+ (Boolean) <strong>free?</strong>(port) </a>


   </span>


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

 </li>


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

       <a href="#random-class_method" title="random (class method)">+ (Object) <strong>random</strong> </a>


   </span>


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

 </li>


     </ul>


   <div id="class_method_details" class="method_details_list">
     <h2>Class Method Details</h2>


       <div class="method_details first">
   <h3 class="signature first" id="above-class_method">

     + (<tt>Object</tt>) <strong>above</strong>(port)


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


 4
 5
 6
 7</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/port_prober.rb', line 4</span>

 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_above'>above</span><span class='lparen'>(</span><span class='id identifier rubyid_port'>port</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_port'>port</span> <span class='op'>+=</span> <span class='int'>1</span> <span class='kw'>until</span> <span class='id identifier rubyid_free?'>free?</span> <span class='id identifier rubyid_port'>port</span>
   <span class='id identifier rubyid_port'>port</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="free?-class_method">

     + (<tt>Boolean</tt>) <strong>free?</strong>(port)


 </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">


 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/port_prober.rb', line 22</span>

 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_free?'>free?</span><span class='lparen'>(</span><span class='id identifier rubyid_port'>port</span><span class='rparen'>)</span>
   <span class='const'>Platform</span><span class='period'>.</span><span class='id identifier rubyid_interfaces'>interfaces</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_host'>host</span><span class='op'>|</span>
     <span class='kw'>begin</span>
       <span class='const'>TCPServer</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</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='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
     <span class='kw'>rescue</span> <span class='const'>Errno</span><span class='op'>::</span><span class='const'>EADDRNOTAVAIL</span>
       <span class='gvar'>$stderr</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>port prober could not bind to </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_host'>host</span><span class='rbrace'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_port'>port</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='gvar'>$DEBUG</span>
       <span class='comment'># ignored - some machines appear unable to bind to some of their interfaces
 </span>    <span class='kw'>end</span>
   <span class='kw'>end</span>

   <span class='kw'>true</span>
 <span class='kw'>rescue</span> <span class='const'>SocketError</span><span class='comma'>,</span> <span class='const'>Errno</span><span class='op'>::</span><span class='const'>EADDRINUSE</span>
   <span class='kw'>false</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

       <div class="method_details ">
   <h3 class="signature " id="random-class_method">

     + (<tt>Object</tt>) <strong>random</strong>


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


 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20</pre>
     </td>
     <td>
       <pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/port_prober.rb', line 9</span>

 <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_random'>random</span>
   <span class='comment'># TODO: Avoid this
 </span>  <span class='comment'>#
 </span>  <span class='comment'># (a) should pick a port that's guaranteed to be free on all interfaces
 </span>  <span class='comment'># (b) should pick a random port outside the ephemeral port range
 </span>  <span class='comment'>#
 </span>  <span class='id identifier rubyid_server'>server</span> <span class='op'>=</span> <span class='const'>TCPServer</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>Platform</span><span class='period'>.</span><span class='id identifier rubyid_localhost'>localhost</span><span class='comma'>,</span> <span class='int'>0</span><span class='rparen'>)</span>
   <span class='id identifier rubyid_port'>port</span>   <span class='op'>=</span> <span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_addr'>addr</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
   <span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>

   <span class='id identifier rubyid_port'>port</span>
 <span class='kw'>end</span></pre>
     </td>
   </tr>
 </table>
 </div>

   </div>

 </div>

     <div id="footer">
   Generated on Thu Jul 19 12:32:30 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::PortProber

	— 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 (P)</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">PortProber</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::PortProber



	</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::PortProber</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/port_prober.rb</dd>

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









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

	<ul class="summary">

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

	<a href="#above-class_method" title="above (class method)">+ (Object) <strong>above</strong>(port) </a>



	</span>









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

	</li>


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

	<a href="#free%3F-class_method" title="free? (class method)">+ (Boolean) <strong>free?</strong>(port) </a>



	</span>









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

	</li>


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

	<a href="#random-class_method" title="random (class method)">+ (Object) <strong>random</strong> </a>



	</span>









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

	</li>


	</ul>




	<div id="class_method_details" class="method_details_list">
	<h2>Class Method Details</h2>


	<div class="method_details first">
	<h3 class="signature first" id="above-class_method">

	+ (<tt>Object</tt>) <strong>above</strong>(port)





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


	4
	5
	6
	7</pre>
	</td>
	<td>
	<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/port_prober.rb', line 4</span>

	<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_above'>above</span><span class='lparen'>(</span><span class='id identifier rubyid_port'>port</span><span class='rparen'>)</span>
	<span class='id identifier rubyid_port'>port</span> <span class='op'>+=</span> <span class='int'>1</span> <span class='kw'>until</span> <span class='id identifier rubyid_free?'>free?</span> <span class='id identifier rubyid_port'>port</span>
	<span class='id identifier rubyid_port'>port</span>
	<span class='kw'>end</span></pre>
	</td>
	</tr>
	</table>
	</div>

	<div class="method_details ">
	<h3 class="signature " id="free?-class_method">

	+ (<tt>Boolean</tt>) <strong>free?</strong>(port)





	</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">


	22
	23
	24
	25
	26
	27
	28
	29
	30
	31
	32
	33
	34
	35</pre>
	</td>
	<td>
	<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/port_prober.rb', line 22</span>

	<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_free?'>free?</span><span class='lparen'>(</span><span class='id identifier rubyid_port'>port</span><span class='rparen'>)</span>
	<span class='const'>Platform</span><span class='period'>.</span><span class='id identifier rubyid_interfaces'>interfaces</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>\|</span><span class='id identifier rubyid_host'>host</span><span class='op'>\|</span>
	<span class='kw'>begin</span>
	<span class='const'>TCPServer</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</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='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
	<span class='kw'>rescue</span> <span class='const'>Errno</span><span class='op'>::</span><span class='const'>EADDRNOTAVAIL</span>
	<span class='gvar'>$stderr</span><span class='period'>.</span><span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>port prober could not bind to </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_host'>host</span><span class='rbrace'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_port'>port</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='gvar'>$DEBUG</span>
	<span class='comment'># ignored - some machines appear unable to bind to some of their interfaces
	</span> <span class='kw'>end</span>
	<span class='kw'>end</span>

	<span class='kw'>true</span>
	<span class='kw'>rescue</span> <span class='const'>SocketError</span><span class='comma'>,</span> <span class='const'>Errno</span><span class='op'>::</span><span class='const'>EADDRINUSE</span>
	<span class='kw'>false</span>
	<span class='kw'>end</span></pre>
	</td>
	</tr>
	</table>
	</div>

	<div class="method_details ">
	<h3 class="signature " id="random-class_method">

	+ (<tt>Object</tt>) <strong>random</strong>





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


	9
	10
	11
	12
	13
	14
	15
	16
	17
	18
	19
	20</pre>
	</td>
	<td>
	<pre class="code"><span class="info file"># File 'rb/lib/selenium/webdriver/common/port_prober.rb', line 9</span>

	<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_random'>random</span>
	<span class='comment'># TODO: Avoid this
	</span> <span class='comment'>#
	</span> <span class='comment'># (a) should pick a port that's guaranteed to be free on all interfaces
	</span> <span class='comment'># (b) should pick a random port outside the ephemeral port range
	</span> <span class='comment'>#
	</span> <span class='id identifier rubyid_server'>server</span> <span class='op'>=</span> <span class='const'>TCPServer</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='const'>Platform</span><span class='period'>.</span><span class='id identifier rubyid_localhost'>localhost</span><span class='comma'>,</span> <span class='int'>0</span><span class='rparen'>)</span>
	<span class='id identifier rubyid_port'>port</span> <span class='op'>=</span> <span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_addr'>addr</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
	<span class='id identifier rubyid_server'>server</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>

	<span class='id identifier rubyid_port'>port</span>
	<span class='kw'>end</span></pre>
	</td>
	</tr>
	</table>
	</div>

	</div>

	</div>

	<div id="footer">
	Generated on Thu Jul 19 12:32:30 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>