classPassenger_1_1FileDescriptor.html in passenger-3.0.0.pre1

- old
+ new

@@ -1,12 +1,15 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<!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">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <title>Passenger: Passenger::FileDescriptor Class Reference</title>
-<link href="tabs.css" rel="stylesheet" type="text/css">
-<link href="doxygen.css" rel="stylesheet" type="text/css">
-</head><body>
-<!-- Generated by Doxygen 1.5.8 -->
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css"/>
+</head>
+<body>
+<!-- Generated by Doxygen 1.6.2 -->
 <div class="navigation" id="top">
   <div class="tabs">
     <ul>
       <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
       <li><a href="modules.html"><span>Modules</span></a></li>
@@ -24,136 +27,126 @@
   </div>
   <div class="navpath"><a class="el" href="namespacePassenger.html">Passenger</a>::<a class="el" href="classPassenger_1_1FileDescriptor.html">FileDescriptor</a>
   </div>
 </div>
 <div class="contents">
-<h1>Passenger::FileDescriptor Class Reference</h1><!-- doxytag: class="Passenger::FileDescriptor" -->Wrapper class around a file descriptor integer, for RAII behavior.  
-<a href="#_details">More...</a>
-<p>
-<code>#include &lt;<a class="el" href="FileDescriptor_8h-source.html">FileDescriptor.h</a>&gt;</code>
-<p>
+<h1>Passenger::FileDescriptor Class Reference</h1><!-- doxytag: class="Passenger::FileDescriptor" -->
+<p>Wrapper class around a file descriptor integer, for RAII behavior.  
+<a href="#_details">More...</a></p>
 
-<p>
-<a href="classPassenger_1_1FileDescriptor-members.html">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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1FileDescriptor.html#05d83ad9cc77c493a3ce4f2b51d44559">FileDescriptor</a> ()</td></tr>
+<p><code>#include &lt;<a class="el" href="FileDescriptor_8h_source.html">FileDescriptor.h</a>&gt;</code></p>
 
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new empty <a class="el" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> instance that has no underlying file descriptor.  <a href="#05d83ad9cc77c493a3ce4f2b51d44559"></a><br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1FileDescriptor.html#62c05b925cb1cf964169cef7635650ee">FileDescriptor</a> (int fd)</td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new <a class="el" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> instance with the given fd as a handle.  <a href="#62c05b925cb1cf964169cef7635650ee"></a><br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1FileDescriptor.html#d7c1a99531181878cbab74a7400c5432">close</a> ()</td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Close the underlying file descriptor.  <a href="#d7c1a99531181878cbab74a7400c5432"></a><br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1FileDescriptor.html#c335c2a97f3a6c8e3920f573b0d04081">operator int</a> () const </td></tr>
-
-<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overloads the integer cast operator so that it will return the underlying file descriptor handle as an integer.  <a href="#c335c2a97f3a6c8e3920f573b0d04081"></a><br></td></tr>
+<p><a href="classPassenger_1_1FileDescriptor-members.html">List of all members.</a></p>
+<table border="0" cellpadding="0" cellspacing="0">
+<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1FileDescriptor.html#a05d83ad9cc77c493a3ce4f2b51d44559">FileDescriptor</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new empty <a class="el" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> instance that has no underlying file descriptor.  <a href="#a05d83ad9cc77c493a3ce4f2b51d44559"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1FileDescriptor.html#a62c05b925cb1cf964169cef7635650ee">FileDescriptor</a> (int fd)</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new <a class="el" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> instance with the given fd as a handle.  <a href="#a62c05b925cb1cf964169cef7635650ee"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1FileDescriptor.html#ad7c1a99531181878cbab74a7400c5432">close</a> ()</td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Close the underlying file descriptor.  <a href="#ad7c1a99531181878cbab74a7400c5432"></a><br/></td></tr>
+<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPassenger_1_1FileDescriptor.html#ac335c2a97f3a6c8e3920f573b0d04081">operator int</a> () const </td></tr>
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Overloads the integer cast operator so that it will return the underlying file descriptor handle as an integer.  <a href="#ac335c2a97f3a6c8e3920f573b0d04081"></a><br/></td></tr>
 </table>
-<hr><a name="_details"></a><h2>Detailed Description</h2>
-Wrapper class around a file descriptor integer, for RAII behavior. 
-<p>
-A <a class="el" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> object behaves just like an int, so that you can pass it to system calls such as read(). It performs reference counting. When the last copy of a <a class="el" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> has been destroyed, the underlying file descriptor will be automatically closed. In this case, any <a class="el" href="classPassenger_1_1FileDescriptor.html#d7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">close()</a> system call errors are silently ignored. If you are interested in whether the <a class="el" href="classPassenger_1_1FileDescriptor.html#d7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">close()</a> system call succeeded, then you should call <a class="el" href="classPassenger_1_1FileDescriptor.html#d7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">FileDescriptor::close()</a>.<p>
-This class is *not* thread-safe. It is safe to call system calls on the underlying file descriptor from multiple threads, but it's not safe to call <a class="el" href="classPassenger_1_1FileDescriptor.html#d7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">FileDescriptor::close()</a> from multiple threads if all those <a class="el" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> objects point to the same underlying file descriptor. <hr><h2>Constructor &amp; Destructor Documentation</h2>
-<a class="anchor" name="05d83ad9cc77c493a3ce4f2b51d44559"></a><!-- doxytag: member="Passenger::FileDescriptor::FileDescriptor" ref="05d83ad9cc77c493a3ce4f2b51d44559" args="()" -->
+<hr/><a name="_details"></a><h2>Detailed Description</h2>
+<p>Wrapper class around a file descriptor integer, for RAII behavior. </p>
+<p>A <a class="el" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> object behaves just like an int, so that you can pass it to system calls such as read(). It performs reference counting. When the last copy of a <a class="el" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> has been destroyed, the underlying file descriptor will be automatically closed. In this case, any <a class="el" href="classPassenger_1_1FileDescriptor.html#ad7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">close()</a> system call errors are silently ignored. If you are interested in whether the <a class="el" href="classPassenger_1_1FileDescriptor.html#ad7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">close()</a> system call succeeded, then you should call <a class="el" href="classPassenger_1_1FileDescriptor.html#ad7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">FileDescriptor::close()</a>.</p>
+<p>This class is *not* thread-safe. It is safe to call system calls on the underlying file descriptor from multiple threads, but it's not safe to call <a class="el" href="classPassenger_1_1FileDescriptor.html#ad7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">FileDescriptor::close()</a> from multiple threads if all those <a class="el" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> objects point to the same underlying file descriptor. </p>
+<hr/><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" id="a05d83ad9cc77c493a3ce4f2b51d44559"></a><!-- doxytag: member="Passenger::FileDescriptor::FileDescriptor" ref="a05d83ad9cc77c493a3ce4f2b51d44559" args="()" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">Passenger::FileDescriptor::FileDescriptor           </td>
+          <td class="memname">Passenger::FileDescriptor::FileDescriptor </td>
           <td>(</td>
-          <td class="paramname">          </td>
+          <td class="paramname"></td>
           <td>&nbsp;)&nbsp;</td>
           <td><code> [inline]</code></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">
 
-<p>
-Creates a new empty <a class="el" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> instance that has no underlying file descriptor. 
-<p>
-<dl class="post" compact><dt><b>Postcondition:</b></dt><dd>*this == -1 </dd></dl>
+<p>Creates a new empty <a class="el" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> instance that has no underlying file descriptor. </p>
+<dl class="post"><dt><b>Postcondition:</b></dt><dd>*this == -1 </dd></dl>
 
 </div>
-</div><p>
-<a class="anchor" name="62c05b925cb1cf964169cef7635650ee"></a><!-- doxytag: member="Passenger::FileDescriptor::FileDescriptor" ref="62c05b925cb1cf964169cef7635650ee" args="(int fd)" -->
+</div>
+<a class="anchor" id="a62c05b925cb1cf964169cef7635650ee"></a><!-- doxytag: member="Passenger::FileDescriptor::FileDescriptor" ref="a62c05b925cb1cf964169cef7635650ee" args="(int fd)" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">Passenger::FileDescriptor::FileDescriptor           </td>
+          <td class="memname">Passenger::FileDescriptor::FileDescriptor </td>
           <td>(</td>
           <td class="paramtype">int&nbsp;</td>
-          <td class="paramname"> <em>fd</em>          </td>
+          <td class="paramname"> <em>fd</em></td>
           <td>&nbsp;)&nbsp;</td>
           <td><code> [inline]</code></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">
 
-<p>
-Creates a new <a class="el" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> instance with the given fd as a handle. 
-<p>
-<dl class="post" compact><dt><b>Postcondition:</b></dt><dd>*this == fd </dd></dl>
+<p>Creates a new <a class="el" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> instance with the given fd as a handle. </p>
+<dl class="post"><dt><b>Postcondition:</b></dt><dd>*this == fd </dd></dl>
 
 </div>
-</div><p>
-<hr><h2>Member Function Documentation</h2>
-<a class="anchor" name="d7c1a99531181878cbab74a7400c5432"></a><!-- doxytag: member="Passenger::FileDescriptor::close" ref="d7c1a99531181878cbab74a7400c5432" args="()" -->
+</div>
+<hr/><h2>Member Function Documentation</h2>
+<a class="anchor" id="ad7c1a99531181878cbab74a7400c5432"></a><!-- doxytag: member="Passenger::FileDescriptor::close" ref="ad7c1a99531181878cbab74a7400c5432" args="()" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">void Passenger::FileDescriptor::close           </td>
+          <td class="memname">void Passenger::FileDescriptor::close </td>
           <td>(</td>
-          <td class="paramname">          </td>
+          <td class="paramname"></td>
           <td>&nbsp;)&nbsp;</td>
           <td><code> [inline]</code></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">
 
-<p>
-Close the underlying file descriptor. 
-<p>
-If it was already closed, then nothing will happen.<p>
-<dl compact><dt><b>Exceptions:</b></dt><dd>
+<p>Close the underlying file descriptor. </p>
+<p>If it was already closed, then nothing will happen. If there are multiple copies of this <a class="el" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> then the underlying file descriptor will be closed for every one of them.</p>
+<dl><dt><b>Exceptions:</b></dt><dd>
   <table border="0" cellspacing="2" cellpadding="0">
     <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a></em>&nbsp;</td><td>Something went wrong while closing the file descriptor. </td></tr>
   </table>
+  </dd>
 </dl>
-<dl class="post" compact><dt><b>Postcondition:</b></dt><dd>*this == -1 </dd></dl>
+<dl class="post"><dt><b>Postcondition:</b></dt><dd>*this == -1 </dd></dl>
 
 </div>
-</div><p>
-<a class="anchor" name="c335c2a97f3a6c8e3920f573b0d04081"></a><!-- doxytag: member="Passenger::FileDescriptor::operator int" ref="c335c2a97f3a6c8e3920f573b0d04081" args="() const " -->
+</div>
+<a class="anchor" id="ac335c2a97f3a6c8e3920f573b0d04081"></a><!-- doxytag: member="Passenger::FileDescriptor::operator int" ref="ac335c2a97f3a6c8e3920f573b0d04081" args="() const " -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">Passenger::FileDescriptor::operator int           </td>
+          <td class="memname">Passenger::FileDescriptor::operator int </td>
           <td>(</td>
-          <td class="paramname">          </td>
+          <td class="paramname"></td>
           <td>&nbsp;)&nbsp;</td>
           <td> const<code> [inline]</code></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">
 
-<p>
-Overloads the integer cast operator so that it will return the underlying file descriptor handle as an integer. 
-<p>
-Returns -1 if <a class="el" href="classPassenger_1_1FileDescriptor.html#d7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">FileDescriptor::close()</a> was called. 
+<p>Overloads the integer cast operator so that it will return the underlying file descriptor handle as an integer. </p>
+<p>Returns -1 if <a class="el" href="classPassenger_1_1FileDescriptor.html#ad7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">FileDescriptor::close()</a> was called. </p>
+
 </div>
-</div><p>
-<hr>The documentation for this class was generated from the following file:<ul>
-<li><a class="el" href="FileDescriptor_8h-source.html">FileDescriptor.h</a></ul>
 </div>
-<hr size="1"><address style="text-align: right;"><small>Generated on Sun Mar 28 14:11:59 2010 for Passenger by&nbsp;
+<hr/>The documentation for this class was generated from the following file:<ul>
+<li><a class="el" href="FileDescriptor_8h_source.html">FileDescriptor.h</a></li>
+</ul>
+</div>
+<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
 <a href="http://www.doxygen.org/index.html">
-<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
 </body>
 </html>