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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
|
<!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: Session.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="namespaces.html"><span>Namespaces</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>Session.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) 2010 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_SESSION_H_</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_SESSION_H_</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <sys/types.h></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <sys/socket.h></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <sys/un.h></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <unistd.h></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <netdb.h></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <cerrno></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include <cstring></span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="preprocessor">#include <string></span>
<a name="l00037"></a>00037 <span class="preprocessor">#include <vector></span>
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="preprocessor">#include <boost/shared_ptr.hpp></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include <boost/function.hpp></span>
<a name="l00041"></a>00041 <span class="preprocessor">#include <oxt/backtrace.hpp></span>
<a name="l00042"></a>00042 <span class="preprocessor">#include <oxt/system_calls.hpp></span>
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="preprocessor">#include "MessageChannel.h"</span>
<a name="l00045"></a>00045 <span class="preprocessor">#include "StaticString.h"</span>
<a name="l00046"></a>00046 <span class="preprocessor">#include "Exceptions.h"</span>
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="keyword">namespace </span>Passenger {
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keyword">using namespace </span>boost;
<a name="l00051"></a>00051 <span class="keyword">using namespace </span>oxt;
<a name="l00052"></a>00052 <span class="keyword">using namespace </span>std;
<a name="l00053"></a>00053
<a name="l00054"></a>00054 <span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment">/**</span>
<a name="l00056"></a>00056 <span class="comment"> * Represents a single request/response pair of an application process.</span>
<a name="l00057"></a>00057 <span class="comment"> *</span>
<a name="l00058"></a>00058 <span class="comment"> * Session is used to forward a single HTTP request to an application</span>
<a name="l00059"></a>00059 <span class="comment"> * process, and to read back the HTTP response. A Session object is to</span>
<a name="l00060"></a>00060 <span class="comment"> * be used in the following manner:</span>
<a name="l00061"></a>00061 <span class="comment"> *</span>
<a name="l00062"></a>00062 <span class="comment"> * -# Serialize the HTTP request headers into a format as expected by</span>
<a name="l00063"></a>00063 <span class="comment"> * sendHeaders(), then send that string by calling sendHeaders().</span>
<a name="l00064"></a>00064 <span class="comment"> * -# In case of a POST of PUT request, send the HTTP request body by</span>
<a name="l00065"></a>00065 <span class="comment"> * calling sendBodyBlock(), possibly multiple times.</span>
<a name="l00066"></a>00066 <span class="comment"> * -# Shutdown the writer end of the session channel (shutdownWriter())</span>
<a name="l00067"></a>00067 <span class="comment"> * since you're now done sending data.</span>
<a name="l00068"></a>00068 <span class="comment"> * -# The HTTP response can now be read through the session channel (getStream()).</span>
<a name="l00069"></a>00069 <span class="comment"> * -# When the HTTP response has been read, the session must be closed.</span>
<a name="l00070"></a>00070 <span class="comment"> * This is done by destroying the Session object.</span>
<a name="l00071"></a>00071 <span class="comment"> *</span>
<a name="l00072"></a>00072 <span class="comment"> * A usage example is shown in Process::newSession().</span>
<a name="l00073"></a>00073 <span class="comment"> *</span>
<a name="l00074"></a>00074 <span class="comment"> * Session is an abstract base class. Concrete implementations can be found in</span>
<a name="l00075"></a>00075 <span class="comment"> * StandardSession and ApplicationPool::Client::RemoteSession.</span>
<a name="l00076"></a>00076 <span class="comment"> *</span>
<a name="l00077"></a>00077 <span class="comment"> * Session is not guaranteed to be thread-safe.</span>
<a name="l00078"></a>00078 <span class="comment"> */</span>
<a name="l00079"></a><a class="code" href="classPassenger_1_1Session.html">00079</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1Session.html" title="Represents a single request/response pair of an application process.">Session</a> {
<a name="l00080"></a>00080 <span class="keyword">protected</span>:
<a name="l00081"></a>00081 <span class="keywordtype">string</span> detachKey;
<a name="l00082"></a>00082 <span class="keywordtype">string</span> connectPassword;
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00085"></a>00085 <span class="comment"> /**</span>
<a name="l00086"></a>00086 <span class="comment"> * Concrete classes might throw arbitrary exceptions.</span>
<a name="l00087"></a>00087 <span class="comment"> */</span>
<a name="l00088"></a><a class="code" href="classPassenger_1_1Session.html#c982015e84f64dbec70daef8fdbd31d9">00088</a> <span class="keyword">virtual</span> <a class="code" href="classPassenger_1_1Session.html#c982015e84f64dbec70daef8fdbd31d9" title="Concrete classes might throw arbitrary exceptions.">~Session</a>() {}
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment"> /**</span>
<a name="l00091"></a>00091 <span class="comment"> * Initiate the session by connecting to the associated process.</span>
<a name="l00092"></a>00092 <span class="comment"> * A Session is not usable until it's initiated.</span>
<a name="l00093"></a>00093 <span class="comment"> *</span>
<a name="l00094"></a>00094 <span class="comment"> * @throws SystemException Something went wrong.</span>
<a name="l00095"></a>00095 <span class="comment"> * @throws IOException Something went wrong.</span>
<a name="l00096"></a>00096 <span class="comment"> * @throws boost::thread_interrupted</span>
<a name="l00097"></a>00097 <span class="comment"> */</span>
<a name="l00098"></a>00098 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#bbcfa3eb48d38dead20c0d32cab4850b" title="Initiate the session by connecting to the associated process.">initiate</a>() = 0;
<a name="l00099"></a>00099 <span class="comment"></span>
<a name="l00100"></a>00100 <span class="comment"> /**</span>
<a name="l00101"></a>00101 <span class="comment"> * Returns whether this session has been initiated (that is, whether</span>
<a name="l00102"></a>00102 <span class="comment"> * initiate() had been called in the past).</span>
<a name="l00103"></a>00103 <span class="comment"> */</span>
<a name="l00104"></a>00104 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1Session.html#bf1b6ba182a0fc66c8e617f74afafb92" title="Returns whether this session has been initiated (that is, whether initiate() had...">initiated</a>() <span class="keyword">const</span> = 0;
<a name="l00105"></a>00105 <span class="comment"></span>
<a name="l00106"></a>00106 <span class="comment"> /**</span>
<a name="l00107"></a>00107 <span class="comment"> * Returns the type of the socket that this session is served from,</span>
<a name="l00108"></a>00108 <span class="comment"> * e.g. "unix" indicating a Unix socket.</span>
<a name="l00109"></a>00109 <span class="comment"> *</span>
<a name="l00110"></a>00110 <span class="comment"> * @post !result.empty()</span>
<a name="l00111"></a>00111 <span class="comment"> */</span>
<a name="l00112"></a>00112 <span class="keyword">virtual</span> <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Session.html#b8f084ab143d44f1a9ef8e8ccc841485" title="Returns the type of the socket that this session is served from, e.g.">getSocketType</a>() <span class="keyword">const</span> = 0;
<a name="l00113"></a>00113 <span class="comment"></span>
<a name="l00114"></a>00114 <span class="comment"> /**</span>
<a name="l00115"></a>00115 <span class="comment"> * Returns the address of the socket that this session is served</span>
<a name="l00116"></a>00116 <span class="comment"> * from. This can be a Unix socket filename or a TCP host:port string</span>
<a name="l00117"></a>00117 <span class="comment"> * like "127.0.0.1:1234".</span>
<a name="l00118"></a>00118 <span class="comment"> *</span>
<a name="l00119"></a>00119 <span class="comment"> * @post !result.empty()</span>
<a name="l00120"></a>00120 <span class="comment"> */</span>
<a name="l00121"></a>00121 <span class="keyword">virtual</span> <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Session.html#7b8a632ebde11544a8ab98fde89954bb" title="Returns the address of the socket that this session is served from.">getSocketName</a>() <span class="keyword">const</span> = 0;
<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="comment"> * Send HTTP request headers to the application. The HTTP headers must be</span>
<a name="l00125"></a>00125 <span class="comment"> * converted into CGI headers, and then encoded into a string that matches this grammar:</span>
<a name="l00126"></a>00126 <span class="comment"> *</span>
<a name="l00127"></a>00127 <span class="comment"> @verbatim</span>
<a name="l00128"></a>00128 <span class="comment"> headers ::= header*</span>
<a name="l00129"></a>00129 <span class="comment"> header ::= name NUL value NUL</span>
<a name="l00130"></a>00130 <span class="comment"> name ::= notnull+</span>
<a name="l00131"></a>00131 <span class="comment"> value ::= notnull+</span>
<a name="l00132"></a>00132 <span class="comment"> notnull ::= "\x01" | "\x02" | "\x02" | ... | "\xFF"</span>
<a name="l00133"></a>00133 <span class="comment"> NUL = "\x00"</span>
<a name="l00134"></a>00134 <span class="comment"> @endverbatim</span>
<a name="l00135"></a>00135 <span class="comment"> *</span>
<a name="l00136"></a>00136 <span class="comment"> * There must be a header with the name "PASSWORD_CONNECT_PASSWORD", and it must</span>
<a name="l00137"></a>00137 <span class="comment"> * have the same value as the string returned by getConnectPassword().</span>
<a name="l00138"></a>00138 <span class="comment"> *</span>
<a name="l00139"></a>00139 <span class="comment"> * This method should be the first one to be called during the lifetime of a Session</span>
<a name="l00140"></a>00140 <span class="comment"> * object, otherwise strange things may happen.</span>
<a name="l00141"></a>00141 <span class="comment"> *</span>
<a name="l00142"></a>00142 <span class="comment"> * @param headers The HTTP request headers, converted into CGI headers and encoded as</span>
<a name="l00143"></a>00143 <span class="comment"> * a string, according to the description.</span>
<a name="l00144"></a>00144 <span class="comment"> * @param size The size, in bytes, of <tt>headers</tt>.</span>
<a name="l00145"></a>00145 <span class="comment"> * @pre headers != NULL</span>
<a name="l00146"></a>00146 <span class="comment"> * @pre initiated()</span>
<a name="l00147"></a>00147 <span class="comment"> * @throws IOException The I/O channel has already been closed or discarded.</span>
<a name="l00148"></a>00148 <span class="comment"> * @throws SystemException Something went wrong during writing.</span>
<a name="l00149"></a>00149 <span class="comment"> * @throws boost::thread_interrupted</span>
<a name="l00150"></a>00150 <span class="comment"> */</span>
<a name="l00151"></a><a class="code" href="classPassenger_1_1Session.html#8f8a39f78dd2672b00f1ff01e4d6d671">00151</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#8f8a39f78dd2672b00f1ff01e4d6d671" title="Send HTTP request headers to the application.">sendHeaders</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *headers, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
<a name="l00152"></a>00152 TRACE_POINT();
<a name="l00153"></a>00153 <span class="keywordtype">int</span> stream = <a class="code" href="classPassenger_1_1Session.html#949c7a46f4bb0c628730ded2041d2489" title="Returns this session&#39;s channel&#39;s file descriptor.">getStream</a>();
<a name="l00154"></a>00154 <span class="keywordflow">if</span> (stream == -1) {
<a name="l00155"></a>00155 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Cannot write headers to the request handler "</span>
<a name="l00156"></a>00156 <span class="stringliteral">"because the I/O stream has already been closed or discarded."</span>);
<a name="l00157"></a>00157 }
<a name="l00158"></a>00158 <span class="keywordflow">try</span> {
<a name="l00159"></a>00159 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(stream).writeScalar(headers, size);
<a name="l00160"></a>00160 } <span class="keywordflow">catch</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> &e) {
<a name="l00161"></a>00161 e.<a class="code" href="classPassenger_1_1SystemException.html#6fc359f27a084158b7111ef35bec114f">setBriefMessage</a>(<span class="stringliteral">"An error occured while writing headers "</span>
<a name="l00162"></a>00162 <span class="stringliteral">"to the request handler"</span>);
<a name="l00163"></a>00163 <span class="keywordflow">throw</span>;
<a name="l00164"></a>00164 }
<a name="l00165"></a>00165 }
<a name="l00166"></a>00166 <span class="comment"></span>
<a name="l00167"></a>00167 <span class="comment"> /**</span>
<a name="l00168"></a>00168 <span class="comment"> * Convenience shortcut for sendHeaders(const char *, unsigned int)</span>
<a name="l00169"></a>00169 <span class="comment"> * @param headers The headers</span>
<a name="l00170"></a>00170 <span class="comment"> * @pre initiated()</span>
<a name="l00171"></a>00171 <span class="comment"> * @throws IOException The I/O channel has already been closed or discarded.</span>
<a name="l00172"></a>00172 <span class="comment"> * @throws SystemException Something went wrong during writing.</span>
<a name="l00173"></a>00173 <span class="comment"> * @throws boost::thread_interrupted</span>
<a name="l00174"></a>00174 <span class="comment"> */</span>
<a name="l00175"></a><a class="code" href="classPassenger_1_1Session.html#8253d81e64adc0dc72b1dc65a5117aba">00175</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#8253d81e64adc0dc72b1dc65a5117aba" title="Convenience shortcut for sendHeaders(const char *, unsigned int).">sendHeaders</a>(<span class="keyword">const</span> <a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a> &headers) {
<a name="l00176"></a>00176 <a class="code" href="classPassenger_1_1Session.html#8f8a39f78dd2672b00f1ff01e4d6d671" title="Send HTTP request headers to the application.">sendHeaders</a>(headers.<a class="code" href="classPassenger_1_1StaticString.html#f8c51bd393fd06b469015a51a9b3a4a8">c_str</a>(), headers.<a class="code" href="classPassenger_1_1StaticString.html#6181f5f7b38ed29d2c999c7cab956869">size</a>());
<a name="l00177"></a>00177 }
<a name="l00178"></a>00178 <span class="comment"></span>
<a name="l00179"></a>00179 <span class="comment"> /**</span>
<a name="l00180"></a>00180 <span class="comment"> * Send a chunk of HTTP request body data to the application.</span>
<a name="l00181"></a>00181 <span class="comment"> * You can call this method as many times as is required to transfer</span>
<a name="l00182"></a>00182 <span class="comment"> * the entire HTTP request body.</span>
<a name="l00183"></a>00183 <span class="comment"> *</span>
<a name="l00184"></a>00184 <span class="comment"> * This method must only be called after a sendHeaders(), otherwise</span>
<a name="l00185"></a>00185 <span class="comment"> * strange things may happen.</span>
<a name="l00186"></a>00186 <span class="comment"> *</span>
<a name="l00187"></a>00187 <span class="comment"> * @param block A block of HTTP request body data to send.</span>
<a name="l00188"></a>00188 <span class="comment"> * @param size The size, in bytes, of <tt>block</tt>.</span>
<a name="l00189"></a>00189 <span class="comment"> * @pre initiated()</span>
<a name="l00190"></a>00190 <span class="comment"> * @throws IOException The I/O channel has already been closed or discarded.</span>
<a name="l00191"></a>00191 <span class="comment"> * @throws SystemException Something went wrong during writing.</span>
<a name="l00192"></a>00192 <span class="comment"> * @throws boost::thread_interrupted</span>
<a name="l00193"></a>00193 <span class="comment"> */</span>
<a name="l00194"></a><a class="code" href="classPassenger_1_1Session.html#2203d81e25fe5066aed351608deecf7b">00194</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#2203d81e25fe5066aed351608deecf7b" title="Send a chunk of HTTP request body data to the application.">sendBodyBlock</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *block, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
<a name="l00195"></a>00195 TRACE_POINT();
<a name="l00196"></a>00196 <span class="keywordtype">int</span> stream = <a class="code" href="classPassenger_1_1Session.html#949c7a46f4bb0c628730ded2041d2489" title="Returns this session&#39;s channel&#39;s file descriptor.">getStream</a>();
<a name="l00197"></a>00197 <span class="keywordflow">if</span> (stream == -1) {
<a name="l00198"></a>00198 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Cannot write request body block to the "</span>
<a name="l00199"></a>00199 <span class="stringliteral">"request handler because the I/O channel has "</span>
<a name="l00200"></a>00200 <span class="stringliteral">"already been closed or discarded."</span>);
<a name="l00201"></a>00201 }
<a name="l00202"></a>00202 <span class="keywordflow">try</span> {
<a name="l00203"></a>00203 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(stream).writeRaw(block, size);
<a name="l00204"></a>00204 } <span class="keywordflow">catch</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> &e) {
<a name="l00205"></a>00205 e.<a class="code" href="classPassenger_1_1SystemException.html#6fc359f27a084158b7111ef35bec114f">setBriefMessage</a>(<span class="stringliteral">"An error occured while sending the "</span>
<a name="l00206"></a>00206 <span class="stringliteral">"request body to the request handler"</span>);
<a name="l00207"></a>00207 <span class="keywordflow">throw</span>;
<a name="l00208"></a>00208 }
<a name="l00209"></a>00209 }
<a name="l00210"></a>00210 <span class="comment"></span>
<a name="l00211"></a>00211 <span class="comment"> /**</span>
<a name="l00212"></a>00212 <span class="comment"> * Returns this session's channel's file descriptor. This stream is</span>
<a name="l00213"></a>00213 <span class="comment"> * full-duplex, and will be automatically closed upon Session's</span>
<a name="l00214"></a>00214 <span class="comment"> * destruction, unless discardStream() is called.</span>
<a name="l00215"></a>00215 <span class="comment"> *</span>
<a name="l00216"></a>00216 <span class="comment"> * @pre initiated()</span>
<a name="l00217"></a>00217 <span class="comment"> * @returns The file descriptor, or -1 if the I/O channel has already</span>
<a name="l00218"></a>00218 <span class="comment"> * been closed or discarded.</span>
<a name="l00219"></a>00219 <span class="comment"> */</span>
<a name="l00220"></a>00220 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1Session.html#949c7a46f4bb0c628730ded2041d2489" title="Returns this session&#39;s channel&#39;s file descriptor.">getStream</a>() <span class="keyword">const</span> = 0;
<a name="l00221"></a>00221 <span class="comment"></span>
<a name="l00222"></a>00222 <span class="comment"> /**</span>
<a name="l00223"></a>00223 <span class="comment"> * Set the timeout value for reading data from the I/O channel.</span>
<a name="l00224"></a>00224 <span class="comment"> * If no data can be read within the timeout period, then the</span>
<a name="l00225"></a>00225 <span class="comment"> * read call will fail with error EAGAIN or EWOULDBLOCK.</span>
<a name="l00226"></a>00226 <span class="comment"> *</span>
<a name="l00227"></a>00227 <span class="comment"> * @pre The I/O channel hasn't been closed or discarded.</span>
<a name="l00228"></a>00228 <span class="comment"> * @pre initiated()</span>
<a name="l00229"></a>00229 <span class="comment"> * @param msec The timeout, in milliseconds. If 0 is given,</span>
<a name="l00230"></a>00230 <span class="comment"> * there will be no timeout.</span>
<a name="l00231"></a>00231 <span class="comment"> * @throws SystemException Cannot set the timeout.</span>
<a name="l00232"></a>00232 <span class="comment"> */</span>
<a name="l00233"></a>00233 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#5accbd8f7cce66d0ef6695481fdaa39c" title="Set the timeout value for reading data from the I/O channel.">setReaderTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) = 0;
<a name="l00234"></a>00234 <span class="comment"></span>
<a name="l00235"></a>00235 <span class="comment"> /**</span>
<a name="l00236"></a>00236 <span class="comment"> * Set the timeout value for writing data from the I/O channel.</span>
<a name="l00237"></a>00237 <span class="comment"> * If no data can be written within the timeout period, then the</span>
<a name="l00238"></a>00238 <span class="comment"> * write call will fail with error EAGAIN or EWOULDBLOCK.</span>
<a name="l00239"></a>00239 <span class="comment"> *</span>
<a name="l00240"></a>00240 <span class="comment"> * @pre The I/O channel hasn't been closed or discarded.</span>
<a name="l00241"></a>00241 <span class="comment"> * @pre initiated()</span>
<a name="l00242"></a>00242 <span class="comment"> * @param msec The timeout, in milliseconds. If 0 is given,</span>
<a name="l00243"></a>00243 <span class="comment"> * there will be no timeout.</span>
<a name="l00244"></a>00244 <span class="comment"> * @throws SystemException Cannot set the timeout.</span>
<a name="l00245"></a>00245 <span class="comment"> */</span>
<a name="l00246"></a>00246 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#21dd749c0c8d22f65c6a914ec2f97c94" title="Set the timeout value for writing data from the I/O channel.">setWriterTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) = 0;
<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"> * Indicate that we don't want to read data anymore from the I/O channel.</span>
<a name="l00250"></a>00250 <span class="comment"> * Calling this method after closeStream()/discardStream() is called will</span>
<a name="l00251"></a>00251 <span class="comment"> * have no effect.</span>
<a name="l00252"></a>00252 <span class="comment"> *</span>
<a name="l00253"></a>00253 <span class="comment"> * @pre initiated()</span>
<a name="l00254"></a>00254 <span class="comment"> * @throws SystemException Something went wrong.</span>
<a name="l00255"></a>00255 <span class="comment"> * @throws boost::thread_interrupted</span>
<a name="l00256"></a>00256 <span class="comment"> */</span>
<a name="l00257"></a>00257 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#c579d233ddc82542c336b2af1f40c4dd" title="Indicate that we don&#39;t want to read data anymore from the I/O channel.">shutdownReader</a>() = 0;
<a name="l00258"></a>00258 <span class="comment"></span>
<a name="l00259"></a>00259 <span class="comment"> /**</span>
<a name="l00260"></a>00260 <span class="comment"> * Indicate that we don't want to write data anymore to the I/O channel.</span>
<a name="l00261"></a>00261 <span class="comment"> * Calling this method after closeStream()/discardStream() is called will</span>
<a name="l00262"></a>00262 <span class="comment"> * have no effect.</span>
<a name="l00263"></a>00263 <span class="comment"> *</span>
<a name="l00264"></a>00264 <span class="comment"> * @pre initiated()</span>
<a name="l00265"></a>00265 <span class="comment"> * @throws SystemException Something went wrong.</span>
<a name="l00266"></a>00266 <span class="comment"> * @throws boost::thread_interrupted</span>
<a name="l00267"></a>00267 <span class="comment"> */</span>
<a name="l00268"></a>00268 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#8263c568a8ac4567b33728d820cbd920" title="Indicate that we don&#39;t want to write data anymore to the I/O channel.">shutdownWriter</a>() = 0;
<a name="l00269"></a>00269 <span class="comment"></span>
<a name="l00270"></a>00270 <span class="comment"> /**</span>
<a name="l00271"></a>00271 <span class="comment"> * Close the I/O stream.</span>
<a name="l00272"></a>00272 <span class="comment"> *</span>
<a name="l00273"></a>00273 <span class="comment"> * @throws SystemException Something went wrong.</span>
<a name="l00274"></a>00274 <span class="comment"> * @throws boost::thread_interrupted</span>
<a name="l00275"></a>00275 <span class="comment"> * @pre initiated()</span>
<a name="l00276"></a>00276 <span class="comment"> * @post getStream() == -1</span>
<a name="l00277"></a>00277 <span class="comment"> */</span>
<a name="l00278"></a>00278 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#7ab85388f15388cb8e65873d1ad310a5" title="Close the I/O stream.">closeStream</a>() = 0;
<a name="l00279"></a>00279 <span class="comment"></span>
<a name="l00280"></a>00280 <span class="comment"> /**</span>
<a name="l00281"></a>00281 <span class="comment"> * Discard the I/O channel's file descriptor, so that the destructor</span>
<a name="l00282"></a>00282 <span class="comment"> * won't automatically close it.</span>
<a name="l00283"></a>00283 <span class="comment"> *</span>
<a name="l00284"></a>00284 <span class="comment"> * @pre initiated()</span>
<a name="l00285"></a>00285 <span class="comment"> * @post getStream() == -1</span>
<a name="l00286"></a>00286 <span class="comment"> */</span>
<a name="l00287"></a>00287 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#75344fdfb3c693323877e32884efaa31" title="Discard the I/O channel&#39;s file descriptor, so that the destructor won&#39;t automatically...">discardStream</a>() = 0;
<a name="l00288"></a>00288 <span class="comment"></span>
<a name="l00289"></a>00289 <span class="comment"> /**</span>
<a name="l00290"></a>00290 <span class="comment"> * Get the process ID of the application process that this session</span>
<a name="l00291"></a>00291 <span class="comment"> * belongs to.</span>
<a name="l00292"></a>00292 <span class="comment"> */</span>
<a name="l00293"></a>00293 <span class="keyword">virtual</span> pid_t <a class="code" href="classPassenger_1_1Session.html#1b58af5493a61bfe4efbd725dcef61a3" title="Get the process ID of the application process that this session belongs to.">getPid</a>() <span class="keyword">const</span> = 0;
<a name="l00294"></a>00294
<a name="l00295"></a>00295 <span class="keyword">const</span> <span class="keywordtype">string</span> getDetachKey()<span class="keyword"> const </span>{
<a name="l00296"></a>00296 <span class="keywordflow">return</span> detachKey;
<a name="l00297"></a>00297 }
<a name="l00298"></a>00298 <span class="comment"></span>
<a name="l00299"></a>00299 <span class="comment"> /**</span>
<a name="l00300"></a>00300 <span class="comment"> * Returns this session's process's connect password. This password is</span>
<a name="l00301"></a>00301 <span class="comment"> * guaranteed to be valid ASCII.</span>
<a name="l00302"></a>00302 <span class="comment"> */</span>
<a name="l00303"></a><a class="code" href="classPassenger_1_1Session.html#eaf4f7097f7b3430dc88e8070cad5899">00303</a> <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Session.html#eaf4f7097f7b3430dc88e8070cad5899" title="Returns this session&#39;s process&#39;s connect password.">getConnectPassword</a>()<span class="keyword"> const </span>{
<a name="l00304"></a>00304 <span class="keywordflow">return</span> connectPassword;
<a name="l00305"></a>00305 }
<a name="l00306"></a>00306 };
<a name="l00307"></a>00307
<a name="l00308"></a>00308 <span class="keyword">typedef</span> shared_ptr<Session> SessionPtr;
<a name="l00309"></a>00309
<a name="l00310"></a>00310 <span class="comment"></span>
<a name="l00311"></a>00311 <span class="comment">/**</span>
<a name="l00312"></a>00312 <span class="comment"> * A "standard" implementation of Session.</span>
<a name="l00313"></a>00313 <span class="comment"> */</span>
<a name="l00314"></a><a class="code" href="classPassenger_1_1StandardSession.html">00314</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1StandardSession.html" title="A &quot;standard&quot; implementation of Session.">StandardSession</a>: <span class="keyword">public</span> <a class="code" href="classPassenger_1_1Session.html" title="Represents a single request/response pair of an application process.">Session</a> {
<a name="l00315"></a>00315 <span class="keyword">protected</span>:
<a name="l00316"></a>00316 pid_t pid;
<a name="l00317"></a>00317 function<void()> closeCallback;
<a name="l00318"></a>00318 <span class="keywordtype">string</span> socketType;
<a name="l00319"></a>00319 <span class="keywordtype">string</span> socketName;
<a name="l00320"></a>00320 <span class="comment"></span>
<a name="l00321"></a>00321 <span class="comment"> /** The session connection file descriptor. */</span>
<a name="l00322"></a><a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9">00322</a> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a>;
<a name="l00323"></a>00323 <span class="keywordtype">bool</span> isInitiated;
<a name="l00324"></a>00324
<a name="l00325"></a>00325 <span class="keyword">public</span>:
<a name="l00326"></a>00326 <a class="code" href="classPassenger_1_1StandardSession.html" title="A &quot;standard&quot; implementation of Session.">StandardSession</a>(pid_t pid,
<a name="l00327"></a>00327 <span class="keyword">const</span> function<<span class="keywordtype">void</span>()> &closeCallback,
<a name="l00328"></a>00328 <span class="keyword">const</span> <span class="keywordtype">string</span> &socketType,
<a name="l00329"></a>00329 <span class="keyword">const</span> <span class="keywordtype">string</span> &socketName,
<a name="l00330"></a>00330 <span class="keyword">const</span> <span class="keywordtype">string</span> &detachKey,
<a name="l00331"></a>00331 <span class="keyword">const</span> <span class="keywordtype">string</span> &connectPassword)
<a name="l00332"></a>00332 {
<a name="l00333"></a>00333 TRACE_POINT();
<a name="l00334"></a>00334 <span class="keywordflow">if</span> (socketType != <span class="stringliteral">"unix"</span> && socketType != <span class="stringliteral">"tcp"</span>) {
<a name="l00335"></a>00335 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Unsupported socket type '"</span> + socketType + <span class="stringliteral">"'"</span>);
<a name="l00336"></a>00336 }
<a name="l00337"></a>00337 this->pid = pid;
<a name="l00338"></a>00338 this->closeCallback = closeCallback;
<a name="l00339"></a>00339 this->socketType = socketType;
<a name="l00340"></a>00340 this->socketName = socketName;
<a name="l00341"></a>00341 this->detachKey = detachKey;
<a name="l00342"></a>00342 this->connectPassword = connectPassword;
<a name="l00343"></a>00343 <a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> = -1;
<a name="l00344"></a>00344 isInitiated = <span class="keyword">false</span>;
<a name="l00345"></a>00345 }
<a name="l00346"></a>00346
<a name="l00347"></a>00347 <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1StandardSession.html" title="A &quot;standard&quot; implementation of Session.">StandardSession</a>() {
<a name="l00348"></a>00348 TRACE_POINT();
<a name="l00349"></a>00349 <a class="code" href="classPassenger_1_1StandardSession.html#f5cdfa78db1fca6303ccd43ac5126b6b" title="Close the I/O stream.">closeStream</a>();
<a name="l00350"></a>00350 <span class="keywordflow">if</span> (closeCallback != NULL) {
<a name="l00351"></a>00351 closeCallback();
<a name="l00352"></a>00352 }
<a name="l00353"></a>00353 }
<a name="l00354"></a>00354
<a name="l00355"></a><a class="code" href="classPassenger_1_1StandardSession.html#c283db6faf2fcd1827baf3ebac276677">00355</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1StandardSession.html#c283db6faf2fcd1827baf3ebac276677" title="Initiate the session by connecting to the associated process.">initiate</a>() {
<a name="l00356"></a>00356 TRACE_POINT();
<a name="l00357"></a>00357 <span class="keywordflow">if</span> (socketType == <span class="stringliteral">"unix"</span>) {
<a name="l00358"></a>00358 <a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> = <a class="code" href="group__Support.html#gae3993db9dfa0b05c97b67ccefd2b619" title="Connect to a Unix server socket at filename.">connectToUnixServer</a>(socketName.c_str());
<a name="l00359"></a>00359 } <span class="keywordflow">else</span> {
<a name="l00360"></a>00360 vector<string> args;
<a name="l00361"></a>00361
<a name="l00362"></a>00362 <a class="code" href="group__Support.html#g4b8320aedc6a164a535c920234e3d8bf" title="Split the given string using the given separator.">split</a>(socketName, <span class="charliteral">':'</span>, args);
<a name="l00363"></a>00363 <span class="keywordflow">if</span> (args.size() != 2 || <a class="code" href="group__Support.html#g73b17b509ee44938a56bf16cbf82fb48" title="Converts the given string to an integer.">atoi</a>(args[1]) == 0) {
<a name="l00364"></a>00364 UPDATE_TRACE_POINT();
<a name="l00365"></a>00365 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(<span class="stringliteral">"Invalid TCP/IP address '"</span> + socketName + <span class="stringliteral">"'"</span>);
<a name="l00366"></a>00366 }
<a name="l00367"></a>00367 <a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> = <a class="code" href="group__Support.html#gaf4965fbefc2dfe26c1380c621962e68" title="Connect to a TCP server socket at the given host name and port.">connectToTcpServer</a>(args[0].c_str(), <a class="code" href="group__Support.html#g73b17b509ee44938a56bf16cbf82fb48" title="Converts the given string to an integer.">atoi</a>(args[1]));
<a name="l00368"></a>00368 }
<a name="l00369"></a>00369 isInitiated = <span class="keyword">true</span>;
<a name="l00370"></a>00370 }
<a name="l00371"></a>00371
<a name="l00372"></a><a class="code" href="classPassenger_1_1StandardSession.html#40cdaad38dfbb7995955f11bb27bba61">00372</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1StandardSession.html#40cdaad38dfbb7995955f11bb27bba61" title="Returns whether this session has been initiated (that is, whether initiate() had...">initiated</a>()<span class="keyword"> const </span>{
<a name="l00373"></a>00373 <span class="keywordflow">return</span> isInitiated;
<a name="l00374"></a>00374 }
<a name="l00375"></a>00375
<a name="l00376"></a><a class="code" href="classPassenger_1_1StandardSession.html#3a59997280d5f7fcaa901716cd8451a2">00376</a> <span class="keyword">virtual</span> <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1StandardSession.html#3a59997280d5f7fcaa901716cd8451a2" title="Returns the type of the socket that this session is served from, e.g.">getSocketType</a>()<span class="keyword"> const </span>{
<a name="l00377"></a>00377 <span class="keywordflow">return</span> socketType;
<a name="l00378"></a>00378 }
<a name="l00379"></a>00379
<a name="l00380"></a><a class="code" href="classPassenger_1_1StandardSession.html#720e98b8dd246eeca004c8e625c0d4d3">00380</a> <span class="keyword">virtual</span> <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1StandardSession.html#720e98b8dd246eeca004c8e625c0d4d3" title="Returns the address of the socket that this session is served from.">getSocketName</a>()<span class="keyword"> const </span>{
<a name="l00381"></a>00381 <span class="keywordflow">return</span> socketName;
<a name="l00382"></a>00382 }
<a name="l00383"></a>00383
<a name="l00384"></a><a class="code" href="classPassenger_1_1StandardSession.html#a3491d2151ba3b94c1b19a4f18bade6a">00384</a> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1StandardSession.html#a3491d2151ba3b94c1b19a4f18bade6a" title="Returns this session&#39;s channel&#39;s file descriptor.">getStream</a>()<span class="keyword"> const </span>{
<a name="l00385"></a>00385 <span class="keywordflow">return</span> <a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a>;
<a name="l00386"></a>00386 }
<a name="l00387"></a>00387
<a name="l00388"></a><a class="code" href="classPassenger_1_1StandardSession.html#960346d8c27ff1ae9017d753e41a159a">00388</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1StandardSession.html#960346d8c27ff1ae9017d753e41a159a" title="Set the timeout value for reading data from the I/O channel.">setReaderTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) {
<a name="l00389"></a>00389 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(<a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a>).setReadTimeout(msec);
<a name="l00390"></a>00390 }
<a name="l00391"></a>00391
<a name="l00392"></a><a class="code" href="classPassenger_1_1StandardSession.html#bb51c323ac0e24011191862f6dec7a75">00392</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1StandardSession.html#bb51c323ac0e24011191862f6dec7a75" title="Set the timeout value for writing data from the I/O channel.">setWriterTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) {
<a name="l00393"></a>00393 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(<a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a>).setWriteTimeout(msec);
<a name="l00394"></a>00394 }
<a name="l00395"></a>00395
<a name="l00396"></a><a class="code" href="classPassenger_1_1StandardSession.html#c92d4d081d6145ba8d441c8cf88fae74">00396</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1StandardSession.html#c92d4d081d6145ba8d441c8cf88fae74" title="Indicate that we don&#39;t want to read data anymore from the I/O channel.">shutdownReader</a>() {
<a name="l00397"></a>00397 TRACE_POINT();
<a name="l00398"></a>00398 <span class="keywordflow">if</span> (<a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> != -1) {
<a name="l00399"></a>00399 <span class="keywordtype">int</span> ret = syscalls::shutdown(<a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a>, SHUT_RD);
<a name="l00400"></a>00400 <span class="keywordflow">if</span> (ret == -1) {
<a name="l00401"></a>00401 <span class="keywordtype">int</span> e = errno;
<a name="l00402"></a>00402 <span class="comment">// ENOTCONN is harmless here.</span>
<a name="l00403"></a>00403 <span class="keywordflow">if</span> (e != ENOTCONN) {
<a name="l00404"></a>00404 <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 shutdown the reader stream"</span>,
<a name="l00405"></a>00405 e);
<a name="l00406"></a>00406 }
<a name="l00407"></a>00407 }
<a name="l00408"></a>00408 }
<a name="l00409"></a>00409 }
<a name="l00410"></a>00410
<a name="l00411"></a><a class="code" href="classPassenger_1_1StandardSession.html#045a8f7f849c34086b0832fdba7a2915">00411</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1StandardSession.html#045a8f7f849c34086b0832fdba7a2915" title="Indicate that we don&#39;t want to write data anymore to the I/O channel.">shutdownWriter</a>() {
<a name="l00412"></a>00412 TRACE_POINT();
<a name="l00413"></a>00413 <span class="keywordflow">if</span> (<a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> != -1) {
<a name="l00414"></a>00414 <span class="keywordtype">int</span> ret = syscalls::shutdown(<a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a>, SHUT_WR);
<a name="l00415"></a>00415 <span class="keywordflow">if</span> (ret == -1) {
<a name="l00416"></a>00416 <span class="keywordtype">int</span> e = errno;
<a name="l00417"></a>00417 <span class="comment">// ENOTCONN is harmless here.</span>
<a name="l00418"></a>00418 <span class="keywordflow">if</span> (e != ENOTCONN) {
<a name="l00419"></a>00419 <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 shutdown the writer stream"</span>,
<a name="l00420"></a>00420 e);
<a name="l00421"></a>00421 }
<a name="l00422"></a>00422 }
<a name="l00423"></a>00423 }
<a name="l00424"></a>00424 }
<a name="l00425"></a>00425
<a name="l00426"></a><a class="code" href="classPassenger_1_1StandardSession.html#f5cdfa78db1fca6303ccd43ac5126b6b">00426</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1StandardSession.html#f5cdfa78db1fca6303ccd43ac5126b6b" title="Close the I/O stream.">closeStream</a>() {
<a name="l00427"></a>00427 TRACE_POINT();
<a name="l00428"></a>00428 <span class="keywordflow">if</span> (<a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> != -1) {
<a name="l00429"></a>00429 <span class="keywordtype">int</span> ret = syscalls::close(<a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a>);
<a name="l00430"></a>00430 <a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> = -1;
<a name="l00431"></a>00431 <span class="keywordflow">if</span> (ret == -1) {
<a name="l00432"></a>00432 <span class="keywordflow">if</span> (errno == EIO) {
<a name="l00433"></a>00433 <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">"A write operation on the session stream failed"</span>,
<a name="l00434"></a>00434 errno);
<a name="l00435"></a>00435 } <span class="keywordflow">else</span> {
<a name="l00436"></a>00436 <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 the session stream"</span>,
<a name="l00437"></a>00437 errno);
<a name="l00438"></a>00438 }
<a name="l00439"></a>00439 }
<a name="l00440"></a>00440 }
<a name="l00441"></a>00441 }
<a name="l00442"></a>00442
<a name="l00443"></a><a class="code" href="classPassenger_1_1StandardSession.html#3666d401df82696fe945fcbb66804785">00443</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1StandardSession.html#3666d401df82696fe945fcbb66804785" title="Discard the I/O channel&#39;s file descriptor, so that the destructor won&#39;t automatically...">discardStream</a>() {
<a name="l00444"></a>00444 <a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> = -1;
<a name="l00445"></a>00445 }
<a name="l00446"></a>00446
<a name="l00447"></a><a class="code" href="classPassenger_1_1StandardSession.html#496bbb49ac5f8d86ac6c37e979e7e3e8">00447</a> <span class="keyword">virtual</span> pid_t <a class="code" href="classPassenger_1_1StandardSession.html#496bbb49ac5f8d86ac6c37e979e7e3e8" title="Get the process ID of the application process that this session belongs to.">getPid</a>()<span class="keyword"> const </span>{
<a name="l00448"></a>00448 <span class="keywordflow">return</span> pid;
<a name="l00449"></a>00449 }
<a name="l00450"></a>00450 };
<a name="l00451"></a>00451
<a name="l00452"></a>00452
<a name="l00453"></a>00453 } <span class="comment">// namespace Passenger</span>
<a name="l00454"></a>00454
<a name="l00455"></a>00455 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_SESSION_H_ */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:46 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>
|
