1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Passenger: Bucket.h Source File</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 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<h1>Bucket.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Phusion Passenger - http://www.modrails.com/</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright (c) 2008, 2009 Phusion</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span>
<a name="l00008"></a>00008 <span class="comment"> * of this software and associated documentation files (the "Software"), to deal</span>
<a name="l00009"></a>00009 <span class="comment"> * in the Software without restriction, including without limitation the rights</span>
<a name="l00010"></a>00010 <span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
<a name="l00011"></a>00011 <span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span>
<a name="l00012"></a>00012 <span class="comment"> * furnished to do so, subject to the following conditions:</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> * The above copyright notice and this permission notice shall be included in</span>
<a name="l00015"></a>00015 <span class="comment"> * all copies or substantial portions of the Software.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
<a name="l00018"></a>00018 <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
<a name="l00019"></a>00019 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
<a name="l00020"></a>00020 <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
<a name="l00021"></a>00021 <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
<a name="l00022"></a>00022 <span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
<a name="l00023"></a>00023 <span class="comment"> * THE SOFTWARE.</span>
<a name="l00024"></a>00024 <span class="comment"> */</span>
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_BUCKET_H_</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_BUCKET_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 <apr_buckets.h></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "Application.h"</span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">namespace </span>Passenger {
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">using namespace </span>boost;
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="keyword">struct </span>PassengerBucketState {<span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment"> /** The number of bytes that this PassengerBucket has read so far. */</span>
<a name="l00038"></a>00038 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> bytesRead;
<a name="l00039"></a>00039 <span class="comment"></span>
<a name="l00040"></a>00040 <span class="comment"> /** Whether this PassengerBucket is completed, i.e. no more data</span>
<a name="l00041"></a>00041 <span class="comment"> * can be read from the underlying file descriptor. When true,</span>
<a name="l00042"></a>00042 <span class="comment"> * this can either mean that EOF has been reached, or that an I/O</span>
<a name="l00043"></a>00043 <span class="comment"> * error occured. Use errorCode to check whether an error occurred.</span>
<a name="l00044"></a>00044 <span class="comment"> */</span>
<a name="l00045"></a>00045 <span class="keywordtype">bool</span> completed;
<a name="l00046"></a>00046 <span class="comment"></span>
<a name="l00047"></a>00047 <span class="comment"> /** When completed is true, errorCode contains the errno value of</span>
<a name="l00048"></a>00048 <span class="comment"> * the last read() call.</span>
<a name="l00049"></a>00049 <span class="comment"> *</span>
<a name="l00050"></a>00050 <span class="comment"> * A value of 0 means that no error occured.</span>
<a name="l00051"></a>00051 <span class="comment"> */</span>
<a name="l00052"></a>00052 <span class="keywordtype">int</span> errorCode;
<a name="l00053"></a>00053
<a name="l00054"></a>00054 PassengerBucketState() {
<a name="l00055"></a>00055 bytesRead = 0;
<a name="l00056"></a>00056 completed = <span class="keyword">false</span>;
<a name="l00057"></a>00057 errorCode = 0;
<a name="l00058"></a>00058 }
<a name="l00059"></a>00059 };
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="keyword">typedef</span> shared_ptr<PassengerBucketState> PassengerBucketStatePtr;
<a name="l00062"></a>00062 <span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment">/**</span>
<a name="l00064"></a>00064 <span class="comment"> * We used to use an apr_bucket_pipe for forwarding the backend process's</span>
<a name="l00065"></a>00065 <span class="comment"> * response to the HTTP client. However, apr_bucket_pipe has a number of</span>
<a name="l00066"></a>00066 <span class="comment"> * issues:</span>
<a name="l00067"></a>00067 <span class="comment"> * - It closes the pipe's file descriptor when it has reached</span>
<a name="l00068"></a>00068 <span class="comment"> * end-of-stream, but not when an error has occurred. This behavior is</span>
<a name="l00069"></a>00069 <span class="comment"> * undesirable because it can easily cause file descriptor leaks.</span>
<a name="l00070"></a>00070 <span class="comment"> * - It does weird non-blocking-I/O related things which can cause it</span>
<a name="l00071"></a>00071 <span class="comment"> * to read less data than can actually be read.</span>
<a name="l00072"></a>00072 <span class="comment"> *</span>
<a name="l00073"></a>00073 <span class="comment"> * PassengerBucket is like apr_bucket_pipe, but:</span>
<a name="l00074"></a>00074 <span class="comment"> * - It also holds a reference to a Session. When a read error has occured</span>
<a name="l00075"></a>00075 <span class="comment"> * or when end-of-stream has been reached, the Session will be</span>
<a name="l00076"></a>00076 <span class="comment"> * dereferenced, so that the underlying file descriptor is closed.</span>
<a name="l00077"></a>00077 <span class="comment"> * - It ignores the APR_NONBLOCK_READ flag because that's known to cause</span>
<a name="l00078"></a>00078 <span class="comment"> * strange I/O problems.</span>
<a name="l00079"></a>00079 <span class="comment"> * - It can store its current state in a PassengerBucketState data structure.</span>
<a name="l00080"></a>00080 <span class="comment"> */</span>
<a name="l00081"></a>00081 apr_bucket *passenger_bucket_create(Passenger::Application::SessionPtr session,
<a name="l00082"></a>00082 PassengerBucketStatePtr state,
<a name="l00083"></a>00083 apr_bucket_alloc_t *list);
<a name="l00084"></a>00084
<a name="l00085"></a>00085 } <span class="comment">// namespace Passenger</span>
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_BUCKET_H_ */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 5 11:13:03 2010 for Passenger by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
|
