doc/cxxapi/FileDescriptor_8h_source.html in passenger-3.0.0 vs doc/cxxapi/FileDescriptor_8h_source.html in passenger-3.0.1
- old
+ new
@@ -49,210 +49,274 @@
<a name="l00024"></a>00024 <span class="comment"> */</span>
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_FILE_DESCRIPTOR_H_</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_FILE_DESCRIPTOR_H_</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <boost/shared_ptr.hpp></span>
-<a name="l00029"></a>00029 <span class="preprocessor">#include <oxt/system_calls.hpp></span>
-<a name="l00030"></a>00030
-<a name="l00031"></a>00031 <span class="preprocessor">#include <unistd.h></span>
-<a name="l00032"></a>00032 <span class="preprocessor">#include <cerrno></span>
-<a name="l00033"></a>00033
-<a name="l00034"></a>00034 <span class="preprocessor">#include "MessageChannel.h"</span>
-<a name="l00035"></a>00035 <span class="preprocessor">#include "Exceptions.h"</span>
-<a name="l00036"></a>00036
-<a name="l00037"></a>00037 <span class="keyword">namespace </span>Passenger {
-<a name="l00038"></a>00038
-<a name="l00039"></a>00039 <span class="keyword">using namespace </span>boost;
-<a name="l00040"></a>00040 <span class="keyword">using namespace </span>oxt;
-<a name="l00041"></a>00041
-<a name="l00042"></a>00042 <span class="comment"></span>
-<a name="l00043"></a>00043 <span class="comment">/**</span>
-<a name="l00044"></a>00044 <span class="comment"> * Wrapper class around a file descriptor integer, for RAII behavior.</span>
-<a name="l00045"></a>00045 <span class="comment"> *</span>
-<a name="l00046"></a>00046 <span class="comment"> * A FileDescriptor object behaves just like an int, so that you can pass it to</span>
-<a name="l00047"></a>00047 <span class="comment"> * system calls such as read(). It performs reference counting. When the last</span>
-<a name="l00048"></a>00048 <span class="comment"> * copy of a FileDescriptor has been destroyed, the underlying file descriptor</span>
-<a name="l00049"></a>00049 <span class="comment"> * will be automatically closed. In this case, any close() system call errors</span>
-<a name="l00050"></a>00050 <span class="comment"> * are silently ignored. If you are interested in whether the close() system</span>
-<a name="l00051"></a>00051 <span class="comment"> * call succeeded, then you should call FileDescriptor::close().</span>
-<a name="l00052"></a>00052 <span class="comment"> *</span>
-<a name="l00053"></a>00053 <span class="comment"> * This class is *not* thread-safe. It is safe to call system calls on the</span>
-<a name="l00054"></a>00054 <span class="comment"> * underlying file descriptor from multiple threads, but it's not safe to</span>
-<a name="l00055"></a>00055 <span class="comment"> * call FileDescriptor::close() from multiple threads if all those</span>
-<a name="l00056"></a>00056 <span class="comment"> * FileDescriptor objects point to the same underlying file descriptor.</span>
-<a name="l00057"></a>00057 <span class="comment"> */</span>
-<a name="l00058"></a><a class="code" href="classPassenger_1_1FileDescriptor.html">00058</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> {
-<a name="l00059"></a>00059 <span class="keyword">private</span>:
-<a name="l00060"></a>00060 <span class="keyword">struct </span>SharedData {
-<a name="l00061"></a>00061 <span class="keywordtype">int</span> fd;
-<a name="l00062"></a>00062
-<a name="l00063"></a>00063 SharedData(<span class="keywordtype">int</span> fd) {
-<a name="l00064"></a>00064 this->fd = fd;
-<a name="l00065"></a>00065 }
-<a name="l00066"></a>00066
-<a name="l00067"></a>00067 ~SharedData() {
-<a name="l00068"></a>00068 <span class="keywordflow">if</span> (fd >= 0) {
-<a name="l00069"></a>00069 this_thread::disable_syscall_interruption dsi;
-<a name="l00070"></a>00070 <a class="code" href="classPassenger_1_1FileDescriptor.html#ad7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">syscalls::close</a>(fd);
-<a name="l00071"></a>00071 }
-<a name="l00072"></a>00072 }
-<a name="l00073"></a>00073
-<a name="l00074"></a>00074 <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1FileDescriptor.html#ad7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">close</a>() {
-<a name="l00075"></a>00075 <span class="keywordflow">if</span> (fd >= 0) {
-<a name="l00076"></a>00076 this_thread::disable_syscall_interruption dsi;
-<a name="l00077"></a>00077 <span class="keywordtype">int</span> theFd = fd;
-<a name="l00078"></a>00078 fd = -1;
-<a name="l00079"></a>00079 <span class="keywordflow">if</span> (syscalls::close(theFd) == -1 && errno != ENOTCONN) {
-<a name="l00080"></a>00080 <span class="keywordtype">int</span> e = errno;
-<a name="l00081"></a>00081 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot close file descriptor"</span>, e);
-<a name="l00082"></a>00082 }
-<a name="l00083"></a>00083 }
-<a name="l00084"></a>00084 }
-<a name="l00085"></a>00085 };
-<a name="l00086"></a>00086 <span class="comment"></span>
-<a name="l00087"></a>00087 <span class="comment"> /** Shared pointer for reference counting on this file descriptor */</span>
-<a name="l00088"></a>00088 shared_ptr<SharedData> data;
-<a name="l00089"></a>00089
-<a name="l00090"></a>00090 <span class="keyword">public</span>:<span class="comment"></span>
-<a name="l00091"></a>00091 <span class="comment"> /** </span>
-<a name="l00092"></a>00092 <span class="comment"> * Creates a new empty FileDescriptor instance that has no underlying</span>
-<a name="l00093"></a>00093 <span class="comment"> * file descriptor.</span>
-<a name="l00094"></a>00094 <span class="comment"> *</span>
-<a name="l00095"></a>00095 <span class="comment"> * @post *this == -1</span>
-<a name="l00096"></a>00096 <span class="comment"> */</span>
-<a name="l00097"></a><a class="code" href="classPassenger_1_1FileDescriptor.html#a05d83ad9cc77c493a3ce4f2b51d44559">00097</a> <a class="code" href="classPassenger_1_1FileDescriptor.html#a05d83ad9cc77c493a3ce4f2b51d44559" title="Creates a new empty FileDescriptor instance that has no underlying file descriptor...">FileDescriptor</a>() { }
-<a name="l00098"></a>00098 <span class="comment"></span>
-<a name="l00099"></a>00099 <span class="comment"> /**</span>
-<a name="l00100"></a>00100 <span class="comment"> * Creates a new FileDescriptor instance with the given fd as a handle.</span>
-<a name="l00101"></a>00101 <span class="comment"> *</span>
-<a name="l00102"></a>00102 <span class="comment"> * @post *this == fd</span>
-<a name="l00103"></a>00103 <span class="comment"> */</span>
-<a name="l00104"></a><a class="code" href="classPassenger_1_1FileDescriptor.html#a62c05b925cb1cf964169cef7635650ee">00104</a> <a class="code" href="classPassenger_1_1FileDescriptor.html#a62c05b925cb1cf964169cef7635650ee" title="Creates a new FileDescriptor instance with the given fd as a handle.">FileDescriptor</a>(<span class="keywordtype">int</span> fd) {
-<a name="l00105"></a>00105 <span class="keywordflow">if</span> (fd >= 0) {
-<a name="l00106"></a>00106 <span class="comment">/* Make sure that the 'new' operator doesn't overwrite</span>
-<a name="l00107"></a>00107 <span class="comment"> * errno so that we can write code like this:</span>
-<a name="l00108"></a>00108 <span class="comment"> *</span>
-<a name="l00109"></a>00109 <span class="comment"> * FileDescriptor fd = open(...);</span>
-<a name="l00110"></a>00110 <span class="comment"> * if (fd == -1) {</span>
-<a name="l00111"></a>00111 <span class="comment"> * print_error(errno);</span>
-<a name="l00112"></a>00112 <span class="comment"> * }</span>
-<a name="l00113"></a>00113 <span class="comment"> */</span>
-<a name="l00114"></a>00114 <span class="keywordtype">int</span> e = errno;
-<a name="l00115"></a>00115 data.reset(<span class="keyword">new</span> SharedData(fd));
-<a name="l00116"></a>00116 errno = e;
-<a name="l00117"></a>00117 }
-<a name="l00118"></a>00118 }
-<a name="l00119"></a>00119 <span class="comment"></span>
-<a name="l00120"></a>00120 <span class="comment"> /**</span>
-<a name="l00121"></a>00121 <span class="comment"> * Close the underlying file descriptor. If it was already closed, then</span>
-<a name="l00122"></a>00122 <span class="comment"> * nothing will happen. If there are multiple copies of this FileDescriptor</span>
-<a name="l00123"></a>00123 <span class="comment"> * then the underlying file descriptor will be closed for every one of them.</span>
-<a name="l00124"></a>00124 <span class="comment"> *</span>
-<a name="l00125"></a>00125 <span class="comment"> * @throws SystemException Something went wrong while closing</span>
-<a name="l00126"></a>00126 <span class="comment"> * the file descriptor.</span>
-<a name="l00127"></a>00127 <span class="comment"> * @post *this == -1</span>
-<a name="l00128"></a>00128 <span class="comment"> */</span>
-<a name="l00129"></a><a class="code" href="classPassenger_1_1FileDescriptor.html#ad7c1a99531181878cbab74a7400c5432">00129</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1FileDescriptor.html#ad7c1a99531181878cbab74a7400c5432" title="Close the underlying file descriptor.">close</a>() {
-<a name="l00130"></a>00130 <span class="keywordflow">if</span> (data != NULL) {
-<a name="l00131"></a>00131 data->close();
-<a name="l00132"></a>00132 data.reset();
-<a name="l00133"></a>00133 }
-<a name="l00134"></a>00134 }
-<a name="l00135"></a>00135 <span class="comment"></span>
-<a name="l00136"></a>00136 <span class="comment"> /**</span>
-<a name="l00137"></a>00137 <span class="comment"> * Overloads the integer cast operator so that it will return the underlying</span>
-<a name="l00138"></a>00138 <span class="comment"> * file descriptor handle as an integer.</span>
-<a name="l00139"></a>00139 <span class="comment"> *</span>
-<a name="l00140"></a>00140 <span class="comment"> * Returns -1 if FileDescriptor::close() was called.</span>
-<a name="l00141"></a>00141 <span class="comment"> */</span>
-<a name="l00142"></a><a class="code" href="classPassenger_1_1FileDescriptor.html#ac335c2a97f3a6c8e3920f573b0d04081">00142</a> <a class="code" href="classPassenger_1_1FileDescriptor.html#ac335c2a97f3a6c8e3920f573b0d04081" title="Overloads the integer cast operator so that it will return the underlying file descriptor...">operator int </a>()<span class="keyword"> const </span>{
-<a name="l00143"></a>00143 <span class="keywordflow">if</span> (data == NULL) {
-<a name="l00144"></a>00144 <span class="keywordflow">return</span> -1;
-<a name="l00145"></a>00145 } <span class="keywordflow">else</span> {
-<a name="l00146"></a>00146 <span class="keywordflow">return</span> data->fd;
+<a name="l00029"></a>00029 <span class="preprocessor">#include <boost/make_shared.hpp></span>
+<a name="l00030"></a>00030 <span class="preprocessor">#include <oxt/system_calls.hpp></span>
+<a name="l00031"></a>00031
+<a name="l00032"></a>00032 <span class="preprocessor">#include <utility></span>
+<a name="l00033"></a>00033 <span class="preprocessor">#include <unistd.h></span>
+<a name="l00034"></a>00034 <span class="preprocessor">#include <cerrno></span>
+<a name="l00035"></a>00035
+<a name="l00036"></a>00036 <span class="preprocessor">#include <Exceptions.h></span>
+<a name="l00037"></a>00037
+<a name="l00038"></a>00038 <span class="keyword">namespace </span>Passenger {
+<a name="l00039"></a>00039
+<a name="l00040"></a>00040 <span class="keyword">using namespace </span>std;
+<a name="l00041"></a>00041 <span class="keyword">using namespace </span>boost;
+<a name="l00042"></a>00042 <span class="keyword">using namespace </span>oxt;
+<a name="l00043"></a>00043
+<a name="l00044"></a>00044
+<a name="l00045"></a>00045 <span class="keywordtype">void</span> safelyClose(<span class="keywordtype">int</span> fd);
+<a name="l00046"></a>00046
+<a name="l00047"></a>00047 <span class="comment"></span>
+<a name="l00048"></a>00048 <span class="comment">/**</span>
+<a name="l00049"></a>00049 <span class="comment"> * Wrapper class around a file descriptor integer, for RAII behavior.</span>
+<a name="l00050"></a>00050 <span class="comment"> *</span>
+<a name="l00051"></a>00051 <span class="comment"> * A FileDescriptor object behaves just like an int, so that you can pass it to</span>
+<a name="l00052"></a>00052 <span class="comment"> * system calls such as read(). It performs reference counting. When the last</span>
+<a name="l00053"></a>00053 <span class="comment"> * copy of a FileDescriptor has been destroyed, the underlying file descriptor</span>
+<a name="l00054"></a>00054 <span class="comment"> * will be automatically closed. In this case, any close() system call errors</span>
+<a name="l00055"></a>00055 <span class="comment"> * are silently ignored. If you are interested in whether the close() system</span>
+<a name="l00056"></a>00056 <span class="comment"> * call succeeded, then you should call FileDescriptor::close().</span>
+<a name="l00057"></a>00057 <span class="comment"> *</span>
+<a name="l00058"></a>00058 <span class="comment"> * This class is *not* thread-safe. It is safe to call system calls on the</span>
+<a name="l00059"></a>00059 <span class="comment"> * underlying file descriptor from multiple threads, but it's not safe to</span>
+<a name="l00060"></a>00060 <span class="comment"> * call FileDescriptor::close() from multiple threads if all those</span>
+<a name="l00061"></a>00061 <span class="comment"> * FileDescriptor objects point to the same underlying file descriptor.</span>
+<a name="l00062"></a>00062 <span class="comment"> */</span>
+<a name="l00063"></a><a class="code" href="classPassenger_1_1FileDescriptor.html">00063</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> {
+<a name="l00064"></a>00064 <span class="keyword">private</span>:
+<a name="l00065"></a>00065 <span class="keyword">struct </span>SharedData {
+<a name="l00066"></a>00066 <span class="keywordtype">int</span> fd;
+<a name="l00067"></a>00067
+<a name="l00068"></a>00068 SharedData(<span class="keywordtype">int</span> fd) {
+<a name="l00069"></a>00069 this->fd = fd;
+<a name="l00070"></a>00070 }
+<a name="l00071"></a>00071
+<a name="l00072"></a>00072 ~SharedData() {
+<a name="l00073"></a>00073 <span class="keywordflow">if</span> (fd >= 0) {
+<a name="l00074"></a>00074 this_thread::disable_syscall_interruption dsi;
+<a name="l00075"></a>00075 <a class="code" href="classPassenger_1_1FileDescriptor.html#a02062f3cfb689b32781e11114c0abe5b" title="Close the underlying file descriptor.">syscalls::close</a>(fd);
+<a name="l00076"></a>00076 }
+<a name="l00077"></a>00077 }
+<a name="l00078"></a>00078
+<a name="l00079"></a>00079 <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1FileDescriptor.html#a02062f3cfb689b32781e11114c0abe5b" title="Close the underlying file descriptor.">close</a>(<span class="keywordtype">bool</span> checkErrors = <span class="keyword">true</span>) {
+<a name="l00080"></a>00080 <span class="keywordflow">if</span> (fd >= 0) {
+<a name="l00081"></a>00081 this_thread::disable_syscall_interruption dsi;
+<a name="l00082"></a>00082 <span class="keywordtype">int</span> theFd = fd;
+<a name="l00083"></a>00083 fd = -1;
+<a name="l00084"></a>00084 <span class="keywordflow">if</span> (checkErrors) {
+<a name="l00085"></a>00085 safelyClose(theFd);
+<a name="l00086"></a>00086 } <span class="keywordflow">else</span> {
+<a name="l00087"></a>00087 <a class="code" href="classPassenger_1_1FileDescriptor.html#a02062f3cfb689b32781e11114c0abe5b" title="Close the underlying file descriptor.">syscalls::close</a>(fd);
+<a name="l00088"></a>00088 }
+<a name="l00089"></a>00089 }
+<a name="l00090"></a>00090 }
+<a name="l00091"></a>00091
+<a name="l00092"></a>00092 <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1FileDescriptor.html#ad9f7acde3003ab0730bc248948a63777" title="Detach from the underlying file descriptor without closing it.">detach</a>() {
+<a name="l00093"></a>00093 fd = -1;
+<a name="l00094"></a>00094 }
+<a name="l00095"></a>00095 };
+<a name="l00096"></a>00096 <span class="comment"></span>
+<a name="l00097"></a>00097 <span class="comment"> /** Shared pointer for reference counting on this file descriptor */</span>
+<a name="l00098"></a>00098 shared_ptr<SharedData> data;
+<a name="l00099"></a>00099
+<a name="l00100"></a>00100 <span class="keyword">public</span>:<span class="comment"></span>
+<a name="l00101"></a>00101 <span class="comment"> /** </span>
+<a name="l00102"></a>00102 <span class="comment"> * Creates a new empty FileDescriptor instance that has no underlying</span>
+<a name="l00103"></a>00103 <span class="comment"> * file descriptor.</span>
+<a name="l00104"></a>00104 <span class="comment"> *</span>
+<a name="l00105"></a>00105 <span class="comment"> * @post *this == -1</span>
+<a name="l00106"></a>00106 <span class="comment"> */</span>
+<a name="l00107"></a><a class="code" href="classPassenger_1_1FileDescriptor.html#a05d83ad9cc77c493a3ce4f2b51d44559">00107</a> <a class="code" href="classPassenger_1_1FileDescriptor.html#a05d83ad9cc77c493a3ce4f2b51d44559" title="Creates a new empty FileDescriptor instance that has no underlying file descriptor...">FileDescriptor</a>() { }
+<a name="l00108"></a>00108 <span class="comment"></span>
+<a name="l00109"></a>00109 <span class="comment"> /**</span>
+<a name="l00110"></a>00110 <span class="comment"> * Creates a new FileDescriptor instance with the given fd as a handle.</span>
+<a name="l00111"></a>00111 <span class="comment"> *</span>
+<a name="l00112"></a>00112 <span class="comment"> * @post *this == fd</span>
+<a name="l00113"></a>00113 <span class="comment"> */</span>
+<a name="l00114"></a><a class="code" href="classPassenger_1_1FileDescriptor.html#a62c05b925cb1cf964169cef7635650ee">00114</a> <a class="code" href="classPassenger_1_1FileDescriptor.html#a62c05b925cb1cf964169cef7635650ee" title="Creates a new FileDescriptor instance with the given fd as a handle.">FileDescriptor</a>(<span class="keywordtype">int</span> fd) {
+<a name="l00115"></a>00115 <span class="keywordflow">if</span> (fd >= 0) {
+<a name="l00116"></a>00116 <span class="comment">/* Make sure that the 'new' operator doesn't overwrite</span>
+<a name="l00117"></a>00117 <span class="comment"> * errno so that we can write code like this:</span>
+<a name="l00118"></a>00118 <span class="comment"> *</span>
+<a name="l00119"></a>00119 <span class="comment"> * FileDescriptor fd = open(...);</span>
+<a name="l00120"></a>00120 <span class="comment"> * if (fd == -1) {</span>
+<a name="l00121"></a>00121 <span class="comment"> * print_error(errno);</span>
+<a name="l00122"></a>00122 <span class="comment"> * }</span>
+<a name="l00123"></a>00123 <span class="comment"> */</span>
+<a name="l00124"></a>00124 <span class="keywordtype">int</span> e = errno;
+<a name="l00125"></a>00125 data = make_shared<SharedData>(fd);
+<a name="l00126"></a>00126 errno = e;
+<a name="l00127"></a>00127 }
+<a name="l00128"></a>00128 }
+<a name="l00129"></a>00129 <span class="comment"></span>
+<a name="l00130"></a>00130 <span class="comment"> /**</span>
+<a name="l00131"></a>00131 <span class="comment"> * Close the underlying file descriptor. If it was already closed, then</span>
+<a name="l00132"></a>00132 <span class="comment"> * nothing will happen. If there are multiple copies of this FileDescriptor</span>
+<a name="l00133"></a>00133 <span class="comment"> * then the underlying file descriptor will be closed for every one of them.</span>
+<a name="l00134"></a>00134 <span class="comment"> *</span>
+<a name="l00135"></a>00135 <span class="comment"> * @params checkErrors Whether a SystemException should be thrown in case</span>
+<a name="l00136"></a>00136 <span class="comment"> * closing the file descriptor fails. If false, errors</span>
+<a name="l00137"></a>00137 <span class="comment"> * are silently ignored.</span>
+<a name="l00138"></a>00138 <span class="comment"> * @throws SystemException Something went wrong while closing</span>
+<a name="l00139"></a>00139 <span class="comment"> * the file descriptor. Only thrown if</span>
+<a name="l00140"></a>00140 <span class="comment"> * checkErrors is true.</span>
+<a name="l00141"></a>00141 <span class="comment"> * @post *this == -1</span>
+<a name="l00142"></a>00142 <span class="comment"> */</span>
+<a name="l00143"></a><a class="code" href="classPassenger_1_1FileDescriptor.html#a02062f3cfb689b32781e11114c0abe5b">00143</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1FileDescriptor.html#a02062f3cfb689b32781e11114c0abe5b" title="Close the underlying file descriptor.">close</a>(<span class="keywordtype">bool</span> checkErrors = <span class="keyword">true</span>) {
+<a name="l00144"></a>00144 <span class="keywordflow">if</span> (data != NULL) {
+<a name="l00145"></a>00145 data->close(checkErrors);
+<a name="l00146"></a>00146 data.reset();
<a name="l00147"></a>00147 }
<a name="l00148"></a>00148 }
-<a name="l00149"></a>00149
-<a name="l00150"></a>00150 <a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> &operator=(<span class="keywordtype">int</span> fd) {
-<a name="l00151"></a>00151 <span class="comment">/* Make sure that the 'new' and 'delete' operators don't</span>
-<a name="l00152"></a>00152 <span class="comment"> * overwrite errno so that we can write code like this:</span>
-<a name="l00153"></a>00153 <span class="comment"> *</span>
-<a name="l00154"></a>00154 <span class="comment"> * FileDescriptor fd;</span>
-<a name="l00155"></a>00155 <span class="comment"> * fd = open(...);</span>
-<a name="l00156"></a>00156 <span class="comment"> * if (fd == -1) {</span>
-<a name="l00157"></a>00157 <span class="comment"> * print_error(errno);</span>
-<a name="l00158"></a>00158 <span class="comment"> * }</span>
-<a name="l00159"></a>00159 <span class="comment"> */</span>
-<a name="l00160"></a>00160 <span class="keywordtype">int</span> e = errno;
-<a name="l00161"></a>00161 <span class="keywordflow">if</span> (fd >= 0) {
-<a name="l00162"></a>00162 data.reset(<span class="keyword">new</span> SharedData(fd));
-<a name="l00163"></a>00163 } <span class="keywordflow">else</span> {
-<a name="l00164"></a>00164 data.reset();
-<a name="l00165"></a>00165 }
-<a name="l00166"></a>00166 errno = e;
-<a name="l00167"></a>00167 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
-<a name="l00168"></a>00168 }
-<a name="l00169"></a>00169
-<a name="l00170"></a>00170 <a class="code" href="classPassenger_1_1FileDescriptor.html#a05d83ad9cc77c493a3ce4f2b51d44559" title="Creates a new empty FileDescriptor instance that has no underlying file descriptor...">FileDescriptor</a> &operator=(<span class="keyword">const</span> <a class="code" href="classPassenger_1_1FileDescriptor.html#a05d83ad9cc77c493a3ce4f2b51d44559" title="Creates a new empty FileDescriptor instance that has no underlying file descriptor...">FileDescriptor</a> &other) {
-<a name="l00171"></a>00171 <span class="comment">/* Make sure that the 'delete' operator implicitly invoked by</span>
-<a name="l00172"></a>00172 <span class="comment"> * shared_ptr doesn't overwrite errno so that we can write code</span>
-<a name="l00173"></a>00173 <span class="comment"> * like this:</span>
-<a name="l00174"></a>00174 <span class="comment"> *</span>
-<a name="l00175"></a>00175 <span class="comment"> * FileDescriptor fd;</span>
-<a name="l00176"></a>00176 <span class="comment"> * fd = other_file_descriptor_object;</span>
-<a name="l00177"></a>00177 <span class="comment"> * if (fd == -1) {</span>
-<a name="l00178"></a>00178 <span class="comment"> * print_error(errno);</span>
-<a name="l00179"></a>00179 <span class="comment"> * }</span>
-<a name="l00180"></a>00180 <span class="comment"> */</span>
-<a name="l00181"></a>00181 <span class="keywordtype">int</span> e = errno;
-<a name="l00182"></a>00182 data = other.data;
-<a name="l00183"></a>00183 errno = e;
-<a name="l00184"></a>00184 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
-<a name="l00185"></a>00185 }
-<a name="l00186"></a>00186 };
-<a name="l00187"></a>00187 <span class="comment"></span>
-<a name="l00188"></a>00188 <span class="comment">/**</span>
-<a name="l00189"></a>00189 <span class="comment"> * A synchronization mechanism that's implemented with file descriptors,</span>
-<a name="l00190"></a>00190 <span class="comment"> * and as such can be used in combination with select() and friends.</span>
-<a name="l00191"></a>00191 <span class="comment"> *</span>
-<a name="l00192"></a>00192 <span class="comment"> * One can wait for an event on an EventFd by select()ing it on read events.</span>
-<a name="l00193"></a>00193 <span class="comment"> * Another thread can signal the EventFd by calling notify().</span>
-<a name="l00194"></a>00194 <span class="comment"> */</span>
-<a name="l00195"></a><a class="code" href="classPassenger_1_1EventFd.html">00195</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1EventFd.html" title="A synchronization mechanism that&#39;s implemented with file descriptors, and as...">EventFd</a> {
-<a name="l00196"></a>00196 <span class="keyword">private</span>:
-<a name="l00197"></a>00197 <span class="keywordtype">int</span> reader;
-<a name="l00198"></a>00198 <span class="keywordtype">int</span> writer;
-<a name="l00199"></a>00199
-<a name="l00200"></a>00200 <span class="keyword">public</span>:
-<a name="l00201"></a>00201 <a class="code" href="classPassenger_1_1EventFd.html" title="A synchronization mechanism that&#39;s implemented with file descriptors, and as...">EventFd</a>() {
-<a name="l00202"></a>00202 <span class="keywordtype">int</span> fds[2];
-<a name="l00203"></a>00203
-<a name="l00204"></a>00204 <span class="keywordflow">if</span> (syscalls::pipe(fds) == -1) {
-<a name="l00205"></a>00205 <span class="keywordtype">int</span> e = errno;
-<a name="l00206"></a>00206 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot create a pipe"</span>, e);
-<a name="l00207"></a>00207 }
-<a name="l00208"></a>00208 reader = fds[0];
-<a name="l00209"></a>00209 writer = fds[1];
-<a name="l00210"></a>00210 }
-<a name="l00211"></a>00211
-<a name="l00212"></a>00212 ~<a class="code" href="classPassenger_1_1EventFd.html" title="A synchronization mechanism that&#39;s implemented with file descriptors, and as...">EventFd</a>() {
-<a name="l00213"></a>00213 this_thread::disable_syscall_interruption dsi;
-<a name="l00214"></a>00214 syscalls::close(reader);
-<a name="l00215"></a>00215 syscalls::close(writer);
-<a name="l00216"></a>00216 }
-<a name="l00217"></a>00217
-<a name="l00218"></a>00218 <span class="keywordtype">void</span> notify() {
-<a name="l00219"></a>00219 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(writer).writeRaw(<span class="stringliteral">"x"</span>, 1);
-<a name="l00220"></a>00220 }
-<a name="l00221"></a>00221
-<a name="l00222"></a>00222 <span class="keywordtype">int</span> fd()<span class="keyword"> const </span>{
-<a name="l00223"></a>00223 <span class="keywordflow">return</span> reader;
-<a name="l00224"></a>00224 }
-<a name="l00225"></a>00225 };
-<a name="l00226"></a>00226
-<a name="l00227"></a>00227 } <span class="comment">// namespace Passenger</span>
-<a name="l00228"></a>00228
-<a name="l00229"></a>00229 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_FILE_DESCRIPTOR_H_ */</span>
+<a name="l00149"></a>00149 <span class="comment"></span>
+<a name="l00150"></a>00150 <span class="comment"> /**</span>
+<a name="l00151"></a>00151 <span class="comment"> * Detach from the underlying file descriptor without closing it.</span>
+<a name="l00152"></a>00152 <span class="comment"> * This FileDescriptor and all copies will no longer affect the</span>
+<a name="l00153"></a>00153 <span class="comment"> * underlying file descriptors.</span>
+<a name="l00154"></a>00154 <span class="comment"> *</span>
+<a name="l00155"></a>00155 <span class="comment"> * @return The underlying file descriptor, or -1 if already closed.</span>
+<a name="l00156"></a>00156 <span class="comment"> * @post *this == -1</span>
+<a name="l00157"></a>00157 <span class="comment"> */</span>
+<a name="l00158"></a><a class="code" href="classPassenger_1_1FileDescriptor.html#ad9f7acde3003ab0730bc248948a63777">00158</a> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1FileDescriptor.html#ad9f7acde3003ab0730bc248948a63777" title="Detach from the underlying file descriptor without closing it.">detach</a>() {
+<a name="l00159"></a>00159 <span class="keywordflow">if</span> (data != NULL) {
+<a name="l00160"></a>00160 <span class="keywordtype">int</span> fd = data->fd;
+<a name="l00161"></a>00161 data->detach();
+<a name="l00162"></a>00162 data.reset();
+<a name="l00163"></a>00163 <span class="keywordflow">return</span> fd;
+<a name="l00164"></a>00164 } <span class="keywordflow">else</span> {
+<a name="l00165"></a>00165 <span class="keywordflow">return</span> -1;
+<a name="l00166"></a>00166 }
+<a name="l00167"></a>00167 }
+<a name="l00168"></a>00168 <span class="comment"></span>
+<a name="l00169"></a>00169 <span class="comment"> /**</span>
+<a name="l00170"></a>00170 <span class="comment"> * Overloads the integer cast operator so that it will return the underlying</span>
+<a name="l00171"></a>00171 <span class="comment"> * file descriptor handle as an integer.</span>
+<a name="l00172"></a>00172 <span class="comment"> *</span>
+<a name="l00173"></a>00173 <span class="comment"> * Returns -1 if FileDescriptor::close() was called.</span>
+<a name="l00174"></a>00174 <span class="comment"> */</span>
+<a name="l00175"></a><a class="code" href="classPassenger_1_1FileDescriptor.html#ac335c2a97f3a6c8e3920f573b0d04081">00175</a> <a class="code" href="classPassenger_1_1FileDescriptor.html#ac335c2a97f3a6c8e3920f573b0d04081" title="Overloads the integer cast operator so that it will return the underlying file descriptor...">operator int </a>()<span class="keyword"> const </span>{
+<a name="l00176"></a>00176 <span class="keywordflow">if</span> (data == NULL) {
+<a name="l00177"></a>00177 <span class="keywordflow">return</span> -1;
+<a name="l00178"></a>00178 } <span class="keywordflow">else</span> {
+<a name="l00179"></a>00179 <span class="keywordflow">return</span> data->fd;
+<a name="l00180"></a>00180 }
+<a name="l00181"></a>00181 }
+<a name="l00182"></a>00182
+<a name="l00183"></a>00183 <a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> &operator=(<span class="keywordtype">int</span> fd) {
+<a name="l00184"></a>00184 <span class="comment">/* Make sure that the 'new' and 'delete' operators don't</span>
+<a name="l00185"></a>00185 <span class="comment"> * overwrite errno so that we can write code like this:</span>
+<a name="l00186"></a>00186 <span class="comment"> *</span>
+<a name="l00187"></a>00187 <span class="comment"> * FileDescriptor fd;</span>
+<a name="l00188"></a>00188 <span class="comment"> * fd = open(...);</span>
+<a name="l00189"></a>00189 <span class="comment"> * if (fd == -1) {</span>
+<a name="l00190"></a>00190 <span class="comment"> * print_error(errno);</span>
+<a name="l00191"></a>00191 <span class="comment"> * }</span>
+<a name="l00192"></a>00192 <span class="comment"> */</span>
+<a name="l00193"></a>00193 <span class="keywordtype">int</span> e = errno;
+<a name="l00194"></a>00194 <span class="keywordflow">if</span> (fd >= 0) {
+<a name="l00195"></a>00195 data = make_shared<SharedData>(fd);
+<a name="l00196"></a>00196 } <span class="keywordflow">else</span> {
+<a name="l00197"></a>00197 data.reset();
+<a name="l00198"></a>00198 }
+<a name="l00199"></a>00199 errno = e;
+<a name="l00200"></a>00200 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
+<a name="l00201"></a>00201 }
+<a name="l00202"></a>00202
+<a name="l00203"></a>00203 <a class="code" href="classPassenger_1_1FileDescriptor.html#a05d83ad9cc77c493a3ce4f2b51d44559" title="Creates a new empty FileDescriptor instance that has no underlying file descriptor...">FileDescriptor</a> &operator=(<span class="keyword">const</span> <a class="code" href="classPassenger_1_1FileDescriptor.html#a05d83ad9cc77c493a3ce4f2b51d44559" title="Creates a new empty FileDescriptor instance that has no underlying file descriptor...">FileDescriptor</a> &other) {
+<a name="l00204"></a>00204 <span class="comment">/* Make sure that the 'delete' operator implicitly invoked by</span>
+<a name="l00205"></a>00205 <span class="comment"> * shared_ptr doesn't overwrite errno so that we can write code</span>
+<a name="l00206"></a>00206 <span class="comment"> * like this:</span>
+<a name="l00207"></a>00207 <span class="comment"> *</span>
+<a name="l00208"></a>00208 <span class="comment"> * FileDescriptor fd;</span>
+<a name="l00209"></a>00209 <span class="comment"> * fd = other_file_descriptor_object;</span>
+<a name="l00210"></a>00210 <span class="comment"> * if (fd == -1) {</span>
+<a name="l00211"></a>00211 <span class="comment"> * print_error(errno);</span>
+<a name="l00212"></a>00212 <span class="comment"> * }</span>
+<a name="l00213"></a>00213 <span class="comment"> */</span>
+<a name="l00214"></a>00214 <span class="keywordtype">int</span> e = errno;
+<a name="l00215"></a>00215 data = other.data;
+<a name="l00216"></a>00216 errno = e;
+<a name="l00217"></a>00217 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
+<a name="l00218"></a>00218 }
+<a name="l00219"></a>00219 };
+<a name="l00220"></a>00220 <span class="comment"></span>
+<a name="l00221"></a>00221 <span class="comment">/**</span>
+<a name="l00222"></a>00222 <span class="comment"> * A structure containing two FileDescriptor objects. Behaves like a pair</span>
+<a name="l00223"></a>00223 <span class="comment"> * and like a two-element array.</span>
+<a name="l00224"></a>00224 <span class="comment"> */</span>
+<a name="l00225"></a><a class="code" href="classPassenger_1_1FileDescriptorPair.html">00225</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1FileDescriptorPair.html" title="A structure containing two FileDescriptor objects.">FileDescriptorPair</a>: <span class="keyword">public</span> pair<FileDescriptor, FileDescriptor> {
+<a name="l00226"></a>00226 <span class="keyword">public</span>:
+<a name="l00227"></a>00227 <a class="code" href="classPassenger_1_1FileDescriptorPair.html" title="A structure containing two FileDescriptor objects.">FileDescriptorPair</a>() { }
+<a name="l00228"></a>00228
+<a name="l00229"></a>00229 <a class="code" href="classPassenger_1_1FileDescriptorPair.html" title="A structure containing two FileDescriptor objects.">FileDescriptorPair</a>(<span class="keyword">const</span> <a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> &a, <span class="keyword">const</span> <a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> &b)
+<a name="l00230"></a>00230 : pair<FileDescriptor, FileDescriptor>(a, b)
+<a name="l00231"></a>00231 { }
+<a name="l00232"></a>00232
+<a name="l00233"></a>00233 <a class="code" href="classPassenger_1_1FileDescriptor.html" title="Wrapper class around a file descriptor integer, for RAII behavior.">FileDescriptor</a> &operator[](<span class="keywordtype">int</span> index) {
+<a name="l00234"></a>00234 <span class="keywordflow">if</span> (index == 0) {
+<a name="l00235"></a>00235 <span class="keywordflow">return</span> first;
+<a name="l00236"></a>00236 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (index == 1) {
+<a name="l00237"></a>00237 <span class="keywordflow">return</span> second;
+<a name="l00238"></a>00238 } <span class="keywordflow">else</span> {
+<a name="l00239"></a>00239 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1ArgumentException.html" title="Indicates that a specified argument is incorrect or violates a requirement.">ArgumentException</a>(<span class="stringliteral">"Index must be either 0 of 1"</span>);
+<a name="l00240"></a>00240 }
+<a name="l00241"></a>00241 }
+<a name="l00242"></a>00242 };
+<a name="l00243"></a>00243
+<a name="l00244"></a>00244 <span class="comment">// Convenience aliases.</span>
+<a name="l00245"></a>00245 <span class="keyword">typedef</span> <a class="code" href="classPassenger_1_1FileDescriptorPair.html" title="A structure containing two FileDescriptor objects.">FileDescriptorPair</a> <a class="code" href="classPassenger_1_1FileDescriptorPair.html" title="A structure containing two FileDescriptor objects.">Pipe</a>;
+<a name="l00246"></a>00246 <span class="keyword">typedef</span> <a class="code" href="classPassenger_1_1FileDescriptorPair.html" title="A structure containing two FileDescriptor objects.">FileDescriptorPair</a> <a class="code" href="classPassenger_1_1FileDescriptorPair.html" title="A structure containing two FileDescriptor objects.">SocketPair</a>;
+<a name="l00247"></a>00247 <span class="comment"></span>
+<a name="l00248"></a>00248 <span class="comment">/**</span>
+<a name="l00249"></a>00249 <span class="comment"> * A synchronization mechanism that's implemented with file descriptors,</span>
+<a name="l00250"></a>00250 <span class="comment"> * and as such can be used in combination with select() and friends.</span>
+<a name="l00251"></a>00251 <span class="comment"> *</span>
+<a name="l00252"></a>00252 <span class="comment"> * One can wait for an event on an EventFd by select()ing it on read events.</span>
+<a name="l00253"></a>00253 <span class="comment"> * Another thread can signal the EventFd by calling notify().</span>
+<a name="l00254"></a>00254 <span class="comment"> */</span>
+<a name="l00255"></a><a class="code" href="classPassenger_1_1EventFd.html">00255</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1EventFd.html" title="A synchronization mechanism that&#39;s implemented with file descriptors, and as...">EventFd</a> {
+<a name="l00256"></a>00256 <span class="keyword">private</span>:
+<a name="l00257"></a>00257 <span class="keywordtype">int</span> reader;
+<a name="l00258"></a>00258 <span class="keywordtype">int</span> writer;
+<a name="l00259"></a>00259
+<a name="l00260"></a>00260 <span class="keyword">public</span>:
+<a name="l00261"></a>00261 <a class="code" href="classPassenger_1_1EventFd.html" title="A synchronization mechanism that&#39;s implemented with file descriptors, and as...">EventFd</a>() {
+<a name="l00262"></a>00262 <span class="keywordtype">int</span> fds[2];
+<a name="l00263"></a>00263
+<a name="l00264"></a>00264 <span class="keywordflow">if</span> (syscalls::pipe(fds) == -1) {
+<a name="l00265"></a>00265 <span class="keywordtype">int</span> e = errno;
+<a name="l00266"></a>00266 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot create a pipe"</span>, e);
+<a name="l00267"></a>00267 }
+<a name="l00268"></a>00268 reader = fds[0];
+<a name="l00269"></a>00269 writer = fds[1];
+<a name="l00270"></a>00270 }
+<a name="l00271"></a>00271
+<a name="l00272"></a>00272 ~<a class="code" href="classPassenger_1_1EventFd.html" title="A synchronization mechanism that&#39;s implemented with file descriptors, and as...">EventFd</a>() {
+<a name="l00273"></a>00273 this_thread::disable_syscall_interruption dsi;
+<a name="l00274"></a>00274 syscalls::close(reader);
+<a name="l00275"></a>00275 syscalls::close(writer);
+<a name="l00276"></a>00276 }
+<a name="l00277"></a>00277
+<a name="l00278"></a>00278 <span class="keywordtype">void</span> notify() {
+<a name="l00279"></a>00279 ssize_t ret = syscalls::write(writer, <span class="stringliteral">"x"</span>, 1);
+<a name="l00280"></a>00280 <span class="keywordflow">if</span> (ret == -1 && errno != EAGAIN) {
+<a name="l00281"></a>00281 <span class="keywordtype">int</span> e = errno;
+<a name="l00282"></a>00282 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(<span class="stringliteral">"Cannot write notification data"</span>, e);
+<a name="l00283"></a>00283 }
+<a name="l00284"></a>00284 }
+<a name="l00285"></a>00285
+<a name="l00286"></a>00286 <span class="keywordtype">int</span> fd()<span class="keyword"> const </span>{
+<a name="l00287"></a>00287 <span class="keywordflow">return</span> reader;
+<a name="l00288"></a>00288 }
+<a name="l00289"></a>00289 };
+<a name="l00290"></a>00290
+<a name="l00291"></a>00291 } <span class="comment">// namespace Passenger</span>
+<a name="l00292"></a>00292
+<a name="l00293"></a>00293 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_FILE_DESCRIPTOR_H_ */</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>