passenger 2.2.11 → 2.2.12

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of passenger might be problematic. Click here for more details.

Files changed (287) hide show
  1. data/NEWS +29 -0
  2. data/bin/passenger-install-nginx-module +1 -1
  3. data/doc/Users guide Apache.html +38 -7
  4. data/doc/Users guide Nginx.html +36 -5
  5. data/doc/cxxapi/AbstractSpawnManager_8h-source.html +1 -1
  6. data/doc/cxxapi/Account_8h-source.html +1 -1
  7. data/doc/cxxapi/AccountsDatabase_8h-source.html +1 -1
  8. data/doc/cxxapi/AgentsStarter_8h-source.html +1 -1
  9. data/doc/cxxapi/BCrypt_8h-source.html +1 -1
  10. data/doc/cxxapi/Blowfish_8h-source.html +1 -1
  11. data/doc/cxxapi/Bucket_8h-source.html +5 -4
  12. data/doc/cxxapi/Constants_8h-source.html +2 -2
  13. data/doc/cxxapi/ContentHandler_8h-source.html +1 -1
  14. data/doc/cxxapi/DirectoryMapper_8h-source.html +10 -9
  15. data/doc/cxxapi/EventedServer_8h-source.html +415 -0
  16. data/doc/cxxapi/Exceptions_8h-source.html +1 -1
  17. data/doc/cxxapi/FileDescriptor_8h-source.html +1 -1
  18. data/doc/cxxapi/Hooks_8h-source.html +3 -2
  19. data/doc/cxxapi/HttpStatusExtractor_8h-source.html +324 -323
  20. data/doc/cxxapi/Logging_8h-source.html +643 -546
  21. data/doc/cxxapi/MessageChannel_8h-source.html +429 -404
  22. data/doc/cxxapi/MessageClient_8h-source.html +1 -1
  23. data/doc/cxxapi/MessageReadersWriters_8h-source.html +451 -0
  24. data/doc/cxxapi/MessageServer_8h-source.html +1 -1
  25. data/doc/cxxapi/PoolOptions_8h-source.html +287 -279
  26. data/doc/cxxapi/Process_8h-source.html +178 -167
  27. data/doc/cxxapi/RandomGenerator_8h-source.html +45 -18
  28. data/doc/cxxapi/ResourceLocator_8h-source.html +3 -3
  29. data/doc/cxxapi/ScgiRequestParser_8h-source.html +344 -343
  30. data/doc/cxxapi/ServerInstanceDir_8h-source.html +1 -1
  31. data/doc/cxxapi/Session_8h-source.html +387 -374
  32. data/doc/cxxapi/SpawnManager_8h-source.html +547 -538
  33. data/doc/cxxapi/StaticContentHandler_8h-source.html +1 -1
  34. data/doc/cxxapi/StaticString_8h-source.html +1 -1
  35. data/doc/cxxapi/StringListCreator_8h-source.html +1 -1
  36. data/doc/cxxapi/Utils_8h-source.html +545 -520
  37. data/doc/cxxapi/annotated.html +11 -8
  38. data/doc/cxxapi/apache2_2Configuration_8h-source.html +1 -1
  39. data/doc/cxxapi/classAgentWatcher-members.html +1 -1
  40. data/doc/cxxapi/classAgentWatcher.html +1 -1
  41. data/doc/cxxapi/classClient-members.html +1 -1
  42. data/doc/cxxapi/classClient.html +1 -1
  43. data/doc/cxxapi/classHooks-members.html +16 -13
  44. data/doc/cxxapi/classHooks.html +69 -73
  45. data/doc/cxxapi/classPassenger_1_1AbstractSpawnManager-members.html +1 -1
  46. data/doc/cxxapi/classPassenger_1_1AbstractSpawnManager.html +1 -1
  47. data/doc/cxxapi/classPassenger_1_1ArgumentException-members.html +1 -1
  48. data/doc/cxxapi/classPassenger_1_1ArgumentException.html +1 -1
  49. data/doc/cxxapi/classPassenger_1_1ArrayReader-members.html +33 -0
  50. data/doc/cxxapi/classPassenger_1_1ArrayReader.html +47 -0
  51. data/doc/cxxapi/classPassenger_1_1BufferedUpload-members.html +1 -1
  52. data/doc/cxxapi/classPassenger_1_1BufferedUpload.html +1 -1
  53. data/doc/cxxapi/classPassenger_1_1BusyException-members.html +1 -1
  54. data/doc/cxxapi/classPassenger_1_1BusyException.html +1 -1
  55. data/doc/cxxapi/classPassenger_1_1ConfigurationException-members.html +1 -1
  56. data/doc/cxxapi/classPassenger_1_1ConfigurationException.html +1 -1
  57. data/doc/cxxapi/classPassenger_1_1DirectoryMapper-members.html +18 -15
  58. data/doc/cxxapi/classPassenger_1_1DirectoryMapper.html +89 -99
  59. data/doc/cxxapi/classPassenger_1_1EOFException-members.html +1 -1
  60. data/doc/cxxapi/classPassenger_1_1EOFException.html +1 -1
  61. data/doc/cxxapi/classPassenger_1_1EventFd-members.html +1 -1
  62. data/doc/cxxapi/classPassenger_1_1EventFd.html +1 -1
  63. data/doc/cxxapi/classPassenger_1_1FileDescriptor-members.html +1 -1
  64. data/doc/cxxapi/classPassenger_1_1FileDescriptor.html +1 -1
  65. data/doc/cxxapi/classPassenger_1_1FileNotFoundException-members.html +1 -1
  66. data/doc/cxxapi/classPassenger_1_1FileNotFoundException.html +1 -1
  67. data/doc/cxxapi/classPassenger_1_1FileSystemException-members.html +1 -1
  68. data/doc/cxxapi/classPassenger_1_1FileSystemException.html +1 -1
  69. data/doc/cxxapi/classPassenger_1_1HttpStatusExtractor-members.html +1 -1
  70. data/doc/cxxapi/classPassenger_1_1HttpStatusExtractor.html +2 -2
  71. data/doc/cxxapi/classPassenger_1_1IOException-members.html +1 -1
  72. data/doc/cxxapi/classPassenger_1_1IOException.html +1 -1
  73. data/doc/cxxapi/classPassenger_1_1MemZeroGuard-members.html +1 -1
  74. data/doc/cxxapi/classPassenger_1_1MemZeroGuard.html +1 -1
  75. data/doc/cxxapi/classPassenger_1_1MessageChannel-members.html +1 -1
  76. data/doc/cxxapi/classPassenger_1_1MessageChannel.html +1 -1
  77. data/doc/cxxapi/classPassenger_1_1MessageServer-members.html +1 -1
  78. data/doc/cxxapi/classPassenger_1_1MessageServer.html +1 -1
  79. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1ClientContext-members.html +1 -1
  80. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1ClientContext.html +1 -1
  81. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1CommonClientContext-members.html +1 -1
  82. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1CommonClientContext.html +1 -1
  83. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1Handler-members.html +1 -1
  84. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1Handler.html +1 -1
  85. data/doc/cxxapi/classPassenger_1_1Process-members.html +4 -3
  86. data/doc/cxxapi/classPassenger_1_1Process.html +40 -9
  87. data/doc/cxxapi/classPassenger_1_1RandomGenerator-members.html +2 -1
  88. data/doc/cxxapi/classPassenger_1_1RandomGenerator.html +29 -2
  89. data/doc/cxxapi/classPassenger_1_1RuntimeException-members.html +1 -1
  90. data/doc/cxxapi/classPassenger_1_1RuntimeException.html +1 -1
  91. data/doc/cxxapi/classPassenger_1_1ScalarReader-members.html +33 -0
  92. data/doc/cxxapi/classPassenger_1_1ScalarReader.html +47 -0
  93. data/doc/cxxapi/classPassenger_1_1ScgiRequestParser-members.html +1 -1
  94. data/doc/cxxapi/classPassenger_1_1ScgiRequestParser.html +1 -1
  95. data/doc/cxxapi/classPassenger_1_1SecurityException-members.html +1 -1
  96. data/doc/cxxapi/classPassenger_1_1SecurityException.html +1 -1
  97. data/doc/cxxapi/classPassenger_1_1Session-members.html +1 -1
  98. data/doc/cxxapi/classPassenger_1_1Session.html +2 -2
  99. data/doc/cxxapi/classPassenger_1_1SpawnException-members.html +1 -1
  100. data/doc/cxxapi/classPassenger_1_1SpawnException.html +1 -1
  101. data/doc/cxxapi/classPassenger_1_1SpawnManager-members.html +2 -2
  102. data/doc/cxxapi/classPassenger_1_1SpawnManager.html +6 -18
  103. data/doc/cxxapi/classPassenger_1_1StandardSession-members.html +1 -1
  104. data/doc/cxxapi/classPassenger_1_1StandardSession.html +1 -1
  105. data/doc/cxxapi/classPassenger_1_1StaticString-members.html +1 -1
  106. data/doc/cxxapi/classPassenger_1_1StaticString.html +1 -1
  107. data/doc/cxxapi/classPassenger_1_1SystemException-members.html +1 -1
  108. data/doc/cxxapi/classPassenger_1_1SystemException.html +1 -1
  109. data/doc/cxxapi/classPassenger_1_1TimeRetrievalException-members.html +1 -1
  110. data/doc/cxxapi/classPassenger_1_1TimeRetrievalException.html +1 -1
  111. data/doc/cxxapi/classPassenger_1_1TimeoutException-members.html +1 -1
  112. data/doc/cxxapi/classPassenger_1_1TimeoutException.html +1 -1
  113. data/doc/cxxapi/classPassenger_1_1Uint16Reader-members.html +33 -0
  114. data/doc/cxxapi/classPassenger_1_1Uint16Reader.html +47 -0
  115. data/doc/cxxapi/classPassenger_1_1Uint32Reader-members.html +33 -0
  116. data/doc/cxxapi/classPassenger_1_1Uint32Reader.html +47 -0
  117. data/doc/cxxapi/classServer-members.html +1 -1
  118. data/doc/cxxapi/classServer.html +1 -1
  119. data/doc/cxxapi/classServerInstanceDirToucher-members.html +1 -1
  120. data/doc/cxxapi/classServerInstanceDirToucher.html +1 -1
  121. data/doc/cxxapi/classes.html +13 -10
  122. data/doc/cxxapi/definitions_8h-source.html +2 -1
  123. data/doc/cxxapi/doxygen.css +91 -0
  124. data/doc/cxxapi/files.html +16 -13
  125. data/doc/cxxapi/functions.html +32 -21
  126. data/doc/cxxapi/functions_enum.html +1 -1
  127. data/doc/cxxapi/functions_eval.html +1 -1
  128. data/doc/cxxapi/functions_func.html +32 -21
  129. data/doc/cxxapi/functions_vars.html +3 -1
  130. data/doc/cxxapi/graph_legend.html +20 -15
  131. data/doc/cxxapi/graph_legend.png +0 -0
  132. data/doc/cxxapi/group__Configuration.html +51 -64
  133. data/doc/cxxapi/group__Configuration.png +0 -0
  134. data/doc/cxxapi/group__Core.html +24 -26
  135. data/doc/cxxapi/group__Core.png +0 -0
  136. data/doc/cxxapi/group__Exceptions.html +1 -1
  137. data/doc/cxxapi/group__Hooks.html +17 -15
  138. data/doc/cxxapi/group__Hooks.png +0 -0
  139. data/doc/cxxapi/group__Support.html +11 -9
  140. data/doc/cxxapi/hierarchy.html +6 -1
  141. data/doc/cxxapi/index.html +10 -5
  142. data/doc/cxxapi/inherit__graph__10.map +1 -1
  143. data/doc/cxxapi/inherit__graph__10.md5 +1 -1
  144. data/doc/cxxapi/inherit__graph__10.png +0 -0
  145. data/doc/cxxapi/inherit__graph__11.map +1 -1
  146. data/doc/cxxapi/inherit__graph__11.md5 +1 -1
  147. data/doc/cxxapi/inherit__graph__11.png +0 -0
  148. data/doc/cxxapi/inherit__graph__12.map +1 -1
  149. data/doc/cxxapi/inherit__graph__12.md5 +1 -1
  150. data/doc/cxxapi/inherit__graph__12.png +0 -0
  151. data/doc/cxxapi/inherit__graph__13.map +1 -1
  152. data/doc/cxxapi/inherit__graph__13.md5 +1 -1
  153. data/doc/cxxapi/inherit__graph__13.png +0 -0
  154. data/doc/cxxapi/inherit__graph__14.map +1 -3
  155. data/doc/cxxapi/inherit__graph__14.md5 +1 -1
  156. data/doc/cxxapi/inherit__graph__14.png +0 -0
  157. data/doc/cxxapi/inherit__graph__15.map +1 -1
  158. data/doc/cxxapi/inherit__graph__15.md5 +1 -1
  159. data/doc/cxxapi/inherit__graph__15.png +0 -0
  160. data/doc/cxxapi/inherit__graph__16.map +3 -1
  161. data/doc/cxxapi/inherit__graph__16.md5 +1 -1
  162. data/doc/cxxapi/inherit__graph__16.png +0 -0
  163. data/doc/cxxapi/inherit__graph__17.map +1 -1
  164. data/doc/cxxapi/inherit__graph__17.md5 +1 -1
  165. data/doc/cxxapi/inherit__graph__17.png +0 -0
  166. data/doc/cxxapi/inherit__graph__18.map +1 -2
  167. data/doc/cxxapi/inherit__graph__18.md5 +1 -1
  168. data/doc/cxxapi/inherit__graph__18.png +0 -0
  169. data/doc/cxxapi/inherit__graph__19.map +1 -1
  170. data/doc/cxxapi/inherit__graph__19.md5 +1 -1
  171. data/doc/cxxapi/inherit__graph__19.png +0 -0
  172. data/doc/cxxapi/inherit__graph__20.map +2 -1
  173. data/doc/cxxapi/inherit__graph__20.md5 +1 -1
  174. data/doc/cxxapi/inherit__graph__20.png +0 -0
  175. data/doc/cxxapi/inherit__graph__21.map +1 -1
  176. data/doc/cxxapi/inherit__graph__21.md5 +1 -1
  177. data/doc/cxxapi/inherit__graph__21.png +0 -0
  178. data/doc/cxxapi/inherit__graph__22.map +1 -1
  179. data/doc/cxxapi/inherit__graph__22.md5 +1 -1
  180. data/doc/cxxapi/inherit__graph__22.png +0 -0
  181. data/doc/cxxapi/inherit__graph__23.map +1 -1
  182. data/doc/cxxapi/inherit__graph__23.md5 +1 -1
  183. data/doc/cxxapi/inherit__graph__23.png +0 -0
  184. data/doc/cxxapi/inherit__graph__24.map +1 -1
  185. data/doc/cxxapi/inherit__graph__24.md5 +1 -1
  186. data/doc/cxxapi/inherit__graph__24.png +0 -0
  187. data/doc/cxxapi/inherit__graph__25.map +1 -1
  188. data/doc/cxxapi/inherit__graph__25.md5 +1 -1
  189. data/doc/cxxapi/inherit__graph__25.png +0 -0
  190. data/doc/cxxapi/inherit__graph__26.map +1 -1
  191. data/doc/cxxapi/inherit__graph__26.md5 +1 -1
  192. data/doc/cxxapi/inherit__graph__26.png +0 -0
  193. data/doc/cxxapi/inherit__graph__27.map +1 -2
  194. data/doc/cxxapi/inherit__graph__27.md5 +1 -1
  195. data/doc/cxxapi/inherit__graph__27.png +0 -0
  196. data/doc/cxxapi/inherit__graph__28.map +1 -1
  197. data/doc/cxxapi/inherit__graph__28.md5 +1 -1
  198. data/doc/cxxapi/inherit__graph__28.png +0 -0
  199. data/doc/cxxapi/inherit__graph__29.map +1 -1
  200. data/doc/cxxapi/inherit__graph__29.md5 +1 -1
  201. data/doc/cxxapi/inherit__graph__29.png +0 -0
  202. data/doc/cxxapi/inherit__graph__30.map +2 -1
  203. data/doc/cxxapi/inherit__graph__30.md5 +1 -1
  204. data/doc/cxxapi/inherit__graph__30.png +0 -0
  205. data/doc/cxxapi/inherit__graph__31.map +1 -3
  206. data/doc/cxxapi/inherit__graph__31.md5 +1 -1
  207. data/doc/cxxapi/inherit__graph__31.png +0 -0
  208. data/doc/cxxapi/inherit__graph__32.map +1 -1
  209. data/doc/cxxapi/inherit__graph__32.md5 +1 -1
  210. data/doc/cxxapi/inherit__graph__32.png +0 -0
  211. data/doc/cxxapi/inherit__graph__33.map +1 -1
  212. data/doc/cxxapi/inherit__graph__33.md5 +1 -1
  213. data/doc/cxxapi/inherit__graph__33.png +0 -0
  214. data/doc/cxxapi/inherit__graph__34.map +3 -1
  215. data/doc/cxxapi/inherit__graph__34.md5 +1 -1
  216. data/doc/cxxapi/inherit__graph__34.png +0 -0
  217. data/doc/cxxapi/inherit__graph__35.map +1 -1
  218. data/doc/cxxapi/inherit__graph__35.md5 +1 -1
  219. data/doc/cxxapi/inherit__graph__35.png +0 -0
  220. data/doc/cxxapi/inherit__graph__36.map +1 -1
  221. data/doc/cxxapi/inherit__graph__36.md5 +1 -1
  222. data/doc/cxxapi/inherit__graph__36.png +0 -0
  223. data/doc/cxxapi/inherit__graph__37.map +1 -0
  224. data/doc/cxxapi/inherit__graph__37.md5 +1 -0
  225. data/doc/cxxapi/inherit__graph__37.png +0 -0
  226. data/doc/cxxapi/inherit__graph__38.map +1 -0
  227. data/doc/cxxapi/inherit__graph__38.md5 +1 -0
  228. data/doc/cxxapi/inherit__graph__38.png +0 -0
  229. data/doc/cxxapi/inherit__graph__39.map +1 -0
  230. data/doc/cxxapi/inherit__graph__39.md5 +1 -0
  231. data/doc/cxxapi/inherit__graph__39.png +0 -0
  232. data/doc/cxxapi/inherit__graph__5.map +1 -1
  233. data/doc/cxxapi/inherit__graph__5.md5 +1 -1
  234. data/doc/cxxapi/inherit__graph__5.png +0 -0
  235. data/doc/cxxapi/inherit__graph__6.map +1 -1
  236. data/doc/cxxapi/inherit__graph__6.md5 +1 -1
  237. data/doc/cxxapi/inherit__graph__6.png +0 -0
  238. data/doc/cxxapi/inherit__graph__7.map +1 -1
  239. data/doc/cxxapi/inherit__graph__7.md5 +1 -1
  240. data/doc/cxxapi/inherit__graph__7.png +0 -0
  241. data/doc/cxxapi/inherit__graph__8.map +1 -1
  242. data/doc/cxxapi/inherit__graph__8.md5 +1 -1
  243. data/doc/cxxapi/inherit__graph__8.png +0 -0
  244. data/doc/cxxapi/inherit__graph__9.map +1 -1
  245. data/doc/cxxapi/inherit__graph__9.md5 +1 -1
  246. data/doc/cxxapi/inherit__graph__9.png +0 -0
  247. data/doc/cxxapi/inherits.html +46 -31
  248. data/doc/cxxapi/main.html +12 -11
  249. data/doc/cxxapi/modules.html +16 -13
  250. data/doc/cxxapi/namespacePassenger.html +82 -5
  251. data/doc/cxxapi/namespacemembers.html +5 -3
  252. data/doc/cxxapi/namespacemembers_enum.html +1 -1
  253. data/doc/cxxapi/namespacemembers_eval.html +1 -1
  254. data/doc/cxxapi/namespacemembers_func.html +5 -3
  255. data/doc/cxxapi/namespacemembers_type.html +1 -1
  256. data/doc/cxxapi/namespaces.html +2 -2
  257. data/doc/cxxapi/nginx_2Configuration_8h-source.html +43 -42
  258. data/doc/cxxapi/ngx__http__passenger__module_8h-source.html +1 -1
  259. data/doc/cxxapi/structPassenger_1_1AnythingToString-members.html +1 -1
  260. data/doc/cxxapi/structPassenger_1_1AnythingToString.html +1 -1
  261. data/doc/cxxapi/structPassenger_1_1AnythingToString_3_01vector_3_01StaticString_01_4_01_4-members.html +33 -0
  262. data/doc/cxxapi/structPassenger_1_1AnythingToString_3_01vector_3_01StaticString_01_4_01_4.html +52 -0
  263. data/doc/cxxapi/structPassenger_1_1AnythingToString_3_01vector_3_01string_01_4_01_4-members.html +1 -1
  264. data/doc/cxxapi/structPassenger_1_1AnythingToString_3_01vector_3_01string_01_4_01_4.html +1 -1
  265. data/doc/cxxapi/structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard-members.html +1 -1
  266. data/doc/cxxapi/structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard.html +1 -1
  267. data/doc/cxxapi/structPassenger_1_1PoolOptions-members.html +3 -2
  268. data/doc/cxxapi/structPassenger_1_1PoolOptions.html +25 -5
  269. data/doc/cxxapi/structPassenger_1_1StaticString_1_1Hash-members.html +1 -1
  270. data/doc/cxxapi/structPassenger_1_1StaticString_1_1Hash.html +1 -1
  271. data/doc/cxxapi/tabs.css +1 -1
  272. data/doc/cxxapi/tree.html +20 -17
  273. data/doc/users_guide_snippets/tips.txt +28 -0
  274. data/ext/apache2/Hooks.cpp +19 -2
  275. data/ext/common/Utils.cpp +15 -4
  276. data/ext/common/Version.h +1 -1
  277. data/ext/nginx/StaticContentHandler.c +6 -3
  278. data/ext/phusion_passenger/native_support.c +25 -0
  279. data/lib/phusion_passenger/abstract_request_handler.rb +1 -0
  280. data/lib/phusion_passenger/constants.rb +1 -1
  281. data/lib/phusion_passenger/events.rb +3 -0
  282. data/lib/phusion_passenger/platform_info.rb +2 -1
  283. data/lib/phusion_passenger/rack/application_spawner.rb +2 -0
  284. data/lib/phusion_passenger/railz/application_spawner.rb +8 -0
  285. data/lib/phusion_passenger/utils.rb +69 -9
  286. data/lib/phusion_passenger/utils/rewindable_input.rb +10 -6
  287. metadata +55 -17
@@ -349,7 +349,7 @@
349
349
  <a name="l00327"></a>00327
350
350
  <a name="l00328"></a>00328 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_SERVER_INSTANCE_DIR_H_ */</span>
351
351
  </pre></div></div>
352
- <hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:46 2010 for Passenger by&nbsp;
352
+ <hr size="1"><address style="text-align: right;"><small>Generated on Sun Mar 28 14:11:56 2010 for Passenger by&nbsp;
353
353
  <a href="http://www.doxygen.org/index.html">
354
354
  <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
355
355
  </body>
@@ -102,381 +102,394 @@
102
102
  <a name="l00080"></a>00080 <span class="keyword">protected</span>:
103
103
  <a name="l00081"></a>00081 <span class="keywordtype">string</span> detachKey;
104
104
  <a name="l00082"></a>00082 <span class="keywordtype">string</span> connectPassword;
105
- <a name="l00083"></a>00083
106
- <a name="l00084"></a>00084 <span class="keyword">public</span>:<span class="comment"></span>
107
- <a name="l00085"></a>00085 <span class="comment"> /**</span>
108
- <a name="l00086"></a>00086 <span class="comment"> * Concrete classes might throw arbitrary exceptions.</span>
109
- <a name="l00087"></a>00087 <span class="comment"> */</span>
110
- <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>() {}
111
- <a name="l00089"></a>00089 <span class="comment"></span>
112
- <a name="l00090"></a>00090 <span class="comment"> /**</span>
113
- <a name="l00091"></a>00091 <span class="comment"> * Initiate the session by connecting to the associated process.</span>
114
- <a name="l00092"></a>00092 <span class="comment"> * A Session is not usable until it's initiated.</span>
115
- <a name="l00093"></a>00093 <span class="comment"> *</span>
116
- <a name="l00094"></a>00094 <span class="comment"> * @throws SystemException Something went wrong.</span>
117
- <a name="l00095"></a>00095 <span class="comment"> * @throws IOException Something went wrong.</span>
118
- <a name="l00096"></a>00096 <span class="comment"> * @throws boost::thread_interrupted</span>
119
- <a name="l00097"></a>00097 <span class="comment"> */</span>
120
- <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;
121
- <a name="l00099"></a>00099 <span class="comment"></span>
122
- <a name="l00100"></a>00100 <span class="comment"> /**</span>
123
- <a name="l00101"></a>00101 <span class="comment"> * Returns whether this session has been initiated (that is, whether</span>
124
- <a name="l00102"></a>00102 <span class="comment"> * initiate() had been called in the past).</span>
125
- <a name="l00103"></a>00103 <span class="comment"> */</span>
126
- <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;
127
- <a name="l00105"></a>00105 <span class="comment"></span>
128
- <a name="l00106"></a>00106 <span class="comment"> /**</span>
129
- <a name="l00107"></a>00107 <span class="comment"> * Returns the type of the socket that this session is served from,</span>
130
- <a name="l00108"></a>00108 <span class="comment"> * e.g. "unix" indicating a Unix socket.</span>
131
- <a name="l00109"></a>00109 <span class="comment"> *</span>
132
- <a name="l00110"></a>00110 <span class="comment"> * @post !result.empty()</span>
133
- <a name="l00111"></a>00111 <span class="comment"> */</span>
134
- <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;
135
- <a name="l00113"></a>00113 <span class="comment"></span>
136
- <a name="l00114"></a>00114 <span class="comment"> /**</span>
137
- <a name="l00115"></a>00115 <span class="comment"> * Returns the address of the socket that this session is served</span>
138
- <a name="l00116"></a>00116 <span class="comment"> * from. This can be a Unix socket filename or a TCP host:port string</span>
139
- <a name="l00117"></a>00117 <span class="comment"> * like "127.0.0.1:1234".</span>
140
- <a name="l00118"></a>00118 <span class="comment"> *</span>
141
- <a name="l00119"></a>00119 <span class="comment"> * @post !result.empty()</span>
142
- <a name="l00120"></a>00120 <span class="comment"> */</span>
143
- <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;
144
- <a name="l00122"></a>00122 <span class="comment"></span>
145
- <a name="l00123"></a>00123 <span class="comment"> /**</span>
146
- <a name="l00124"></a>00124 <span class="comment"> * Send HTTP request headers to the application. The HTTP headers must be</span>
147
- <a name="l00125"></a>00125 <span class="comment"> * converted into CGI headers, and then encoded into a string that matches this grammar:</span>
148
- <a name="l00126"></a>00126 <span class="comment"> *</span>
149
- <a name="l00127"></a>00127 <span class="comment"> @verbatim</span>
150
- <a name="l00128"></a>00128 <span class="comment"> headers ::= header*</span>
151
- <a name="l00129"></a>00129 <span class="comment"> header ::= name NUL value NUL</span>
152
- <a name="l00130"></a>00130 <span class="comment"> name ::= notnull+</span>
153
- <a name="l00131"></a>00131 <span class="comment"> value ::= notnull+</span>
154
- <a name="l00132"></a>00132 <span class="comment"> notnull ::= "\x01" | "\x02" | "\x02" | ... | "\xFF"</span>
155
- <a name="l00133"></a>00133 <span class="comment"> NUL = "\x00"</span>
156
- <a name="l00134"></a>00134 <span class="comment"> @endverbatim</span>
157
- <a name="l00135"></a>00135 <span class="comment"> *</span>
158
- <a name="l00136"></a>00136 <span class="comment"> * There must be a header with the name "PASSWORD_CONNECT_PASSWORD", and it must</span>
159
- <a name="l00137"></a>00137 <span class="comment"> * have the same value as the string returned by getConnectPassword().</span>
160
- <a name="l00138"></a>00138 <span class="comment"> *</span>
161
- <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>
162
- <a name="l00140"></a>00140 <span class="comment"> * object, otherwise strange things may happen.</span>
163
- <a name="l00141"></a>00141 <span class="comment"> *</span>
164
- <a name="l00142"></a>00142 <span class="comment"> * @param headers The HTTP request headers, converted into CGI headers and encoded as</span>
165
- <a name="l00143"></a>00143 <span class="comment"> * a string, according to the description.</span>
166
- <a name="l00144"></a>00144 <span class="comment"> * @param size The size, in bytes, of &lt;tt&gt;headers&lt;/tt&gt;.</span>
167
- <a name="l00145"></a>00145 <span class="comment"> * @pre headers != NULL</span>
168
- <a name="l00146"></a>00146 <span class="comment"> * @pre initiated()</span>
169
- <a name="l00147"></a>00147 <span class="comment"> * @throws IOException The I/O channel has already been closed or discarded.</span>
170
- <a name="l00148"></a>00148 <span class="comment"> * @throws SystemException Something went wrong during writing.</span>
171
- <a name="l00149"></a>00149 <span class="comment"> * @throws boost::thread_interrupted</span>
172
- <a name="l00150"></a>00150 <span class="comment"> */</span>
173
- <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) {
174
- <a name="l00152"></a>00152 TRACE_POINT();
175
- <a name="l00153"></a>00153 <span class="keywordtype">int</span> stream = <a class="code" href="classPassenger_1_1Session.html#949c7a46f4bb0c628730ded2041d2489" title="Returns this session&amp;#39;s channel&amp;#39;s file descriptor.">getStream</a>();
176
- <a name="l00154"></a>00154 <span class="keywordflow">if</span> (stream == -1) {
177
- <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>
178
- <a name="l00156"></a>00156 <span class="stringliteral">"because the I/O stream has already been closed or discarded."</span>);
179
- <a name="l00157"></a>00157 }
180
- <a name="l00158"></a>00158 <span class="keywordflow">try</span> {
181
- <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);
182
- <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> &amp;e) {
183
- <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>
184
- <a name="l00162"></a>00162 <span class="stringliteral">"to the request handler"</span>);
185
- <a name="l00163"></a>00163 <span class="keywordflow">throw</span>;
186
- <a name="l00164"></a>00164 }
187
- <a name="l00165"></a>00165 }
188
- <a name="l00166"></a>00166 <span class="comment"></span>
189
- <a name="l00167"></a>00167 <span class="comment"> /**</span>
190
- <a name="l00168"></a>00168 <span class="comment"> * Convenience shortcut for sendHeaders(const char *, unsigned int)</span>
191
- <a name="l00169"></a>00169 <span class="comment"> * @param headers The headers</span>
192
- <a name="l00170"></a>00170 <span class="comment"> * @pre initiated()</span>
193
- <a name="l00171"></a>00171 <span class="comment"> * @throws IOException The I/O channel has already been closed or discarded.</span>
194
- <a name="l00172"></a>00172 <span class="comment"> * @throws SystemException Something went wrong during writing.</span>
195
- <a name="l00173"></a>00173 <span class="comment"> * @throws boost::thread_interrupted</span>
196
- <a name="l00174"></a>00174 <span class="comment"> */</span>
197
- <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> &amp;headers) {
198
- <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>());
199
- <a name="l00177"></a>00177 }
200
- <a name="l00178"></a>00178 <span class="comment"></span>
201
- <a name="l00179"></a>00179 <span class="comment"> /**</span>
202
- <a name="l00180"></a>00180 <span class="comment"> * Send a chunk of HTTP request body data to the application.</span>
203
- <a name="l00181"></a>00181 <span class="comment"> * You can call this method as many times as is required to transfer</span>
204
- <a name="l00182"></a>00182 <span class="comment"> * the entire HTTP request body.</span>
205
- <a name="l00183"></a>00183 <span class="comment"> *</span>
206
- <a name="l00184"></a>00184 <span class="comment"> * This method must only be called after a sendHeaders(), otherwise</span>
207
- <a name="l00185"></a>00185 <span class="comment"> * strange things may happen.</span>
208
- <a name="l00186"></a>00186 <span class="comment"> *</span>
209
- <a name="l00187"></a>00187 <span class="comment"> * @param block A block of HTTP request body data to send.</span>
210
- <a name="l00188"></a>00188 <span class="comment"> * @param size The size, in bytes, of &lt;tt&gt;block&lt;/tt&gt;.</span>
211
- <a name="l00189"></a>00189 <span class="comment"> * @pre initiated()</span>
212
- <a name="l00190"></a>00190 <span class="comment"> * @throws IOException The I/O channel has already been closed or discarded.</span>
213
- <a name="l00191"></a>00191 <span class="comment"> * @throws SystemException Something went wrong during writing.</span>
214
- <a name="l00192"></a>00192 <span class="comment"> * @throws boost::thread_interrupted</span>
215
- <a name="l00193"></a>00193 <span class="comment"> */</span>
216
- <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) {
217
- <a name="l00195"></a>00195 TRACE_POINT();
218
- <a name="l00196"></a>00196 <span class="keywordtype">int</span> stream = <a class="code" href="classPassenger_1_1Session.html#949c7a46f4bb0c628730ded2041d2489" title="Returns this session&amp;#39;s channel&amp;#39;s file descriptor.">getStream</a>();
219
- <a name="l00197"></a>00197 <span class="keywordflow">if</span> (stream == -1) {
220
- <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>
221
- <a name="l00199"></a>00199 <span class="stringliteral">"request handler because the I/O channel has "</span>
222
- <a name="l00200"></a>00200 <span class="stringliteral">"already been closed or discarded."</span>);
223
- <a name="l00201"></a>00201 }
224
- <a name="l00202"></a>00202 <span class="keywordflow">try</span> {
225
- <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);
226
- <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> &amp;e) {
227
- <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>
228
- <a name="l00206"></a>00206 <span class="stringliteral">"request body to the request handler"</span>);
229
- <a name="l00207"></a>00207 <span class="keywordflow">throw</span>;
230
- <a name="l00208"></a>00208 }
231
- <a name="l00209"></a>00209 }
232
- <a name="l00210"></a>00210 <span class="comment"></span>
233
- <a name="l00211"></a>00211 <span class="comment"> /**</span>
234
- <a name="l00212"></a>00212 <span class="comment"> * Returns this session's channel's file descriptor. This stream is</span>
235
- <a name="l00213"></a>00213 <span class="comment"> * full-duplex, and will be automatically closed upon Session's</span>
236
- <a name="l00214"></a>00214 <span class="comment"> * destruction, unless discardStream() is called.</span>
237
- <a name="l00215"></a>00215 <span class="comment"> *</span>
238
- <a name="l00216"></a>00216 <span class="comment"> * @pre initiated()</span>
239
- <a name="l00217"></a>00217 <span class="comment"> * @returns The file descriptor, or -1 if the I/O channel has already</span>
240
- <a name="l00218"></a>00218 <span class="comment"> * been closed or discarded.</span>
241
- <a name="l00219"></a>00219 <span class="comment"> */</span>
242
- <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&amp;#39;s channel&amp;#39;s file descriptor.">getStream</a>() <span class="keyword">const</span> = 0;
243
- <a name="l00221"></a>00221 <span class="comment"></span>
244
- <a name="l00222"></a>00222 <span class="comment"> /**</span>
245
- <a name="l00223"></a>00223 <span class="comment"> * Set the timeout value for reading data from the I/O channel.</span>
246
- <a name="l00224"></a>00224 <span class="comment"> * If no data can be read within the timeout period, then the</span>
247
- <a name="l00225"></a>00225 <span class="comment"> * read call will fail with error EAGAIN or EWOULDBLOCK.</span>
248
- <a name="l00226"></a>00226 <span class="comment"> *</span>
249
- <a name="l00227"></a>00227 <span class="comment"> * @pre The I/O channel hasn't been closed or discarded.</span>
250
- <a name="l00228"></a>00228 <span class="comment"> * @pre initiated()</span>
251
- <a name="l00229"></a>00229 <span class="comment"> * @param msec The timeout, in milliseconds. If 0 is given,</span>
252
- <a name="l00230"></a>00230 <span class="comment"> * there will be no timeout.</span>
253
- <a name="l00231"></a>00231 <span class="comment"> * @throws SystemException Cannot set the timeout.</span>
254
- <a name="l00232"></a>00232 <span class="comment"> */</span>
255
- <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;
256
- <a name="l00234"></a>00234 <span class="comment"></span>
257
- <a name="l00235"></a>00235 <span class="comment"> /**</span>
258
- <a name="l00236"></a>00236 <span class="comment"> * Set the timeout value for writing data from the I/O channel.</span>
259
- <a name="l00237"></a>00237 <span class="comment"> * If no data can be written within the timeout period, then the</span>
260
- <a name="l00238"></a>00238 <span class="comment"> * write call will fail with error EAGAIN or EWOULDBLOCK.</span>
261
- <a name="l00239"></a>00239 <span class="comment"> *</span>
262
- <a name="l00240"></a>00240 <span class="comment"> * @pre The I/O channel hasn't been closed or discarded.</span>
263
- <a name="l00241"></a>00241 <span class="comment"> * @pre initiated()</span>
264
- <a name="l00242"></a>00242 <span class="comment"> * @param msec The timeout, in milliseconds. If 0 is given,</span>
265
- <a name="l00243"></a>00243 <span class="comment"> * there will be no timeout.</span>
266
- <a name="l00244"></a>00244 <span class="comment"> * @throws SystemException Cannot set the timeout.</span>
267
- <a name="l00245"></a>00245 <span class="comment"> */</span>
268
- <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;
269
- <a name="l00247"></a>00247 <span class="comment"></span>
270
- <a name="l00248"></a>00248 <span class="comment"> /**</span>
271
- <a name="l00249"></a>00249 <span class="comment"> * Indicate that we don't want to read data anymore from the I/O channel.</span>
272
- <a name="l00250"></a>00250 <span class="comment"> * Calling this method after closeStream()/discardStream() is called will</span>
273
- <a name="l00251"></a>00251 <span class="comment"> * have no effect.</span>
274
- <a name="l00252"></a>00252 <span class="comment"> *</span>
275
- <a name="l00253"></a>00253 <span class="comment"> * @pre initiated()</span>
276
- <a name="l00254"></a>00254 <span class="comment"> * @throws SystemException Something went wrong.</span>
277
- <a name="l00255"></a>00255 <span class="comment"> * @throws boost::thread_interrupted</span>
278
- <a name="l00256"></a>00256 <span class="comment"> */</span>
279
- <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&amp;#39;t want to read data anymore from the I/O channel.">shutdownReader</a>() = 0;
280
- <a name="l00258"></a>00258 <span class="comment"></span>
281
- <a name="l00259"></a>00259 <span class="comment"> /**</span>
282
- <a name="l00260"></a>00260 <span class="comment"> * Indicate that we don't want to write data anymore to the I/O channel.</span>
283
- <a name="l00261"></a>00261 <span class="comment"> * Calling this method after closeStream()/discardStream() is called will</span>
284
- <a name="l00262"></a>00262 <span class="comment"> * have no effect.</span>
285
- <a name="l00263"></a>00263 <span class="comment"> *</span>
286
- <a name="l00264"></a>00264 <span class="comment"> * @pre initiated()</span>
287
- <a name="l00265"></a>00265 <span class="comment"> * @throws SystemException Something went wrong.</span>
288
- <a name="l00266"></a>00266 <span class="comment"> * @throws boost::thread_interrupted</span>
289
- <a name="l00267"></a>00267 <span class="comment"> */</span>
290
- <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&amp;#39;t want to write data anymore to the I/O channel.">shutdownWriter</a>() = 0;
291
- <a name="l00269"></a>00269 <span class="comment"></span>
292
- <a name="l00270"></a>00270 <span class="comment"> /**</span>
293
- <a name="l00271"></a>00271 <span class="comment"> * Close the I/O stream.</span>
294
- <a name="l00272"></a>00272 <span class="comment"> *</span>
295
- <a name="l00273"></a>00273 <span class="comment"> * @throws SystemException Something went wrong.</span>
296
- <a name="l00274"></a>00274 <span class="comment"> * @throws boost::thread_interrupted</span>
297
- <a name="l00275"></a>00275 <span class="comment"> * @pre initiated()</span>
298
- <a name="l00276"></a>00276 <span class="comment"> * @post getStream() == -1</span>
299
- <a name="l00277"></a>00277 <span class="comment"> */</span>
300
- <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;
301
- <a name="l00279"></a>00279 <span class="comment"></span>
302
- <a name="l00280"></a>00280 <span class="comment"> /**</span>
303
- <a name="l00281"></a>00281 <span class="comment"> * Discard the I/O channel's file descriptor, so that the destructor</span>
304
- <a name="l00282"></a>00282 <span class="comment"> * won't automatically close it.</span>
305
- <a name="l00283"></a>00283 <span class="comment"> *</span>
306
- <a name="l00284"></a>00284 <span class="comment"> * @pre initiated()</span>
307
- <a name="l00285"></a>00285 <span class="comment"> * @post getStream() == -1</span>
308
- <a name="l00286"></a>00286 <span class="comment"> */</span>
309
- <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&amp;#39;s file descriptor, so that the destructor won&amp;#39;t automatically...">discardStream</a>() = 0;
310
- <a name="l00288"></a>00288 <span class="comment"></span>
311
- <a name="l00289"></a>00289 <span class="comment"> /**</span>
312
- <a name="l00290"></a>00290 <span class="comment"> * Get the process ID of the application process that this session</span>
313
- <a name="l00291"></a>00291 <span class="comment"> * belongs to.</span>
314
- <a name="l00292"></a>00292 <span class="comment"> */</span>
315
- <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;
316
- <a name="l00294"></a>00294
317
- <a name="l00295"></a>00295 <span class="keyword">const</span> <span class="keywordtype">string</span> getDetachKey()<span class="keyword"> const </span>{
318
- <a name="l00296"></a>00296 <span class="keywordflow">return</span> detachKey;
319
- <a name="l00297"></a>00297 }
320
- <a name="l00298"></a>00298 <span class="comment"></span>
321
- <a name="l00299"></a>00299 <span class="comment"> /**</span>
322
- <a name="l00300"></a>00300 <span class="comment"> * Returns this session's process's connect password. This password is</span>
323
- <a name="l00301"></a>00301 <span class="comment"> * guaranteed to be valid ASCII.</span>
324
- <a name="l00302"></a>00302 <span class="comment"> */</span>
325
- <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&amp;#39;s process&amp;#39;s connect password.">getConnectPassword</a>()<span class="keyword"> const </span>{
326
- <a name="l00304"></a>00304 <span class="keywordflow">return</span> connectPassword;
327
- <a name="l00305"></a>00305 }
328
- <a name="l00306"></a>00306 };
329
- <a name="l00307"></a>00307
330
- <a name="l00308"></a>00308 <span class="keyword">typedef</span> shared_ptr&lt;Session&gt; SessionPtr;
331
- <a name="l00309"></a>00309
332
- <a name="l00310"></a>00310 <span class="comment"></span>
333
- <a name="l00311"></a>00311 <span class="comment">/**</span>
334
- <a name="l00312"></a>00312 <span class="comment"> * A "standard" implementation of Session.</span>
335
- <a name="l00313"></a>00313 <span class="comment"> */</span>
336
- <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 &amp;quot;standard&amp;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> {
337
- <a name="l00315"></a>00315 <span class="keyword">protected</span>:
338
- <a name="l00316"></a>00316 pid_t pid;
339
- <a name="l00317"></a>00317 function&lt;void()&gt; closeCallback;
340
- <a name="l00318"></a>00318 <span class="keywordtype">string</span> socketType;
341
- <a name="l00319"></a>00319 <span class="keywordtype">string</span> socketName;
342
- <a name="l00320"></a>00320 <span class="comment"></span>
343
- <a name="l00321"></a>00321 <span class="comment"> /** The session connection file descriptor. */</span>
344
- <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>;
345
- <a name="l00323"></a>00323 <span class="keywordtype">bool</span> isInitiated;
346
- <a name="l00324"></a>00324
347
- <a name="l00325"></a>00325 <span class="keyword">public</span>:
348
- <a name="l00326"></a>00326 <a class="code" href="classPassenger_1_1StandardSession.html" title="A &amp;quot;standard&amp;quot; implementation of Session.">StandardSession</a>(pid_t pid,
349
- <a name="l00327"></a>00327 <span class="keyword">const</span> function&lt;<span class="keywordtype">void</span>()&gt; &amp;closeCallback,
350
- <a name="l00328"></a>00328 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;socketType,
351
- <a name="l00329"></a>00329 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;socketName,
352
- <a name="l00330"></a>00330 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;detachKey,
353
- <a name="l00331"></a>00331 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;connectPassword)
354
- <a name="l00332"></a>00332 {
355
- <a name="l00333"></a>00333 TRACE_POINT();
356
- <a name="l00334"></a>00334 <span class="keywordflow">if</span> (socketType != <span class="stringliteral">"unix"</span> &amp;&amp; socketType != <span class="stringliteral">"tcp"</span>) {
357
- <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>);
358
- <a name="l00336"></a>00336 }
359
- <a name="l00337"></a>00337 this-&gt;pid = pid;
360
- <a name="l00338"></a>00338 this-&gt;closeCallback = closeCallback;
361
- <a name="l00339"></a>00339 this-&gt;socketType = socketType;
362
- <a name="l00340"></a>00340 this-&gt;socketName = socketName;
363
- <a name="l00341"></a>00341 this-&gt;detachKey = detachKey;
364
- <a name="l00342"></a>00342 this-&gt;connectPassword = connectPassword;
365
- <a name="l00343"></a>00343 <a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> = -1;
366
- <a name="l00344"></a>00344 isInitiated = <span class="keyword">false</span>;
367
- <a name="l00345"></a>00345 }
368
- <a name="l00346"></a>00346
369
- <a name="l00347"></a>00347 <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1StandardSession.html" title="A &amp;quot;standard&amp;quot; implementation of Session.">StandardSession</a>() {
370
- <a name="l00348"></a>00348 TRACE_POINT();
371
- <a name="l00349"></a>00349 <a class="code" href="classPassenger_1_1StandardSession.html#f5cdfa78db1fca6303ccd43ac5126b6b" title="Close the I/O stream.">closeStream</a>();
372
- <a name="l00350"></a>00350 <span class="keywordflow">if</span> (closeCallback != NULL) {
373
- <a name="l00351"></a>00351 closeCallback();
374
- <a name="l00352"></a>00352 }
375
- <a name="l00353"></a>00353 }
376
- <a name="l00354"></a>00354
377
- <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>() {
378
- <a name="l00356"></a>00356 TRACE_POINT();
379
- <a name="l00357"></a>00357 <span class="keywordflow">if</span> (socketType == <span class="stringliteral">"unix"</span>) {
380
- <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());
381
- <a name="l00359"></a>00359 } <span class="keywordflow">else</span> {
382
- <a name="l00360"></a>00360 vector&lt;string&gt; args;
383
- <a name="l00361"></a>00361
384
- <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);
385
- <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) {
386
- <a name="l00364"></a>00364 UPDATE_TRACE_POINT();
387
- <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>);
388
- <a name="l00366"></a>00366 }
389
- <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]));
390
- <a name="l00368"></a>00368 }
391
- <a name="l00369"></a>00369 isInitiated = <span class="keyword">true</span>;
392
- <a name="l00370"></a>00370 }
393
- <a name="l00371"></a>00371
394
- <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>{
395
- <a name="l00373"></a>00373 <span class="keywordflow">return</span> isInitiated;
396
- <a name="l00374"></a>00374 }
397
- <a name="l00375"></a>00375
398
- <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>{
399
- <a name="l00377"></a>00377 <span class="keywordflow">return</span> socketType;
400
- <a name="l00378"></a>00378 }
401
- <a name="l00379"></a>00379
402
- <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>{
403
- <a name="l00381"></a>00381 <span class="keywordflow">return</span> socketName;
404
- <a name="l00382"></a>00382 }
405
- <a name="l00383"></a>00383
406
- <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&amp;#39;s channel&amp;#39;s file descriptor.">getStream</a>()<span class="keyword"> const </span>{
407
- <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>;
408
- <a name="l00386"></a>00386 }
409
- <a name="l00387"></a>00387
410
- <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) {
411
- <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);
412
- <a name="l00390"></a>00390 }
413
- <a name="l00391"></a>00391
414
- <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) {
415
- <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);
416
- <a name="l00394"></a>00394 }
417
- <a name="l00395"></a>00395
418
- <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&amp;#39;t want to read data anymore from the I/O channel.">shutdownReader</a>() {
419
- <a name="l00397"></a>00397 TRACE_POINT();
420
- <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) {
421
- <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);
422
- <a name="l00400"></a>00400 <span class="keywordflow">if</span> (ret == -1) {
423
- <a name="l00401"></a>00401 <span class="keywordtype">int</span> e = errno;
424
- <a name="l00402"></a>00402 <span class="comment">// ENOTCONN is harmless here.</span>
425
- <a name="l00403"></a>00403 <span class="keywordflow">if</span> (e != ENOTCONN) {
426
- <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>,
427
- <a name="l00405"></a>00405 e);
428
- <a name="l00406"></a>00406 }
429
- <a name="l00407"></a>00407 }
430
- <a name="l00408"></a>00408 }
431
- <a name="l00409"></a>00409 }
432
- <a name="l00410"></a>00410
433
- <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&amp;#39;t want to write data anymore to the I/O channel.">shutdownWriter</a>() {
434
- <a name="l00412"></a>00412 TRACE_POINT();
435
- <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) {
436
- <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);
437
- <a name="l00415"></a>00415 <span class="keywordflow">if</span> (ret == -1) {
438
- <a name="l00416"></a>00416 <span class="keywordtype">int</span> e = errno;
439
- <a name="l00417"></a>00417 <span class="comment">// ENOTCONN is harmless here.</span>
440
- <a name="l00418"></a>00418 <span class="keywordflow">if</span> (e != ENOTCONN) {
441
- <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>,
442
- <a name="l00420"></a>00420 e);
443
- <a name="l00421"></a>00421 }
444
- <a name="l00422"></a>00422 }
445
- <a name="l00423"></a>00423 }
446
- <a name="l00424"></a>00424 }
447
- <a name="l00425"></a>00425
448
- <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>() {
449
- <a name="l00427"></a>00427 TRACE_POINT();
450
- <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) {
451
- <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>);
452
- <a name="l00430"></a>00430 <a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> = -1;
453
- <a name="l00431"></a>00431 <span class="keywordflow">if</span> (ret == -1) {
454
- <a name="l00432"></a>00432 <span class="keywordflow">if</span> (errno == EIO) {
455
- <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>,
456
- <a name="l00434"></a>00434 errno);
457
- <a name="l00435"></a>00435 } <span class="keywordflow">else</span> {
458
- <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>,
459
- <a name="l00437"></a>00437 errno);
460
- <a name="l00438"></a>00438 }
461
- <a name="l00439"></a>00439 }
462
- <a name="l00440"></a>00440 }
463
- <a name="l00441"></a>00441 }
464
- <a name="l00442"></a>00442
465
- <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&amp;#39;s file descriptor, so that the destructor won&amp;#39;t automatically...">discardStream</a>() {
466
- <a name="l00444"></a>00444 <a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> = -1;
467
- <a name="l00445"></a>00445 }
468
- <a name="l00446"></a>00446
469
- <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>{
470
- <a name="l00448"></a>00448 <span class="keywordflow">return</span> pid;
471
- <a name="l00449"></a>00449 }
472
- <a name="l00450"></a>00450 };
473
- <a name="l00451"></a>00451
474
- <a name="l00452"></a>00452
475
- <a name="l00453"></a>00453 } <span class="comment">// namespace Passenger</span>
476
- <a name="l00454"></a>00454
477
- <a name="l00455"></a>00455 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_SESSION_H_ */</span>
105
+ <a name="l00083"></a>00083 <span class="keywordtype">string</span> gupid;
106
+ <a name="l00084"></a>00084
107
+ <a name="l00085"></a>00085 <span class="keyword">public</span>:<span class="comment"></span>
108
+ <a name="l00086"></a>00086 <span class="comment"> /**</span>
109
+ <a name="l00087"></a>00087 <span class="comment"> * Concrete classes might throw arbitrary exceptions.</span>
110
+ <a name="l00088"></a>00088 <span class="comment"> */</span>
111
+ <a name="l00089"></a><a class="code" href="classPassenger_1_1Session.html#c982015e84f64dbec70daef8fdbd31d9">00089</a> <span class="keyword">virtual</span> <a class="code" href="classPassenger_1_1Session.html#c982015e84f64dbec70daef8fdbd31d9" title="Concrete classes might throw arbitrary exceptions.">~Session</a>() {}
112
+ <a name="l00090"></a>00090 <span class="comment"></span>
113
+ <a name="l00091"></a>00091 <span class="comment"> /**</span>
114
+ <a name="l00092"></a>00092 <span class="comment"> * Initiate the session by connecting to the associated process.</span>
115
+ <a name="l00093"></a>00093 <span class="comment"> * A Session is not usable until it's initiated.</span>
116
+ <a name="l00094"></a>00094 <span class="comment"> *</span>
117
+ <a name="l00095"></a>00095 <span class="comment"> * @throws SystemException Something went wrong.</span>
118
+ <a name="l00096"></a>00096 <span class="comment"> * @throws IOException Something went wrong.</span>
119
+ <a name="l00097"></a>00097 <span class="comment"> * @throws boost::thread_interrupted</span>
120
+ <a name="l00098"></a>00098 <span class="comment"> */</span>
121
+ <a name="l00099"></a>00099 <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;
122
+ <a name="l00100"></a>00100 <span class="comment"></span>
123
+ <a name="l00101"></a>00101 <span class="comment"> /**</span>
124
+ <a name="l00102"></a>00102 <span class="comment"> * Returns whether this session has been initiated (that is, whether</span>
125
+ <a name="l00103"></a>00103 <span class="comment"> * initiate() had been called in the past).</span>
126
+ <a name="l00104"></a>00104 <span class="comment"> */</span>
127
+ <a name="l00105"></a>00105 <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;
128
+ <a name="l00106"></a>00106 <span class="comment"></span>
129
+ <a name="l00107"></a>00107 <span class="comment"> /**</span>
130
+ <a name="l00108"></a>00108 <span class="comment"> * Returns the type of the socket that this session is served from,</span>
131
+ <a name="l00109"></a>00109 <span class="comment"> * e.g. "unix" indicating a Unix socket.</span>
132
+ <a name="l00110"></a>00110 <span class="comment"> *</span>
133
+ <a name="l00111"></a>00111 <span class="comment"> * @post !result.empty()</span>
134
+ <a name="l00112"></a>00112 <span class="comment"> */</span>
135
+ <a name="l00113"></a>00113 <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;
136
+ <a name="l00114"></a>00114 <span class="comment"></span>
137
+ <a name="l00115"></a>00115 <span class="comment"> /**</span>
138
+ <a name="l00116"></a>00116 <span class="comment"> * Returns the address of the socket that this session is served</span>
139
+ <a name="l00117"></a>00117 <span class="comment"> * from. This can be a Unix socket filename or a TCP host:port string</span>
140
+ <a name="l00118"></a>00118 <span class="comment"> * like "127.0.0.1:1234".</span>
141
+ <a name="l00119"></a>00119 <span class="comment"> *</span>
142
+ <a name="l00120"></a>00120 <span class="comment"> * @post !result.empty()</span>
143
+ <a name="l00121"></a>00121 <span class="comment"> */</span>
144
+ <a name="l00122"></a>00122 <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;
145
+ <a name="l00123"></a>00123 <span class="comment"></span>
146
+ <a name="l00124"></a>00124 <span class="comment"> /**</span>
147
+ <a name="l00125"></a>00125 <span class="comment"> * Send HTTP request headers to the application. The HTTP headers must be</span>
148
+ <a name="l00126"></a>00126 <span class="comment"> * converted into CGI headers, and then encoded into a string that matches this grammar:</span>
149
+ <a name="l00127"></a>00127 <span class="comment"> *</span>
150
+ <a name="l00128"></a>00128 <span class="comment"> @verbatim</span>
151
+ <a name="l00129"></a>00129 <span class="comment"> headers ::= header*</span>
152
+ <a name="l00130"></a>00130 <span class="comment"> header ::= name NUL value NUL</span>
153
+ <a name="l00131"></a>00131 <span class="comment"> name ::= notnull+</span>
154
+ <a name="l00132"></a>00132 <span class="comment"> value ::= notnull+</span>
155
+ <a name="l00133"></a>00133 <span class="comment"> notnull ::= "\x01" | "\x02" | "\x02" | ... | "\xFF"</span>
156
+ <a name="l00134"></a>00134 <span class="comment"> NUL = "\x00"</span>
157
+ <a name="l00135"></a>00135 <span class="comment"> @endverbatim</span>
158
+ <a name="l00136"></a>00136 <span class="comment"> *</span>
159
+ <a name="l00137"></a>00137 <span class="comment"> * There must be a header with the name "PASSWORD_CONNECT_PASSWORD", and it must</span>
160
+ <a name="l00138"></a>00138 <span class="comment"> * have the same value as the string returned by getConnectPassword().</span>
161
+ <a name="l00139"></a>00139 <span class="comment"> *</span>
162
+ <a name="l00140"></a>00140 <span class="comment"> * This method should be the first one to be called during the lifetime of a Session</span>
163
+ <a name="l00141"></a>00141 <span class="comment"> * object, otherwise strange things may happen.</span>
164
+ <a name="l00142"></a>00142 <span class="comment"> *</span>
165
+ <a name="l00143"></a>00143 <span class="comment"> * @param headers The HTTP request headers, converted into CGI headers and encoded as</span>
166
+ <a name="l00144"></a>00144 <span class="comment"> * a string, according to the description.</span>
167
+ <a name="l00145"></a>00145 <span class="comment"> * @param size The size, in bytes, of &lt;tt&gt;headers&lt;/tt&gt;.</span>
168
+ <a name="l00146"></a>00146 <span class="comment"> * @pre headers != NULL</span>
169
+ <a name="l00147"></a>00147 <span class="comment"> * @pre initiated()</span>
170
+ <a name="l00148"></a>00148 <span class="comment"> * @throws IOException The I/O channel has already been closed or discarded.</span>
171
+ <a name="l00149"></a>00149 <span class="comment"> * @throws SystemException Something went wrong during writing.</span>
172
+ <a name="l00150"></a>00150 <span class="comment"> * @throws boost::thread_interrupted</span>
173
+ <a name="l00151"></a>00151 <span class="comment"> */</span>
174
+ <a name="l00152"></a><a class="code" href="classPassenger_1_1Session.html#8f8a39f78dd2672b00f1ff01e4d6d671">00152</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) {
175
+ <a name="l00153"></a>00153 TRACE_POINT();
176
+ <a name="l00154"></a>00154 <span class="keywordtype">int</span> stream = <a class="code" href="classPassenger_1_1Session.html#949c7a46f4bb0c628730ded2041d2489" title="Returns this session&amp;#39;s channel&amp;#39;s file descriptor.">getStream</a>();
177
+ <a name="l00155"></a>00155 <span class="keywordflow">if</span> (stream == -1) {
178
+ <a name="l00156"></a>00156 <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>
179
+ <a name="l00157"></a>00157 <span class="stringliteral">"because the I/O stream has already been closed or discarded."</span>);
180
+ <a name="l00158"></a>00158 }
181
+ <a name="l00159"></a>00159 <span class="keywordflow">try</span> {
182
+ <a name="l00160"></a>00160 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(stream).writeScalar(headers, size);
183
+ <a name="l00161"></a>00161 } <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> &amp;e) {
184
+ <a name="l00162"></a>00162 e.<a class="code" href="classPassenger_1_1SystemException.html#6fc359f27a084158b7111ef35bec114f">setBriefMessage</a>(<span class="stringliteral">"An error occured while writing headers "</span>
185
+ <a name="l00163"></a>00163 <span class="stringliteral">"to the request handler"</span>);
186
+ <a name="l00164"></a>00164 <span class="keywordflow">throw</span>;
187
+ <a name="l00165"></a>00165 }
188
+ <a name="l00166"></a>00166 }
189
+ <a name="l00167"></a>00167 <span class="comment"></span>
190
+ <a name="l00168"></a>00168 <span class="comment"> /**</span>
191
+ <a name="l00169"></a>00169 <span class="comment"> * Convenience shortcut for sendHeaders(const char *, unsigned int)</span>
192
+ <a name="l00170"></a>00170 <span class="comment"> * @param headers The headers</span>
193
+ <a name="l00171"></a>00171 <span class="comment"> * @pre initiated()</span>
194
+ <a name="l00172"></a>00172 <span class="comment"> * @throws IOException The I/O channel has already been closed or discarded.</span>
195
+ <a name="l00173"></a>00173 <span class="comment"> * @throws SystemException Something went wrong during writing.</span>
196
+ <a name="l00174"></a>00174 <span class="comment"> * @throws boost::thread_interrupted</span>
197
+ <a name="l00175"></a>00175 <span class="comment"> */</span>
198
+ <a name="l00176"></a><a class="code" href="classPassenger_1_1Session.html#8253d81e64adc0dc72b1dc65a5117aba">00176</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> &amp;headers) {
199
+ <a name="l00177"></a>00177 <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>());
200
+ <a name="l00178"></a>00178 }
201
+ <a name="l00179"></a>00179 <span class="comment"></span>
202
+ <a name="l00180"></a>00180 <span class="comment"> /**</span>
203
+ <a name="l00181"></a>00181 <span class="comment"> * Send a chunk of HTTP request body data to the application.</span>
204
+ <a name="l00182"></a>00182 <span class="comment"> * You can call this method as many times as is required to transfer</span>
205
+ <a name="l00183"></a>00183 <span class="comment"> * the entire HTTP request body.</span>
206
+ <a name="l00184"></a>00184 <span class="comment"> *</span>
207
+ <a name="l00185"></a>00185 <span class="comment"> * This method must only be called after a sendHeaders(), otherwise</span>
208
+ <a name="l00186"></a>00186 <span class="comment"> * strange things may happen.</span>
209
+ <a name="l00187"></a>00187 <span class="comment"> *</span>
210
+ <a name="l00188"></a>00188 <span class="comment"> * @param block A block of HTTP request body data to send.</span>
211
+ <a name="l00189"></a>00189 <span class="comment"> * @param size The size, in bytes, of &lt;tt&gt;block&lt;/tt&gt;.</span>
212
+ <a name="l00190"></a>00190 <span class="comment"> * @pre initiated()</span>
213
+ <a name="l00191"></a>00191 <span class="comment"> * @throws IOException The I/O channel has already been closed or discarded.</span>
214
+ <a name="l00192"></a>00192 <span class="comment"> * @throws SystemException Something went wrong during writing.</span>
215
+ <a name="l00193"></a>00193 <span class="comment"> * @throws boost::thread_interrupted</span>
216
+ <a name="l00194"></a>00194 <span class="comment"> */</span>
217
+ <a name="l00195"></a><a class="code" href="classPassenger_1_1Session.html#2203d81e25fe5066aed351608deecf7b">00195</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) {
218
+ <a name="l00196"></a>00196 TRACE_POINT();
219
+ <a name="l00197"></a>00197 <span class="keywordtype">int</span> stream = <a class="code" href="classPassenger_1_1Session.html#949c7a46f4bb0c628730ded2041d2489" title="Returns this session&amp;#39;s channel&amp;#39;s file descriptor.">getStream</a>();
220
+ <a name="l00198"></a>00198 <span class="keywordflow">if</span> (stream == -1) {
221
+ <a name="l00199"></a>00199 <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>
222
+ <a name="l00200"></a>00200 <span class="stringliteral">"request handler because the I/O channel has "</span>
223
+ <a name="l00201"></a>00201 <span class="stringliteral">"already been closed or discarded."</span>);
224
+ <a name="l00202"></a>00202 }
225
+ <a name="l00203"></a>00203 <span class="keywordflow">try</span> {
226
+ <a name="l00204"></a>00204 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(stream).writeRaw(block, size);
227
+ <a name="l00205"></a>00205 } <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> &amp;e) {
228
+ <a name="l00206"></a>00206 e.<a class="code" href="classPassenger_1_1SystemException.html#6fc359f27a084158b7111ef35bec114f">setBriefMessage</a>(<span class="stringliteral">"An error occured while sending the "</span>
229
+ <a name="l00207"></a>00207 <span class="stringliteral">"request body to the request handler"</span>);
230
+ <a name="l00208"></a>00208 <span class="keywordflow">throw</span>;
231
+ <a name="l00209"></a>00209 }
232
+ <a name="l00210"></a>00210 }
233
+ <a name="l00211"></a>00211 <span class="comment"></span>
234
+ <a name="l00212"></a>00212 <span class="comment"> /**</span>
235
+ <a name="l00213"></a>00213 <span class="comment"> * Returns this session's channel's file descriptor. This stream is</span>
236
+ <a name="l00214"></a>00214 <span class="comment"> * full-duplex, and will be automatically closed upon Session's</span>
237
+ <a name="l00215"></a>00215 <span class="comment"> * destruction, unless discardStream() is called.</span>
238
+ <a name="l00216"></a>00216 <span class="comment"> *</span>
239
+ <a name="l00217"></a>00217 <span class="comment"> * @pre initiated()</span>
240
+ <a name="l00218"></a>00218 <span class="comment"> * @returns The file descriptor, or -1 if the I/O channel has already</span>
241
+ <a name="l00219"></a>00219 <span class="comment"> * been closed or discarded.</span>
242
+ <a name="l00220"></a>00220 <span class="comment"> */</span>
243
+ <a name="l00221"></a>00221 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1Session.html#949c7a46f4bb0c628730ded2041d2489" title="Returns this session&amp;#39;s channel&amp;#39;s file descriptor.">getStream</a>() <span class="keyword">const</span> = 0;
244
+ <a name="l00222"></a>00222 <span class="comment"></span>
245
+ <a name="l00223"></a>00223 <span class="comment"> /**</span>
246
+ <a name="l00224"></a>00224 <span class="comment"> * Set the timeout value for reading data from the I/O channel.</span>
247
+ <a name="l00225"></a>00225 <span class="comment"> * If no data can be read within the timeout period, then the</span>
248
+ <a name="l00226"></a>00226 <span class="comment"> * read call will fail with error EAGAIN or EWOULDBLOCK.</span>
249
+ <a name="l00227"></a>00227 <span class="comment"> *</span>
250
+ <a name="l00228"></a>00228 <span class="comment"> * @pre The I/O channel hasn't been closed or discarded.</span>
251
+ <a name="l00229"></a>00229 <span class="comment"> * @pre initiated()</span>
252
+ <a name="l00230"></a>00230 <span class="comment"> * @param msec The timeout, in milliseconds. If 0 is given,</span>
253
+ <a name="l00231"></a>00231 <span class="comment"> * there will be no timeout.</span>
254
+ <a name="l00232"></a>00232 <span class="comment"> * @throws SystemException Cannot set the timeout.</span>
255
+ <a name="l00233"></a>00233 <span class="comment"> */</span>
256
+ <a name="l00234"></a>00234 <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;
257
+ <a name="l00235"></a>00235 <span class="comment"></span>
258
+ <a name="l00236"></a>00236 <span class="comment"> /**</span>
259
+ <a name="l00237"></a>00237 <span class="comment"> * Set the timeout value for writing data from the I/O channel.</span>
260
+ <a name="l00238"></a>00238 <span class="comment"> * If no data can be written within the timeout period, then the</span>
261
+ <a name="l00239"></a>00239 <span class="comment"> * write call will fail with error EAGAIN or EWOULDBLOCK.</span>
262
+ <a name="l00240"></a>00240 <span class="comment"> *</span>
263
+ <a name="l00241"></a>00241 <span class="comment"> * @pre The I/O channel hasn't been closed or discarded.</span>
264
+ <a name="l00242"></a>00242 <span class="comment"> * @pre initiated()</span>
265
+ <a name="l00243"></a>00243 <span class="comment"> * @param msec The timeout, in milliseconds. If 0 is given,</span>
266
+ <a name="l00244"></a>00244 <span class="comment"> * there will be no timeout.</span>
267
+ <a name="l00245"></a>00245 <span class="comment"> * @throws SystemException Cannot set the timeout.</span>
268
+ <a name="l00246"></a>00246 <span class="comment"> */</span>
269
+ <a name="l00247"></a>00247 <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;
270
+ <a name="l00248"></a>00248 <span class="comment"></span>
271
+ <a name="l00249"></a>00249 <span class="comment"> /**</span>
272
+ <a name="l00250"></a>00250 <span class="comment"> * Indicate that we don't want to read data anymore from the I/O channel.</span>
273
+ <a name="l00251"></a>00251 <span class="comment"> * Calling this method after closeStream()/discardStream() is called will</span>
274
+ <a name="l00252"></a>00252 <span class="comment"> * have no effect.</span>
275
+ <a name="l00253"></a>00253 <span class="comment"> *</span>
276
+ <a name="l00254"></a>00254 <span class="comment"> * @pre initiated()</span>
277
+ <a name="l00255"></a>00255 <span class="comment"> * @throws SystemException Something went wrong.</span>
278
+ <a name="l00256"></a>00256 <span class="comment"> * @throws boost::thread_interrupted</span>
279
+ <a name="l00257"></a>00257 <span class="comment"> */</span>
280
+ <a name="l00258"></a>00258 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#c579d233ddc82542c336b2af1f40c4dd" title="Indicate that we don&amp;#39;t want to read data anymore from the I/O channel.">shutdownReader</a>() = 0;
281
+ <a name="l00259"></a>00259 <span class="comment"></span>
282
+ <a name="l00260"></a>00260 <span class="comment"> /**</span>
283
+ <a name="l00261"></a>00261 <span class="comment"> * Indicate that we don't want to write data anymore to the I/O channel.</span>
284
+ <a name="l00262"></a>00262 <span class="comment"> * Calling this method after closeStream()/discardStream() is called will</span>
285
+ <a name="l00263"></a>00263 <span class="comment"> * have no effect.</span>
286
+ <a name="l00264"></a>00264 <span class="comment"> *</span>
287
+ <a name="l00265"></a>00265 <span class="comment"> * @pre initiated()</span>
288
+ <a name="l00266"></a>00266 <span class="comment"> * @throws SystemException Something went wrong.</span>
289
+ <a name="l00267"></a>00267 <span class="comment"> * @throws boost::thread_interrupted</span>
290
+ <a name="l00268"></a>00268 <span class="comment"> */</span>
291
+ <a name="l00269"></a>00269 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Session.html#8263c568a8ac4567b33728d820cbd920" title="Indicate that we don&amp;#39;t want to write data anymore to the I/O channel.">shutdownWriter</a>() = 0;
292
+ <a name="l00270"></a>00270 <span class="comment"></span>
293
+ <a name="l00271"></a>00271 <span class="comment"> /**</span>
294
+ <a name="l00272"></a>00272 <span class="comment"> * Close the I/O stream.</span>
295
+ <a name="l00273"></a>00273 <span class="comment"> *</span>
296
+ <a name="l00274"></a>00274 <span class="comment"> * @throws SystemException Something went wrong.</span>
297
+ <a name="l00275"></a>00275 <span class="comment"> * @throws boost::thread_interrupted</span>
298
+ <a name="l00276"></a>00276 <span class="comment"> * @pre initiated()</span>
299
+ <a name="l00277"></a>00277 <span class="comment"> * @post getStream() == -1</span>
300
+ <a name="l00278"></a>00278 <span class="comment"> */</span>
301
+ <a name="l00279"></a>00279 <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;
302
+ <a name="l00280"></a>00280 <span class="comment"></span>
303
+ <a name="l00281"></a>00281 <span class="comment"> /**</span>
304
+ <a name="l00282"></a>00282 <span class="comment"> * Discard the I/O channel's file descriptor, so that the destructor</span>
305
+ <a name="l00283"></a>00283 <span class="comment"> * won't automatically close it.</span>
306
+ <a name="l00284"></a>00284 <span class="comment"> *</span>
307
+ <a name="l00285"></a>00285 <span class="comment"> * @pre initiated()</span>
308
+ <a name="l00286"></a>00286 <span class="comment"> * @post getStream() == -1</span>
309
+ <a name="l00287"></a>00287 <span class="comment"> */</span>
310
+ <a name="l00288"></a>00288 <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&amp;#39;s file descriptor, so that the destructor won&amp;#39;t automatically...">discardStream</a>() = 0;
311
+ <a name="l00289"></a>00289 <span class="comment"></span>
312
+ <a name="l00290"></a>00290 <span class="comment"> /**</span>
313
+ <a name="l00291"></a>00291 <span class="comment"> * Get the process ID of the application process that this session</span>
314
+ <a name="l00292"></a>00292 <span class="comment"> * belongs to.</span>
315
+ <a name="l00293"></a>00293 <span class="comment"> */</span>
316
+ <a name="l00294"></a>00294 <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;
317
+ <a name="l00295"></a>00295
318
+ <a name="l00296"></a>00296 <span class="keyword">const</span> <span class="keywordtype">string</span> getDetachKey()<span class="keyword"> const </span>{
319
+ <a name="l00297"></a>00297 <span class="keywordflow">return</span> detachKey;
320
+ <a name="l00298"></a>00298 }
321
+ <a name="l00299"></a>00299 <span class="comment"></span>
322
+ <a name="l00300"></a>00300 <span class="comment"> /**</span>
323
+ <a name="l00301"></a>00301 <span class="comment"> * Returns this session's process's connect password. This password is</span>
324
+ <a name="l00302"></a>00302 <span class="comment"> * guaranteed to be valid ASCII.</span>
325
+ <a name="l00303"></a>00303 <span class="comment"> */</span>
326
+ <a name="l00304"></a><a class="code" href="classPassenger_1_1Session.html#eaf4f7097f7b3430dc88e8070cad5899">00304</a> <span class="keyword">const</span> <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1Session.html#eaf4f7097f7b3430dc88e8070cad5899" title="Returns this session&amp;#39;s process&amp;#39;s connect password.">getConnectPassword</a>()<span class="keyword"> const </span>{
327
+ <a name="l00305"></a>00305 <span class="keywordflow">return</span> connectPassword;
328
+ <a name="l00306"></a>00306 }
329
+ <a name="l00307"></a>00307
330
+ <a name="l00308"></a>00308 <span class="keyword">const</span> <span class="keywordtype">string</span> getGupid()<span class="keyword"> const </span>{
331
+ <a name="l00309"></a>00309 <span class="keywordflow">return</span> gupid;
332
+ <a name="l00310"></a>00310 }
333
+ <a name="l00311"></a>00311 };
334
+ <a name="l00312"></a>00312
335
+ <a name="l00313"></a>00313 <span class="keyword">typedef</span> shared_ptr&lt;Session&gt; SessionPtr;
336
+ <a name="l00314"></a>00314
337
+ <a name="l00315"></a>00315 <span class="comment"></span>
338
+ <a name="l00316"></a>00316 <span class="comment">/**</span>
339
+ <a name="l00317"></a>00317 <span class="comment"> * A "standard" implementation of Session.</span>
340
+ <a name="l00318"></a>00318 <span class="comment"> */</span>
341
+ <a name="l00319"></a><a class="code" href="classPassenger_1_1StandardSession.html">00319</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1StandardSession.html" title="A &amp;quot;standard&amp;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> {
342
+ <a name="l00320"></a>00320 <span class="keyword">public</span>:
343
+ <a name="l00321"></a>00321 <span class="keyword">typedef</span> function&lt;void (const StandardSession *)&gt; CloseCallback;
344
+ <a name="l00322"></a>00322
345
+ <a name="l00323"></a>00323 <span class="keyword">protected</span>:
346
+ <a name="l00324"></a>00324 pid_t pid;
347
+ <a name="l00325"></a>00325 CloseCallback closeCallback;
348
+ <a name="l00326"></a>00326 <span class="keywordtype">string</span> socketType;
349
+ <a name="l00327"></a>00327 <span class="keywordtype">string</span> socketName;
350
+ <a name="l00328"></a>00328 <span class="comment"></span>
351
+ <a name="l00329"></a>00329 <span class="comment"> /** The session connection file descriptor. */</span>
352
+ <a name="l00330"></a><a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9">00330</a> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a>;
353
+ <a name="l00331"></a>00331 <span class="keywordtype">bool</span> isInitiated;
354
+ <a name="l00332"></a>00332
355
+ <a name="l00333"></a>00333 <span class="keyword">public</span>:
356
+ <a name="l00334"></a>00334 <a class="code" href="classPassenger_1_1StandardSession.html" title="A &amp;quot;standard&amp;quot; implementation of Session.">StandardSession</a>(pid_t pid,
357
+ <a name="l00335"></a>00335 <span class="keyword">const</span> CloseCallback &amp;closeCallback,
358
+ <a name="l00336"></a>00336 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;socketType,
359
+ <a name="l00337"></a>00337 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;socketName,
360
+ <a name="l00338"></a>00338 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;detachKey,
361
+ <a name="l00339"></a>00339 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;connectPassword,
362
+ <a name="l00340"></a>00340 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;gupid)
363
+ <a name="l00341"></a>00341 {
364
+ <a name="l00342"></a>00342 TRACE_POINT();
365
+ <a name="l00343"></a>00343 <span class="keywordflow">if</span> (socketType != <span class="stringliteral">"unix"</span> &amp;&amp; socketType != <span class="stringliteral">"tcp"</span>) {
366
+ <a name="l00344"></a>00344 <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>);
367
+ <a name="l00345"></a>00345 }
368
+ <a name="l00346"></a>00346 this-&gt;pid = pid;
369
+ <a name="l00347"></a>00347 this-&gt;closeCallback = closeCallback;
370
+ <a name="l00348"></a>00348 this-&gt;socketType = socketType;
371
+ <a name="l00349"></a>00349 this-&gt;socketName = socketName;
372
+ <a name="l00350"></a>00350 this-&gt;detachKey = detachKey;
373
+ <a name="l00351"></a>00351 this-&gt;connectPassword = connectPassword;
374
+ <a name="l00352"></a>00352 this-&gt;gupid = gupid;
375
+ <a name="l00353"></a>00353 <a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> = -1;
376
+ <a name="l00354"></a>00354 isInitiated = <span class="keyword">false</span>;
377
+ <a name="l00355"></a>00355 }
378
+ <a name="l00356"></a>00356
379
+ <a name="l00357"></a>00357 <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1StandardSession.html" title="A &amp;quot;standard&amp;quot; implementation of Session.">StandardSession</a>() {
380
+ <a name="l00358"></a>00358 TRACE_POINT();
381
+ <a name="l00359"></a>00359 <a class="code" href="classPassenger_1_1StandardSession.html#f5cdfa78db1fca6303ccd43ac5126b6b" title="Close the I/O stream.">closeStream</a>();
382
+ <a name="l00360"></a>00360 <span class="keywordflow">if</span> (closeCallback != NULL) {
383
+ <a name="l00361"></a>00361 closeCallback(<span class="keyword">this</span>);
384
+ <a name="l00362"></a>00362 }
385
+ <a name="l00363"></a>00363 }
386
+ <a name="l00364"></a>00364
387
+ <a name="l00365"></a><a class="code" href="classPassenger_1_1StandardSession.html#c283db6faf2fcd1827baf3ebac276677">00365</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>() {
388
+ <a name="l00366"></a>00366 TRACE_POINT();
389
+ <a name="l00367"></a>00367 <span class="keywordflow">if</span> (socketType == <span class="stringliteral">"unix"</span>) {
390
+ <a name="l00368"></a>00368 <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());
391
+ <a name="l00369"></a>00369 } <span class="keywordflow">else</span> {
392
+ <a name="l00370"></a>00370 vector&lt;string&gt; args;
393
+ <a name="l00371"></a>00371
394
+ <a name="l00372"></a>00372 <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);
395
+ <a name="l00373"></a>00373 <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) {
396
+ <a name="l00374"></a>00374 UPDATE_TRACE_POINT();
397
+ <a name="l00375"></a>00375 <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>);
398
+ <a name="l00376"></a>00376 }
399
+ <a name="l00377"></a>00377 <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]));
400
+ <a name="l00378"></a>00378 }
401
+ <a name="l00379"></a>00379 isInitiated = <span class="keyword">true</span>;
402
+ <a name="l00380"></a>00380 }
403
+ <a name="l00381"></a>00381
404
+ <a name="l00382"></a><a class="code" href="classPassenger_1_1StandardSession.html#40cdaad38dfbb7995955f11bb27bba61">00382</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>{
405
+ <a name="l00383"></a>00383 <span class="keywordflow">return</span> isInitiated;
406
+ <a name="l00384"></a>00384 }
407
+ <a name="l00385"></a>00385
408
+ <a name="l00386"></a><a class="code" href="classPassenger_1_1StandardSession.html#3a59997280d5f7fcaa901716cd8451a2">00386</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>{
409
+ <a name="l00387"></a>00387 <span class="keywordflow">return</span> socketType;
410
+ <a name="l00388"></a>00388 }
411
+ <a name="l00389"></a>00389
412
+ <a name="l00390"></a><a class="code" href="classPassenger_1_1StandardSession.html#720e98b8dd246eeca004c8e625c0d4d3">00390</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>{
413
+ <a name="l00391"></a>00391 <span class="keywordflow">return</span> socketName;
414
+ <a name="l00392"></a>00392 }
415
+ <a name="l00393"></a>00393
416
+ <a name="l00394"></a><a class="code" href="classPassenger_1_1StandardSession.html#a3491d2151ba3b94c1b19a4f18bade6a">00394</a> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1StandardSession.html#a3491d2151ba3b94c1b19a4f18bade6a" title="Returns this session&amp;#39;s channel&amp;#39;s file descriptor.">getStream</a>()<span class="keyword"> const </span>{
417
+ <a name="l00395"></a>00395 <span class="keywordflow">return</span> <a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a>;
418
+ <a name="l00396"></a>00396 }
419
+ <a name="l00397"></a>00397
420
+ <a name="l00398"></a><a class="code" href="classPassenger_1_1StandardSession.html#960346d8c27ff1ae9017d753e41a159a">00398</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) {
421
+ <a name="l00399"></a>00399 <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);
422
+ <a name="l00400"></a>00400 }
423
+ <a name="l00401"></a>00401
424
+ <a name="l00402"></a><a class="code" href="classPassenger_1_1StandardSession.html#bb51c323ac0e24011191862f6dec7a75">00402</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) {
425
+ <a name="l00403"></a>00403 <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);
426
+ <a name="l00404"></a>00404 }
427
+ <a name="l00405"></a>00405
428
+ <a name="l00406"></a><a class="code" href="classPassenger_1_1StandardSession.html#c92d4d081d6145ba8d441c8cf88fae74">00406</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&amp;#39;t want to read data anymore from the I/O channel.">shutdownReader</a>() {
429
+ <a name="l00407"></a>00407 TRACE_POINT();
430
+ <a name="l00408"></a>00408 <span class="keywordflow">if</span> (<a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> != -1) {
431
+ <a name="l00409"></a>00409 <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);
432
+ <a name="l00410"></a>00410 <span class="keywordflow">if</span> (ret == -1) {
433
+ <a name="l00411"></a>00411 <span class="keywordtype">int</span> e = errno;
434
+ <a name="l00412"></a>00412 <span class="comment">// ENOTCONN is harmless here.</span>
435
+ <a name="l00413"></a>00413 <span class="keywordflow">if</span> (e != ENOTCONN) {
436
+ <a name="l00414"></a>00414 <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>,
437
+ <a name="l00415"></a>00415 e);
438
+ <a name="l00416"></a>00416 }
439
+ <a name="l00417"></a>00417 }
440
+ <a name="l00418"></a>00418 }
441
+ <a name="l00419"></a>00419 }
442
+ <a name="l00420"></a>00420
443
+ <a name="l00421"></a><a class="code" href="classPassenger_1_1StandardSession.html#045a8f7f849c34086b0832fdba7a2915">00421</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&amp;#39;t want to write data anymore to the I/O channel.">shutdownWriter</a>() {
444
+ <a name="l00422"></a>00422 TRACE_POINT();
445
+ <a name="l00423"></a>00423 <span class="keywordflow">if</span> (<a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> != -1) {
446
+ <a name="l00424"></a>00424 <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);
447
+ <a name="l00425"></a>00425 <span class="keywordflow">if</span> (ret == -1) {
448
+ <a name="l00426"></a>00426 <span class="keywordtype">int</span> e = errno;
449
+ <a name="l00427"></a>00427 <span class="comment">// ENOTCONN is harmless here.</span>
450
+ <a name="l00428"></a>00428 <span class="keywordflow">if</span> (e != ENOTCONN) {
451
+ <a name="l00429"></a>00429 <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>,
452
+ <a name="l00430"></a>00430 e);
453
+ <a name="l00431"></a>00431 }
454
+ <a name="l00432"></a>00432 }
455
+ <a name="l00433"></a>00433 }
456
+ <a name="l00434"></a>00434 }
457
+ <a name="l00435"></a>00435
458
+ <a name="l00436"></a><a class="code" href="classPassenger_1_1StandardSession.html#f5cdfa78db1fca6303ccd43ac5126b6b">00436</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>() {
459
+ <a name="l00437"></a>00437 TRACE_POINT();
460
+ <a name="l00438"></a>00438 <span class="keywordflow">if</span> (<a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> != -1) {
461
+ <a name="l00439"></a>00439 <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>);
462
+ <a name="l00440"></a>00440 <a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> = -1;
463
+ <a name="l00441"></a>00441 <span class="keywordflow">if</span> (ret == -1) {
464
+ <a name="l00442"></a>00442 <span class="keywordtype">int</span> e = errno;
465
+ <a name="l00443"></a>00443 <span class="keywordflow">if</span> (errno == EIO) {
466
+ <a name="l00444"></a>00444 <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>(
467
+ <a name="l00445"></a>00445 <span class="stringliteral">"A write operation on the session stream failed"</span>,
468
+ <a name="l00446"></a>00446 e);
469
+ <a name="l00447"></a>00447 } <span class="keywordflow">else</span> {
470
+ <a name="l00448"></a>00448 <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>(
471
+ <a name="l00449"></a>00449 <span class="stringliteral">"Cannot close the session stream"</span>,
472
+ <a name="l00450"></a>00450 e);
473
+ <a name="l00451"></a>00451 }
474
+ <a name="l00452"></a>00452 }
475
+ <a name="l00453"></a>00453 }
476
+ <a name="l00454"></a>00454 }
477
+ <a name="l00455"></a>00455
478
+ <a name="l00456"></a><a class="code" href="classPassenger_1_1StandardSession.html#3666d401df82696fe945fcbb66804785">00456</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&amp;#39;s file descriptor, so that the destructor won&amp;#39;t automatically...">discardStream</a>() {
479
+ <a name="l00457"></a>00457 <a class="code" href="classPassenger_1_1StandardSession.html#51d4e04acc68526a450b1fce2142dea9" title="The session connection file descriptor.">fd</a> = -1;
480
+ <a name="l00458"></a>00458 }
481
+ <a name="l00459"></a>00459
482
+ <a name="l00460"></a><a class="code" href="classPassenger_1_1StandardSession.html#496bbb49ac5f8d86ac6c37e979e7e3e8">00460</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>{
483
+ <a name="l00461"></a>00461 <span class="keywordflow">return</span> pid;
484
+ <a name="l00462"></a>00462 }
485
+ <a name="l00463"></a>00463 };
486
+ <a name="l00464"></a>00464
487
+ <a name="l00465"></a>00465
488
+ <a name="l00466"></a>00466 } <span class="comment">// namespace Passenger</span>
489
+ <a name="l00467"></a>00467
490
+ <a name="l00468"></a>00468 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_SESSION_H_ */</span>
478
491
  </pre></div></div>
479
- <hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:46 2010 for Passenger by&nbsp;
492
+ <hr size="1"><address style="text-align: right;"><small>Generated on Sun Mar 28 14:11:56 2010 for Passenger by&nbsp;
480
493
  <a href="http://www.doxygen.org/index.html">
481
494
  <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
482
495
  </body>