passenger 3.0.0 → 3.0.1

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 (538) hide show
  1. data/DEVELOPERS.TXT +9 -6
  2. data/NEWS +50 -0
  3. data/Rakefile +2 -1
  4. data/bin/passenger-install-apache2-module +4 -4
  5. data/bin/passenger-install-nginx-module +1 -1
  6. data/bin/passenger-make-enterprisey +1 -1
  7. data/build/agents.rb +26 -19
  8. data/build/apache2.rb +49 -46
  9. data/build/basics.rb +37 -13
  10. data/build/common_library.rb +134 -64
  11. data/build/config.rb +18 -11
  12. data/build/cplusplus_support.rb +4 -0
  13. data/build/cxx_tests.rb +26 -12
  14. data/build/documentation.rb +18 -11
  15. data/build/integration_tests.rb +18 -11
  16. data/build/misc.rb +18 -11
  17. data/build/nginx.rb +27 -19
  18. data/build/oxt_tests.rb +18 -11
  19. data/build/packaging.rb +45 -37
  20. data/build/rpm.rb +98 -0
  21. data/build/ruby_extension.rb +19 -13
  22. data/build/ruby_tests.rb +19 -12
  23. data/build/test_basics.rb +23 -11
  24. data/debian/README.Debian +15 -0
  25. data/debian/changelog +185 -0
  26. data/debian/control +47 -19
  27. data/debian/copyright +20 -0
  28. data/debian/libapache2-mod-passenger.install +1 -0
  29. data/debian/libapache2-mod-passenger.postinst +36 -0
  30. data/debian/libapache2-mod-passenger.prerm +15 -0
  31. data/debian/passenger-common.install +4 -0
  32. data/debian/passenger.conf +4 -0
  33. data/debian/passenger.load +1 -0
  34. data/debian/rules +37 -0
  35. data/debian/watch +3 -0
  36. data/{misc → dev}/copy_boost_headers.rb +3 -0
  37. data/{misc → dev}/find_owner_pipe_leaks.rb +0 -0
  38. data/{misc → dev}/render_error_pages.rb +0 -0
  39. data/doc/Users guide Apache.html +39 -1
  40. data/doc/Users guide Apache.txt +40 -0
  41. data/doc/Users guide Nginx.html +1 -1
  42. data/doc/Users guide Standalone.html +1 -1
  43. data/doc/cxxapi/Constants_8h_source.html +1 -1
  44. data/doc/cxxapi/DirectoryMapper_8h_source.html +6 -22
  45. data/doc/cxxapi/EventedClient_8h_source.html +572 -468
  46. data/doc/cxxapi/Exceptions_8h_source.html +142 -129
  47. data/doc/cxxapi/FileDescriptor_8h_source.html +263 -199
  48. data/doc/cxxapi/MessageChannel_8h_source.html +686 -770
  49. data/doc/cxxapi/MessageServer_8h_source.html +1 -1
  50. data/doc/cxxapi/PoolOptions_8h_source.html +79 -78
  51. data/doc/cxxapi/ResourceLocator_8h_source.html +105 -55
  52. data/doc/cxxapi/SafeLibev_8h_source.html +180 -0
  53. data/doc/cxxapi/ServerInstanceDir_8h_source.html +114 -110
  54. data/doc/cxxapi/Session_8h_source.html +1 -1
  55. data/doc/cxxapi/SpawnManager_8h_source.html +208 -208
  56. data/doc/cxxapi/StaticString_8h_source.html +258 -183
  57. data/doc/cxxapi/Utils_8h_source.html +71 -54
  58. data/doc/cxxapi/annotated.html +3 -0
  59. data/doc/cxxapi/classAgentWatcher.html +2 -2
  60. data/doc/cxxapi/classPassenger_1_1DirectoryMapper-members.html +0 -1
  61. data/doc/cxxapi/classPassenger_1_1DirectoryMapper.html +0 -27
  62. data/doc/cxxapi/classPassenger_1_1EventedClient-members.html +5 -0
  63. data/doc/cxxapi/classPassenger_1_1EventedClient.html +102 -7
  64. data/doc/cxxapi/classPassenger_1_1FileDescriptor-members.html +2 -1
  65. data/doc/cxxapi/classPassenger_1_1FileDescriptor.html +34 -8
  66. data/doc/cxxapi/classPassenger_1_1FileDescriptorPair-members.html +36 -0
  67. data/doc/cxxapi/classPassenger_1_1FileDescriptorPair.html +52 -0
  68. data/doc/cxxapi/classPassenger_1_1MessageChannel-members.html +0 -3
  69. data/doc/cxxapi/classPassenger_1_1MessageChannel.html +0 -120
  70. data/doc/cxxapi/classPassenger_1_1SafeLibev-members.html +36 -0
  71. data/doc/cxxapi/classPassenger_1_1SafeLibev.html +51 -0
  72. data/doc/cxxapi/classPassenger_1_1SpawnException-members.html +1 -0
  73. data/doc/cxxapi/classPassenger_1_1SpawnException.html +22 -0
  74. data/doc/cxxapi/classes.html +14 -14
  75. data/doc/cxxapi/files.html +2 -0
  76. data/doc/cxxapi/functions_0x63.html +6 -3
  77. data/doc/cxxapi/functions_0x64.html +9 -2
  78. data/doc/cxxapi/functions_0x67.html +6 -9
  79. data/doc/cxxapi/functions_0x69.html +3 -0
  80. data/doc/cxxapi/functions_0x77.html +8 -8
  81. data/doc/cxxapi/functions_eval.html +6 -0
  82. data/doc/cxxapi/functions_func.html +18 -17
  83. data/doc/cxxapi/functions_vars.html +8 -0
  84. data/doc/cxxapi/graph_legend.png +0 -0
  85. data/doc/cxxapi/group__Core.png +0 -0
  86. data/doc/cxxapi/group__Hooks.png +0 -0
  87. data/doc/cxxapi/hierarchy.html +3 -0
  88. data/doc/cxxapi/inherit__graph__14.map +1 -1
  89. data/doc/cxxapi/inherit__graph__14.md5 +1 -1
  90. data/doc/cxxapi/inherit__graph__14.png +0 -0
  91. data/doc/cxxapi/inherit__graph__15.map +1 -3
  92. data/doc/cxxapi/inherit__graph__15.md5 +1 -1
  93. data/doc/cxxapi/inherit__graph__15.png +0 -0
  94. data/doc/cxxapi/inherit__graph__16.map +3 -1
  95. data/doc/cxxapi/inherit__graph__16.md5 +1 -1
  96. data/doc/cxxapi/inherit__graph__16.png +0 -0
  97. data/doc/cxxapi/inherit__graph__17.map +1 -1
  98. data/doc/cxxapi/inherit__graph__17.md5 +1 -1
  99. data/doc/cxxapi/inherit__graph__17.png +0 -0
  100. data/doc/cxxapi/inherit__graph__18.map +1 -2
  101. data/doc/cxxapi/inherit__graph__18.md5 +1 -1
  102. data/doc/cxxapi/inherit__graph__18.png +0 -0
  103. data/doc/cxxapi/inherit__graph__19.map +2 -1
  104. data/doc/cxxapi/inherit__graph__19.md5 +1 -1
  105. data/doc/cxxapi/inherit__graph__19.png +0 -0
  106. data/doc/cxxapi/inherit__graph__20.map +1 -1
  107. data/doc/cxxapi/inherit__graph__20.md5 +1 -1
  108. data/doc/cxxapi/inherit__graph__20.png +0 -0
  109. data/doc/cxxapi/inherit__graph__21.map +1 -1
  110. data/doc/cxxapi/inherit__graph__21.md5 +1 -1
  111. data/doc/cxxapi/inherit__graph__21.png +0 -0
  112. data/doc/cxxapi/inherit__graph__22.map +1 -1
  113. data/doc/cxxapi/inherit__graph__22.md5 +1 -1
  114. data/doc/cxxapi/inherit__graph__22.png +0 -0
  115. data/doc/cxxapi/inherit__graph__23.map +1 -1
  116. data/doc/cxxapi/inherit__graph__23.md5 +1 -1
  117. data/doc/cxxapi/inherit__graph__23.png +0 -0
  118. data/doc/cxxapi/inherit__graph__24.map +1 -1
  119. data/doc/cxxapi/inherit__graph__24.md5 +1 -1
  120. data/doc/cxxapi/inherit__graph__24.png +0 -0
  121. data/doc/cxxapi/inherit__graph__25.map +1 -1
  122. data/doc/cxxapi/inherit__graph__25.md5 +1 -1
  123. data/doc/cxxapi/inherit__graph__25.png +0 -0
  124. data/doc/cxxapi/inherit__graph__26.map +1 -1
  125. data/doc/cxxapi/inherit__graph__26.md5 +1 -1
  126. data/doc/cxxapi/inherit__graph__26.png +0 -0
  127. data/doc/cxxapi/inherit__graph__27.map +1 -1
  128. data/doc/cxxapi/inherit__graph__27.md5 +1 -1
  129. data/doc/cxxapi/inherit__graph__27.png +0 -0
  130. data/doc/cxxapi/inherit__graph__28.map +1 -2
  131. data/doc/cxxapi/inherit__graph__28.md5 +1 -1
  132. data/doc/cxxapi/inherit__graph__28.png +0 -0
  133. data/doc/cxxapi/inherit__graph__29.map +1 -1
  134. data/doc/cxxapi/inherit__graph__29.md5 +1 -1
  135. data/doc/cxxapi/inherit__graph__29.png +0 -0
  136. data/doc/cxxapi/inherit__graph__30.map +1 -1
  137. data/doc/cxxapi/inherit__graph__30.md5 +1 -1
  138. data/doc/cxxapi/inherit__graph__30.png +0 -0
  139. data/doc/cxxapi/inherit__graph__31.map +2 -1
  140. data/doc/cxxapi/inherit__graph__31.md5 +1 -1
  141. data/doc/cxxapi/inherit__graph__31.png +0 -0
  142. data/doc/cxxapi/inherit__graph__32.map +1 -3
  143. data/doc/cxxapi/inherit__graph__32.md5 +1 -1
  144. data/doc/cxxapi/inherit__graph__32.png +0 -0
  145. data/doc/cxxapi/inherit__graph__33.map +1 -1
  146. data/doc/cxxapi/inherit__graph__33.md5 +1 -1
  147. data/doc/cxxapi/inherit__graph__33.png +0 -0
  148. data/doc/cxxapi/inherit__graph__34.map +1 -1
  149. data/doc/cxxapi/inherit__graph__34.md5 +1 -1
  150. data/doc/cxxapi/inherit__graph__34.png +0 -0
  151. data/doc/cxxapi/inherit__graph__35.map +3 -1
  152. data/doc/cxxapi/inherit__graph__35.md5 +1 -1
  153. data/doc/cxxapi/inherit__graph__35.png +0 -0
  154. data/doc/cxxapi/inherit__graph__36.map +1 -1
  155. data/doc/cxxapi/inherit__graph__36.md5 +1 -1
  156. data/doc/cxxapi/inherit__graph__36.png +0 -0
  157. data/doc/cxxapi/inherit__graph__37.map +1 -1
  158. data/doc/cxxapi/inherit__graph__37.md5 +1 -1
  159. data/doc/cxxapi/inherit__graph__37.png +0 -0
  160. data/doc/cxxapi/inherit__graph__38.map +3 -1
  161. data/doc/cxxapi/inherit__graph__38.md5 +1 -1
  162. data/doc/cxxapi/inherit__graph__38.png +0 -0
  163. data/doc/cxxapi/inherit__graph__39.map +3 -1
  164. data/doc/cxxapi/inherit__graph__39.md5 +1 -1
  165. data/doc/cxxapi/inherit__graph__39.png +0 -0
  166. data/doc/cxxapi/inherits.html +33 -24
  167. data/doc/cxxapi/namespacePassenger.html +52 -0
  168. data/doc/cxxapi/namespacemembers.html +6 -0
  169. data/doc/cxxapi/namespacemembers_func.html +6 -0
  170. data/doc/cxxapi/tree.html +8 -0
  171. data/ext/apache2/Configuration.cpp +30 -8
  172. data/ext/apache2/Configuration.hpp +15 -14
  173. data/ext/apache2/DirectoryMapper.h +0 -16
  174. data/ext/apache2/Hooks.cpp +30 -29
  175. data/ext/boost/algorithm/string/detail/case_conv.hpp +6 -6
  176. data/ext/boost/algorithm/string/detail/find_format.hpp +14 -4
  177. data/ext/boost/algorithm/string/detail/find_format_all.hpp +13 -3
  178. data/ext/boost/algorithm/string/detail/find_format_store.hpp +11 -0
  179. data/ext/boost/algorithm/string/erase.hpp +2 -2
  180. data/ext/boost/bind/placeholders.hpp +2 -2
  181. data/ext/boost/concept/detail/backward_compatibility.hpp +16 -0
  182. data/ext/boost/concept/detail/general.hpp +15 -6
  183. data/ext/boost/concept/detail/has_constraints.hpp +5 -3
  184. data/ext/boost/concept/usage.hpp +5 -4
  185. data/ext/boost/concept_check.hpp +10 -1
  186. data/ext/boost/config/abi/borland_prefix.hpp +1 -1
  187. data/ext/boost/config/auto_link.hpp +68 -21
  188. data/ext/boost/config/compiler/borland.hpp +11 -3
  189. data/ext/boost/config/compiler/clang.hpp +62 -0
  190. data/ext/boost/config/compiler/codegear.hpp +21 -7
  191. data/ext/boost/config/compiler/common_edg.hpp +4 -2
  192. data/ext/boost/config/compiler/digitalmars.hpp +1 -1
  193. data/ext/boost/config/compiler/gcc.hpp +46 -7
  194. data/ext/boost/config/compiler/gcc_xml.hpp +25 -0
  195. data/ext/boost/config/compiler/intel.hpp +23 -0
  196. data/ext/boost/config/compiler/kai.hpp +1 -1
  197. data/ext/boost/config/compiler/metrowerks.hpp +1 -1
  198. data/ext/boost/config/compiler/nvcc.hpp +86 -0
  199. data/ext/boost/config/compiler/pgi.hpp +18 -3
  200. data/ext/boost/config/compiler/sunpro_cc.hpp +19 -5
  201. data/ext/boost/config/compiler/vacpp.hpp +8 -0
  202. data/ext/boost/config/compiler/visualc.hpp +27 -11
  203. data/ext/boost/config/platform/cygwin.hpp +0 -3
  204. data/ext/boost/config/platform/symbian.hpp +94 -0
  205. data/ext/boost/config/platform/win32.hpp +8 -1
  206. data/ext/boost/config/select_compiler_config.hpp +10 -0
  207. data/ext/boost/config/select_platform_config.hpp +4 -0
  208. data/ext/boost/config/stdlib/dinkumware.hpp +11 -1
  209. data/ext/boost/config/stdlib/libcomo.hpp +1 -0
  210. data/ext/boost/config/stdlib/libstdcpp3.hpp +1 -0
  211. data/ext/boost/config/stdlib/modena.hpp +1 -0
  212. data/ext/boost/config/stdlib/msl.hpp +1 -0
  213. data/ext/boost/config/stdlib/roguewave.hpp +1 -0
  214. data/ext/boost/config/stdlib/sgi.hpp +1 -0
  215. data/ext/boost/config/stdlib/stlport.hpp +1 -0
  216. data/ext/boost/config/stdlib/vacpp.hpp +1 -0
  217. data/ext/boost/config/suffix.hpp +40 -2
  218. data/ext/boost/cstdint.hpp +36 -7
  219. data/ext/boost/date_time/gregorian/conversion.hpp +4 -2
  220. data/ext/boost/date_time/microsec_time_clock.hpp +7 -7
  221. data/ext/boost/date_time/posix_time/conversion.hpp +4 -2
  222. data/ext/boost/date_time/time_facet.hpp +43 -4
  223. data/ext/boost/detail/endian.hpp +5 -2
  224. data/ext/boost/detail/lcast_precision.hpp +2 -2
  225. data/ext/boost/detail/sp_typeinfo.hpp +1 -1
  226. data/ext/boost/detail/workaround.hpp +5 -0
  227. data/ext/boost/exception/detail/error_info_impl.hpp +3 -3
  228. data/ext/boost/exception/detail/exception_ptr.hpp +76 -135
  229. data/ext/boost/exception/detail/is_output_streamable.hpp +15 -2
  230. data/ext/boost/exception/detail/type_info.hpp +9 -5
  231. data/ext/boost/exception/diagnostic_information.hpp +5 -3
  232. data/ext/boost/exception/exception.hpp +60 -46
  233. data/ext/boost/exception/info.hpp +47 -14
  234. data/ext/boost/function/function_base.hpp +4 -4
  235. data/ext/boost/integer.hpp +4 -0
  236. data/ext/boost/integer_fwd.hpp +9 -3
  237. data/ext/boost/iterator/iterator_concepts.hpp +284 -0
  238. data/ext/boost/iterator/transform_iterator.hpp +0 -1
  239. data/ext/boost/make_shared.hpp +17 -0
  240. data/ext/boost/mpl/aux_/config/has_xxx.hpp +4 -3
  241. data/ext/boost/mpl/aux_/preprocessed/gcc/template_arity.hpp +2 -6
  242. data/ext/boost/mpl/aux_/template_arity.hpp +4 -4
  243. data/ext/boost/mpl/eval_if.hpp +3 -3
  244. data/ext/boost/mpl/has_xxx.hpp +369 -3
  245. data/ext/boost/optional/optional.hpp +3 -1
  246. data/ext/boost/optional/optional_fwd.hpp +1 -1
  247. data/ext/boost/preprocessor/repetition/enum_trailing_params.hpp +38 -0
  248. data/ext/boost/range/algorithm/equal.hpp +188 -0
  249. data/ext/boost/range/as_literal.hpp +15 -15
  250. data/ext/boost/range/concepts.hpp +331 -0
  251. data/ext/boost/range/const_iterator.hpp +7 -4
  252. data/ext/boost/range/detail/extract_optional_type.hpp +52 -0
  253. data/ext/boost/range/detail/implementation_help.hpp +7 -7
  254. data/ext/boost/range/detail/misc_concept.hpp +33 -0
  255. data/ext/boost/range/iterator.hpp +32 -32
  256. data/ext/boost/range/iterator_range.hpp +8 -651
  257. data/ext/boost/range/iterator_range_core.hpp +542 -0
  258. data/ext/boost/range/iterator_range_io.hpp +93 -0
  259. data/ext/boost/range/mutable_iterator.hpp +7 -4
  260. data/ext/boost/range/size.hpp +1 -1
  261. data/ext/boost/range/size_type.hpp +2 -1
  262. data/ext/boost/shared_array.hpp +19 -0
  263. data/ext/boost/smart_ptr/detail/sp_convertible.hpp +2 -2
  264. data/ext/boost/smart_ptr/detail/yield_k.hpp +1 -1
  265. data/ext/boost/smart_ptr/make_shared.hpp +508 -0
  266. data/ext/boost/smart_ptr/shared_array.hpp +147 -0
  267. data/ext/boost/src/pthread/thread.cpp +16 -21
  268. data/ext/boost/src/pthread/timeconv.inl +7 -4
  269. data/ext/boost/thread/barrier.hpp +2 -1
  270. data/ext/boost/thread/detail/config.hpp +7 -1
  271. data/ext/boost/thread/detail/platform.hpp +1 -1
  272. data/ext/boost/thread/detail/thread.hpp +62 -18
  273. data/ext/boost/thread/detail/thread_group.hpp +5 -2
  274. data/ext/boost/thread/detail/tss_hooks.hpp +8 -25
  275. data/ext/boost/thread/future.hpp +45 -34
  276. data/ext/boost/thread/locks.hpp +184 -55
  277. data/ext/boost/thread/pthread/condition_variable.hpp +7 -7
  278. data/ext/boost/thread/pthread/condition_variable_fwd.hpp +4 -2
  279. data/ext/boost/thread/pthread/mutex.hpp +29 -17
  280. data/ext/boost/thread/pthread/once.hpp +5 -0
  281. data/ext/boost/thread/pthread/recursive_mutex.hpp +97 -18
  282. data/ext/boost/thread/pthread/shared_mutex.hpp +1 -1
  283. data/ext/boost/thread/pthread/thread_heap_alloc.hpp +1 -1
  284. data/ext/boost/thread/tss.hpp +2 -0
  285. data/ext/boost/throw_exception.hpp +21 -5
  286. data/ext/boost/token_functions.hpp +111 -91
  287. data/ext/boost/type_traits/add_reference.hpp +19 -1
  288. data/ext/boost/type_traits/function_traits.hpp +2 -2
  289. data/ext/boost/type_traits/is_const.hpp +24 -5
  290. data/ext/boost/type_traits/is_convertible.hpp +1 -1
  291. data/ext/boost/type_traits/is_function.hpp +3 -0
  292. data/ext/boost/type_traits/is_lvalue_reference.hpp +118 -0
  293. data/ext/boost/type_traits/is_reference.hpp +8 -81
  294. data/ext/boost/type_traits/is_rvalue_reference.hpp +29 -0
  295. data/ext/boost/type_traits/is_same.hpp +2 -2
  296. data/ext/boost/type_traits/is_volatile.hpp +26 -7
  297. data/ext/boost/type_traits/remove_const.hpp +12 -0
  298. data/ext/boost/type_traits/remove_cv.hpp +23 -1
  299. data/ext/boost/type_traits/remove_reference.hpp +21 -1
  300. data/ext/boost/type_traits/type_with_alignment.hpp +10 -10
  301. data/ext/boost/units/detail/utility.hpp +104 -0
  302. data/ext/boost/utility/compare_pointees.hpp +1 -1
  303. data/ext/common/AgentsStarter.hpp +151 -161
  304. data/ext/common/ApplicationPool/Pool.h +16 -4
  305. data/ext/common/Constants.h +1 -1
  306. data/ext/common/EventedClient.h +130 -26
  307. data/ext/common/Exceptions.h +15 -2
  308. data/ext/common/FileDescriptor.h +76 -12
  309. data/ext/common/IniFile.h +488 -0
  310. data/ext/common/LoggingAgent/LoggingServer.h +2 -2
  311. data/ext/common/LoggingAgent/RemoteSender.h +15 -6
  312. data/ext/common/MessageChannel.h +17 -101
  313. data/ext/common/PoolOptions.h +1 -0
  314. data/ext/common/ResourceLocator.h +78 -28
  315. data/ext/common/SafeLibev.h +149 -0
  316. data/ext/common/ServerInstanceDir.h +11 -7
  317. data/ext/common/Session.h +1 -1
  318. data/ext/common/SpawnManager.h +14 -14
  319. data/ext/common/StaticString.h +75 -0
  320. data/ext/common/Utils.cpp +304 -12
  321. data/ext/common/Utils.h +17 -0
  322. data/ext/common/Utils/BufferedIO.h +196 -0
  323. data/ext/common/Utils/IOUtils.cpp +159 -0
  324. data/ext/common/Utils/IOUtils.h +118 -1
  325. data/ext/common/Utils/ProcessMetricsCollector.h +184 -56
  326. data/ext/common/Utils/StrIntUtils.cpp +45 -11
  327. data/ext/common/Utils/StrIntUtils.h +8 -5
  328. data/ext/common/Utils/Timer.h +22 -0
  329. data/ext/common/Utils/utf8.h +35 -0
  330. data/ext/common/Utils/utf8/checked.h +324 -0
  331. data/ext/common/Utils/utf8/core.h +359 -0
  332. data/ext/common/Utils/utf8/unchecked.h +229 -0
  333. data/ext/common/Watchdog.cpp +52 -85
  334. data/ext/libev/config.h +122 -0
  335. data/ext/nginx/Configuration.c +7 -1
  336. data/ext/nginx/HelperAgent.cpp +16 -18
  337. data/ext/nginx/config +6 -4
  338. data/ext/oxt/system_calls.cpp +10 -0
  339. data/ext/oxt/system_calls.hpp +2 -0
  340. data/lib/phusion_passenger.rb +6 -11
  341. data/lib/phusion_passenger/dependencies.rb +2 -0
  342. data/lib/phusion_passenger/packaging.rb +5 -5
  343. data/lib/phusion_passenger/platform_info.rb +88 -0
  344. data/lib/phusion_passenger/platform_info/binary_compatibility.rb +3 -17
  345. data/lib/phusion_passenger/platform_info/compiler.rb +14 -32
  346. data/lib/phusion_passenger/platform_info/curl.rb +6 -1
  347. data/lib/phusion_passenger/platform_info/operating_system.rb +107 -0
  348. data/lib/phusion_passenger/public_api.rb +2 -2
  349. data/lib/phusion_passenger/rails3_extensions/init.rb +5 -2
  350. data/lib/phusion_passenger/standalone/command.rb +6 -2
  351. data/lib/phusion_passenger/standalone/package_runtime_command.rb +2 -2
  352. data/lib/phusion_passenger/standalone/runtime_installer.rb +17 -5
  353. data/lib/phusion_passenger/standalone/start_command.rb +12 -12
  354. data/lib/phusion_passenger/standalone/stop_command.rb +3 -3
  355. data/lib/phusion_passenger/standalone/utils.rb +6 -2
  356. data/lib/phusion_passenger/templates/standalone/config.erb +37 -5
  357. data/lib/phusion_passenger/utils.rb +4 -7
  358. data/resources/mime.types +73 -0
  359. data/{misc → resources}/union_station_gateway.crt +0 -0
  360. data/test/cxx/BufferedIOTest.cpp +364 -0
  361. data/test/cxx/EventedClientTest.cpp +150 -13
  362. data/test/cxx/IOUtilsTest.cpp +399 -1
  363. data/test/cxx/MessageChannelTest.cpp +5 -120
  364. data/test/cxx/ProcessMetricsCollectorTest.cpp +121 -0
  365. data/test/cxx/StaticStringTest.cpp +134 -0
  366. data/test/cxx/UtilsTest.cpp +16 -46
  367. data/test/stub/rails_apps/2.3/mycook/public/dispatch.cgi +2 -2
  368. data/test/stub/rails_apps/2.3/mycook/public/dispatch.fcgi +1 -1
  369. data/test/stub/rails_apps/2.3/mycook/public/dispatch.rb +1 -1
  370. data/test/stub/rails_apps/3.0/empty/Gemfile.lock +73 -0
  371. data/test/support/allocate_memory.c +14 -0
  372. data/test/support/test_helper.rb +3 -0
  373. metadata +57 -174
  374. data/bin/passenger-stress-test +0 -345
  375. data/debian/postinst +0 -24
  376. data/doc/rdoc/classes/ConditionVariable.html +0 -215
  377. data/doc/rdoc/classes/Exception.html +0 -120
  378. data/doc/rdoc/classes/GC.html +0 -113
  379. data/doc/rdoc/classes/IO.html +0 -221
  380. data/doc/rdoc/classes/PhusionPassenger.html +0 -397
  381. data/doc/rdoc/classes/PhusionPassenger/AbstractInstaller.html +0 -180
  382. data/doc/rdoc/classes/PhusionPassenger/AbstractRequestHandler.html +0 -647
  383. data/doc/rdoc/classes/PhusionPassenger/AbstractServer.html +0 -654
  384. data/doc/rdoc/classes/PhusionPassenger/AbstractServer/InvalidPassword.html +0 -92
  385. data/doc/rdoc/classes/PhusionPassenger/AbstractServer/ServerAlreadyStarted.html +0 -97
  386. data/doc/rdoc/classes/PhusionPassenger/AbstractServer/ServerError.html +0 -96
  387. data/doc/rdoc/classes/PhusionPassenger/AbstractServer/ServerNotStarted.html +0 -97
  388. data/doc/rdoc/classes/PhusionPassenger/AbstractServer/UnknownMessage.html +0 -96
  389. data/doc/rdoc/classes/PhusionPassenger/AbstractServerCollection.html +0 -619
  390. data/doc/rdoc/classes/PhusionPassenger/AdminTools.html +0 -142
  391. data/doc/rdoc/classes/PhusionPassenger/AdminTools/MemoryStats.html +0 -368
  392. data/doc/rdoc/classes/PhusionPassenger/AdminTools/MemoryStats/Process.html +0 -231
  393. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance.html +0 -588
  394. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance/CorruptedDirectoryError.html +0 -92
  395. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance/GenerationsAbsentError.html +0 -92
  396. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance/Group.html +0 -147
  397. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance/Process.html +0 -279
  398. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance/RoleDeniedError.html +0 -92
  399. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance/StaleDirectoryError.html +0 -92
  400. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance/Stats.html +0 -123
  401. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance/UnsupportedGenerationStructureVersionError.html +0 -92
  402. data/doc/rdoc/classes/PhusionPassenger/AnalyticsLogger.html +0 -341
  403. data/doc/rdoc/classes/PhusionPassenger/AnalyticsLogger/Log.html +0 -294
  404. data/doc/rdoc/classes/PhusionPassenger/AnalyticsLogger/SharedData.html +0 -199
  405. data/doc/rdoc/classes/PhusionPassenger/AppInitError.html +0 -155
  406. data/doc/rdoc/classes/PhusionPassenger/AppProcess.html +0 -367
  407. data/doc/rdoc/classes/PhusionPassenger/ClassicRails.html +0 -95
  408. data/doc/rdoc/classes/PhusionPassenger/ClassicRails/ApplicationSpawner.html +0 -351
  409. data/doc/rdoc/classes/PhusionPassenger/ClassicRails/ApplicationSpawner/Error.html +0 -98
  410. data/doc/rdoc/classes/PhusionPassenger/ClassicRails/CGIFixed.html +0 -200
  411. data/doc/rdoc/classes/PhusionPassenger/ClassicRails/FrameworkSpawner.html +0 -410
  412. data/doc/rdoc/classes/PhusionPassenger/ClassicRails/FrameworkSpawner/Error.html +0 -98
  413. data/doc/rdoc/classes/PhusionPassenger/ClassicRails/RequestHandler.html +0 -156
  414. data/doc/rdoc/classes/PhusionPassenger/ClassicRailsExtensions.html +0 -115
  415. data/doc/rdoc/classes/PhusionPassenger/ClassicRailsExtensions/AnalyticsLogging.html +0 -202
  416. data/doc/rdoc/classes/PhusionPassenger/ConsoleTextTemplate.html +0 -172
  417. data/doc/rdoc/classes/PhusionPassenger/DebugLogging.html +0 -273
  418. data/doc/rdoc/classes/PhusionPassenger/FrameworkInitError.html +0 -145
  419. data/doc/rdoc/classes/PhusionPassenger/HTMLTemplate.html +0 -162
  420. data/doc/rdoc/classes/PhusionPassenger/InitializationError.html +0 -141
  421. data/doc/rdoc/classes/PhusionPassenger/InvalidPath.html +0 -92
  422. data/doc/rdoc/classes/PhusionPassenger/MessageChannel.html +0 -673
  423. data/doc/rdoc/classes/PhusionPassenger/MessageChannel/InvalidHashError.html +0 -92
  424. data/doc/rdoc/classes/PhusionPassenger/MessageClient.html +0 -415
  425. data/doc/rdoc/classes/PhusionPassenger/NativeSupportLoader.html +0 -134
  426. data/doc/rdoc/classes/PhusionPassenger/Packaging.html +0 -129
  427. data/doc/rdoc/classes/PhusionPassenger/PlatformInfo.html +0 -1809
  428. data/doc/rdoc/classes/PhusionPassenger/Plugin.html +0 -237
  429. data/doc/rdoc/classes/PhusionPassenger/Rack.html +0 -91
  430. data/doc/rdoc/classes/PhusionPassenger/Rack/ApplicationSpawner.html +0 -312
  431. data/doc/rdoc/classes/PhusionPassenger/Rack/ApplicationSpawner/Error.html +0 -98
  432. data/doc/rdoc/classes/PhusionPassenger/Rack/RequestHandler.html +0 -218
  433. data/doc/rdoc/classes/PhusionPassenger/Rails3Extensions.html +0 -114
  434. data/doc/rdoc/classes/PhusionPassenger/Rails3Extensions/AnalyticsLogging.html +0 -256
  435. data/doc/rdoc/classes/PhusionPassenger/Rails3Extensions/AnalyticsLogging/ACExtension.html +0 -139
  436. data/doc/rdoc/classes/PhusionPassenger/Rails3Extensions/AnalyticsLogging/ASBenchmarkableExtension.html +0 -118
  437. data/doc/rdoc/classes/PhusionPassenger/Rails3Extensions/AnalyticsLogging/ExceptionLogger.html +0 -135
  438. data/doc/rdoc/classes/PhusionPassenger/SpawnManager.html +0 -378
  439. data/doc/rdoc/classes/PhusionPassenger/Standalone.html +0 -111
  440. data/doc/rdoc/classes/PhusionPassenger/Standalone/AppFinder.html +0 -252
  441. data/doc/rdoc/classes/PhusionPassenger/Standalone/Command.html +0 -161
  442. data/doc/rdoc/classes/PhusionPassenger/Standalone/ConfigFile.html +0 -368
  443. data/doc/rdoc/classes/PhusionPassenger/Standalone/ConfigFile/DisallowedContextError.html +0 -132
  444. data/doc/rdoc/classes/PhusionPassenger/Standalone/HelpCommand.html +0 -151
  445. data/doc/rdoc/classes/PhusionPassenger/Standalone/Main.html +0 -189
  446. data/doc/rdoc/classes/PhusionPassenger/Standalone/PackageRuntimeCommand.html +0 -177
  447. data/doc/rdoc/classes/PhusionPassenger/Standalone/RuntimeInstaller.html +0 -341
  448. data/doc/rdoc/classes/PhusionPassenger/Standalone/StartCommand.html +0 -203
  449. data/doc/rdoc/classes/PhusionPassenger/Standalone/StatusCommand.html +0 -156
  450. data/doc/rdoc/classes/PhusionPassenger/Standalone/StopCommand.html +0 -168
  451. data/doc/rdoc/classes/PhusionPassenger/Standalone/Utils.html +0 -86
  452. data/doc/rdoc/classes/PhusionPassenger/Standalone/VersionCommand.html +0 -135
  453. data/doc/rdoc/classes/PhusionPassenger/UnknownError.html +0 -125
  454. data/doc/rdoc/classes/PhusionPassenger/Utils.html +0 -1550
  455. data/doc/rdoc/classes/PhusionPassenger/Utils/FileSystemWatcher.html +0 -204
  456. data/doc/rdoc/classes/PhusionPassenger/Utils/FileSystemWatcher/DirInfo.html +0 -171
  457. data/doc/rdoc/classes/PhusionPassenger/Utils/FileSystemWatcher/FileInfo.html +0 -140
  458. data/doc/rdoc/classes/PhusionPassenger/Utils/HostsFileParser.html +0 -260
  459. data/doc/rdoc/classes/PhusionPassenger/Utils/PseudoIO.html +0 -169
  460. data/doc/rdoc/classes/PhusionPassenger/Utils/RewindableInput.html +0 -265
  461. data/doc/rdoc/classes/PhusionPassenger/Utils/RewindableInput/Tempfile.html +0 -120
  462. data/doc/rdoc/classes/PhusionPassenger/Utils/UnseekableSocket.html +0 -561
  463. data/doc/rdoc/classes/PhusionPassenger/VersionNotFound.html +0 -140
  464. data/doc/rdoc/classes/PhusionPassenger/WSGI.html +0 -89
  465. data/doc/rdoc/classes/PhusionPassenger/WSGI/ApplicationSpawner.html +0 -182
  466. data/doc/rdoc/classes/Process.html +0 -115
  467. data/doc/rdoc/classes/Signal.html +0 -139
  468. data/doc/rdoc/created.rid +0 -1
  469. data/doc/rdoc/files/DEVELOPERS_TXT.html +0 -276
  470. data/doc/rdoc/files/README.html +0 -157
  471. data/doc/rdoc/files/lib/phusion_passenger/abstract_installer_rb.html +0 -130
  472. data/doc/rdoc/files/lib/phusion_passenger/abstract_request_handler_rb.html +0 -135
  473. data/doc/rdoc/files/lib/phusion_passenger/abstract_server_collection_rb.html +0 -126
  474. data/doc/rdoc/files/lib/phusion_passenger/abstract_server_rb.html +0 -128
  475. data/doc/rdoc/files/lib/phusion_passenger/admin_tools/memory_stats_rb.html +0 -126
  476. data/doc/rdoc/files/lib/phusion_passenger/admin_tools/server_instance_rb.html +0 -132
  477. data/doc/rdoc/files/lib/phusion_passenger/admin_tools_rb.html +0 -122
  478. data/doc/rdoc/files/lib/phusion_passenger/analytics_logger_rb.html +0 -129
  479. data/doc/rdoc/files/lib/phusion_passenger/app_process_rb.html +0 -127
  480. data/doc/rdoc/files/lib/phusion_passenger/classic_rails/application_spawner_rb.html +0 -141
  481. data/doc/rdoc/files/lib/phusion_passenger/classic_rails/cgi_fixed_rb.html +0 -126
  482. data/doc/rdoc/files/lib/phusion_passenger/classic_rails/framework_spawner_rb.html +0 -146
  483. data/doc/rdoc/files/lib/phusion_passenger/classic_rails/request_handler_rb.html +0 -125
  484. data/doc/rdoc/files/lib/phusion_passenger/classic_rails_extensions/init_rb.html +0 -132
  485. data/doc/rdoc/files/lib/phusion_passenger/console_text_template_rb.html +0 -126
  486. data/doc/rdoc/files/lib/phusion_passenger/constants_rb.html +0 -122
  487. data/doc/rdoc/files/lib/phusion_passenger/debug_logging_rb.html +0 -122
  488. data/doc/rdoc/files/lib/phusion_passenger/dependencies_rb.html +0 -147
  489. data/doc/rdoc/files/lib/phusion_passenger/exceptions_rb.html +0 -122
  490. data/doc/rdoc/files/lib/phusion_passenger/html_template_rb.html +0 -127
  491. data/doc/rdoc/files/lib/phusion_passenger/message_channel_rb.html +0 -120
  492. data/doc/rdoc/files/lib/phusion_passenger/message_client_rb.html +0 -127
  493. data/doc/rdoc/files/lib/phusion_passenger/native_support_rb.html +0 -132
  494. data/doc/rdoc/files/lib/phusion_passenger/packaging_rb.html +0 -122
  495. data/doc/rdoc/files/lib/phusion_passenger/platform_info/apache_rb.html +0 -127
  496. data/doc/rdoc/files/lib/phusion_passenger/platform_info/binary_compatibility_rb.html +0 -129
  497. data/doc/rdoc/files/lib/phusion_passenger/platform_info/compiler_rb.html +0 -126
  498. data/doc/rdoc/files/lib/phusion_passenger/platform_info/curl_rb.html +0 -126
  499. data/doc/rdoc/files/lib/phusion_passenger/platform_info/documentation_tools_rb.html +0 -126
  500. data/doc/rdoc/files/lib/phusion_passenger/platform_info/linux_rb.html +0 -126
  501. data/doc/rdoc/files/lib/phusion_passenger/platform_info/operating_system_rb.html +0 -127
  502. data/doc/rdoc/files/lib/phusion_passenger/platform_info/ruby_rb.html +0 -128
  503. data/doc/rdoc/files/lib/phusion_passenger/platform_info/zlib_rb.html +0 -126
  504. data/doc/rdoc/files/lib/phusion_passenger/platform_info_rb.html +0 -122
  505. data/doc/rdoc/files/lib/phusion_passenger/plugin_rb.html +0 -127
  506. data/doc/rdoc/files/lib/phusion_passenger/public_api_rb.html +0 -127
  507. data/doc/rdoc/files/lib/phusion_passenger/rack/application_spawner_rb.html +0 -137
  508. data/doc/rdoc/files/lib/phusion_passenger/rack/request_handler_rb.html +0 -125
  509. data/doc/rdoc/files/lib/phusion_passenger/rails3_extensions/init_rb.html +0 -127
  510. data/doc/rdoc/files/lib/phusion_passenger/simple_benchmarking_rb.html +0 -122
  511. data/doc/rdoc/files/lib/phusion_passenger/spawn_manager_rb.html +0 -160
  512. data/doc/rdoc/files/lib/phusion_passenger/standalone/app_finder_rb.html +0 -127
  513. data/doc/rdoc/files/lib/phusion_passenger/standalone/command_rb.html +0 -135
  514. data/doc/rdoc/files/lib/phusion_passenger/standalone/config_file_rb.html +0 -126
  515. data/doc/rdoc/files/lib/phusion_passenger/standalone/help_command_rb.html +0 -126
  516. data/doc/rdoc/files/lib/phusion_passenger/standalone/main_rb.html +0 -126
  517. data/doc/rdoc/files/lib/phusion_passenger/standalone/package_runtime_command_rb.html +0 -127
  518. data/doc/rdoc/files/lib/phusion_passenger/standalone/runtime_installer_rb.html +0 -133
  519. data/doc/rdoc/files/lib/phusion_passenger/standalone/start_command_rb.html +0 -136
  520. data/doc/rdoc/files/lib/phusion_passenger/standalone/status_command_rb.html +0 -126
  521. data/doc/rdoc/files/lib/phusion_passenger/standalone/stop_command_rb.html +0 -126
  522. data/doc/rdoc/files/lib/phusion_passenger/standalone/utils_rb.html +0 -126
  523. data/doc/rdoc/files/lib/phusion_passenger/standalone/version_command_rb.html +0 -127
  524. data/doc/rdoc/files/lib/phusion_passenger/utils/file_system_watcher_rb.html +0 -126
  525. data/doc/rdoc/files/lib/phusion_passenger/utils/hosts_file_parser_rb.html +0 -120
  526. data/doc/rdoc/files/lib/phusion_passenger/utils/rewindable_input_rb.html +0 -100
  527. data/doc/rdoc/files/lib/phusion_passenger/utils/tmpdir_rb.html +0 -122
  528. data/doc/rdoc/files/lib/phusion_passenger/utils/unseekable_socket_rb.html +0 -126
  529. data/doc/rdoc/files/lib/phusion_passenger/utils_rb.html +0 -179
  530. data/doc/rdoc/files/lib/phusion_passenger/wsgi/application_spawner_rb.html +0 -132
  531. data/doc/rdoc/fr_class_index.html +0 -138
  532. data/doc/rdoc/fr_file_index.html +0 -108
  533. data/doc/rdoc/fr_method_index.html +0 -430
  534. data/doc/rdoc/index.html +0 -26
  535. data/doc/rdoc/rdoc-style.css +0 -187
  536. data/ext/apache2/LICENSE-CNRI.TXT +0 -79
  537. data/ext/common/Utils/BlockingScalar.h +0 -50
  538. data/ext/common/Utils/FileHandleGuard.h +0 -81
data/doc/cxxapi/MessageChannel_8h_source.html CHANGED
@@ -65,785 +65,701 @@
65
65
  <a name="l00040"></a>00040 <span class="preprocessor">#include &lt;errno.h&gt;</span>
66
66
  <a name="l00041"></a>00041 <span class="preprocessor">#include &lt;unistd.h&gt;</span>
67
67
  <a name="l00042"></a>00042 <span class="preprocessor">#include &lt;cstdarg&gt;</span>
68
- <a name="l00043"></a>00043 <span class="preprocessor">#if !APR_HAVE_IOVEC</span>
69
- <a name="l00044"></a>00044 <span class="preprocessor"></span> <span class="comment">// We don&#39;t want apr_want.h to redefine &#39;struct iovec&#39;.</span>
70
- <a name="l00045"></a>00045 <span class="comment">// http://groups.google.com/group/phusion-passenger/browse_thread/thread/7e162f60df212e9c</span>
71
- <a name="l00046"></a>00046 <span class="preprocessor"> #undef APR_HAVE_IOVEC</span>
72
- <a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor"> #define APR_HAVE_IOVEC 1</span>
73
- <a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
74
- <a name="l00049"></a>00049 <span class="preprocessor"></span>
75
- <a name="l00050"></a>00050 <span class="preprocessor">#include &quot;StaticString.h&quot;</span>
76
- <a name="l00051"></a>00051 <span class="preprocessor">#include &quot;Exceptions.h&quot;</span>
77
- <a name="l00052"></a>00052 <span class="preprocessor">#include &quot;Utils/Timer.h&quot;</span>
78
- <a name="l00053"></a>00053 <span class="preprocessor">#include &quot;Utils/MemZeroGuard.h&quot;</span>
79
- <a name="l00054"></a>00054
80
- <a name="l00055"></a>00055 <span class="keyword">namespace </span>Passenger {
68
+ <a name="l00043"></a>00043 <span class="preprocessor">#include &lt;cmath&gt;</span>
69
+ <a name="l00044"></a>00044 <span class="preprocessor">#if !APR_HAVE_IOVEC</span>
70
+ <a name="l00045"></a>00045 <span class="preprocessor"></span> <span class="comment">// We don&#39;t want apr_want.h to redefine &#39;struct iovec&#39;.</span>
71
+ <a name="l00046"></a>00046 <span class="comment">// http://groups.google.com/group/phusion-passenger/browse_thread/thread/7e162f60df212e9c</span>
72
+ <a name="l00047"></a>00047 <span class="preprocessor"> #undef APR_HAVE_IOVEC</span>
73
+ <a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor"> #define APR_HAVE_IOVEC 1</span>
74
+ <a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
75
+ <a name="l00050"></a>00050 <span class="preprocessor"></span>
76
+ <a name="l00051"></a>00051 <span class="preprocessor">#include &quot;StaticString.h&quot;</span>
77
+ <a name="l00052"></a>00052 <span class="preprocessor">#include &quot;Exceptions.h&quot;</span>
78
+ <a name="l00053"></a>00053 <span class="preprocessor">#include &quot;Utils/Timer.h&quot;</span>
79
+ <a name="l00054"></a>00054 <span class="preprocessor">#include &quot;Utils/MemZeroGuard.h&quot;</span>
80
+ <a name="l00055"></a>00055 <span class="preprocessor">#include &quot;Utils/IOUtils.h&quot;</span>
81
81
  <a name="l00056"></a>00056
82
- <a name="l00057"></a>00057 <span class="keyword">using namespace </span>std;
83
- <a name="l00058"></a>00058 <span class="keyword">using namespace </span>oxt;
84
- <a name="l00059"></a>00059 <span class="comment"></span>
85
- <a name="l00060"></a>00060 <span class="comment">/**</span>
86
- <a name="l00061"></a>00061 <span class="comment"> * Convenience class for I/O operations on file descriptors.</span>
87
- <a name="l00062"></a>00062 <span class="comment"> *</span>
88
- <a name="l00063"></a>00063 <span class="comment"> * This class provides convenience methods for:</span>
89
- <a name="l00064"></a>00064 <span class="comment"> * - sending and receiving raw data over a file descriptor.</span>
90
- <a name="l00065"></a>00065 <span class="comment"> * - sending and receiving messages over a file descriptor.</span>
91
- <a name="l00066"></a>00066 <span class="comment"> * - file descriptor passing over a Unix socket.</span>
92
- <a name="l00067"></a>00067 <span class="comment"> * - data size limit enforcement and time constraint enforcement.</span>
93
- <a name="l00068"></a>00068 <span class="comment"> * All of these methods use exceptions for error reporting.</span>
94
- <a name="l00069"></a>00069 <span class="comment"> *</span>
95
- <a name="l00070"></a>00070 <span class="comment"> * There are two kinds of messages:</span>
96
- <a name="l00071"></a>00071 <span class="comment"> * - Array messages. These are just a list of strings, and the message</span>
97
- <a name="l00072"></a>00072 <span class="comment"> * itself has a specific length. The contained strings may not</span>
98
- <a name="l00073"></a>00073 <span class="comment"> * contain NUL characters (&lt;tt&gt;&#39;\\0&#39;&lt;/tt&gt;). Note that an array message</span>
99
- <a name="l00074"></a>00074 <span class="comment"> * must have at least one element.</span>
100
- <a name="l00075"></a>00075 <span class="comment"> * - Scalar messages. These are byte strings which may contain arbitrary</span>
101
- <a name="l00076"></a>00076 <span class="comment"> * binary data. Scalar messages also have a specific length.</span>
102
- <a name="l00077"></a>00077 <span class="comment"> * The protocol is designed to be low overhead, easy to implement and</span>
103
- <a name="l00078"></a>00078 <span class="comment"> * easy to parse.</span>
104
- <a name="l00079"></a>00079 <span class="comment"> *</span>
105
- <a name="l00080"></a>00080 <span class="comment"> * MessageChannel is to be wrapped around a file descriptor. For example:</span>
106
- <a name="l00081"></a>00081 <span class="comment"> * @code</span>
107
- <a name="l00082"></a>00082 <span class="comment"> * int p[2];</span>
108
- <a name="l00083"></a>00083 <span class="comment"> * pipe(p);</span>
109
- <a name="l00084"></a>00084 <span class="comment"> * MessageChannel channel1(p[0]);</span>
110
- <a name="l00085"></a>00085 <span class="comment"> * MessageChannel channel2(p[1]);</span>
111
- <a name="l00086"></a>00086 <span class="comment"> * </span>
112
- <a name="l00087"></a>00087 <span class="comment"> * // Send an array message.</span>
113
- <a name="l00088"></a>00088 <span class="comment"> * channel2.write(&quot;hello&quot;, &quot;world !!&quot;, NULL);</span>
114
- <a name="l00089"></a>00089 <span class="comment"> * list&lt;string&gt; args;</span>
115
- <a name="l00090"></a>00090 <span class="comment"> * channel1.read(args); // args now contains { &quot;hello&quot;, &quot;world !!&quot; }</span>
116
- <a name="l00091"></a>00091 <span class="comment"> *</span>
117
- <a name="l00092"></a>00092 <span class="comment"> * // Send a scalar message.</span>
118
- <a name="l00093"></a>00093 <span class="comment"> * channel2.writeScalar(&quot;some long string which can contain arbitrary binary data&quot;);</span>
119
- <a name="l00094"></a>00094 <span class="comment"> * string str;</span>
120
- <a name="l00095"></a>00095 <span class="comment"> * channel1.readScalar(str);</span>
121
- <a name="l00096"></a>00096 <span class="comment"> * @endcode</span>
122
- <a name="l00097"></a>00097 <span class="comment"> *</span>
123
- <a name="l00098"></a>00098 <span class="comment"> * The life time of a MessageChannel is independent from that of the</span>
124
- <a name="l00099"></a>00099 <span class="comment"> * wrapped file descriptor. If a MessageChannel object is destroyed,</span>
125
- <a name="l00100"></a>00100 <span class="comment"> * the file descriptor is not automatically closed. Call close()</span>
126
- <a name="l00101"></a>00101 <span class="comment"> * if you want to close the file descriptor.</span>
127
- <a name="l00102"></a>00102 <span class="comment"> *</span>
128
- <a name="l00103"></a>00103 <span class="comment"> * @note I/O operations are not buffered.</span>
129
- <a name="l00104"></a>00104 <span class="comment"> * @note Be careful with mixing the sending/receiving of array messages,</span>
130
- <a name="l00105"></a>00105 <span class="comment"> * scalar messages and file descriptors. If you send a collection of any</span>
131
- <a name="l00106"></a>00106 <span class="comment"> * of these in a specific order, then the receiving side must receive them</span>
132
- <a name="l00107"></a>00107 <span class="comment"> * in the exact some order. So suppose you first send a message, then a</span>
133
- <a name="l00108"></a>00108 <span class="comment"> * file descriptor, then a scalar, then the receiving side must first</span>
134
- <a name="l00109"></a>00109 <span class="comment"> * receive a message, then a file descriptor, then a scalar. If the</span>
135
- <a name="l00110"></a>00110 <span class="comment"> * receiving side does things in the wrong order then bad things will</span>
136
- <a name="l00111"></a>00111 <span class="comment"> * happen.</span>
137
- <a name="l00112"></a>00112 <span class="comment"> * @note MessageChannel is not thread-safe, but is reentrant.</span>
138
- <a name="l00113"></a>00113 <span class="comment"> * @note Some methods throw SecurityException and TimeoutException. When these</span>
139
- <a name="l00114"></a>00114 <span class="comment"> * exceptions are thrown, the channel will be left in an inconsistent state</span>
140
- <a name="l00115"></a>00115 <span class="comment"> * because only parts of the data have been read. You should close the channel</span>
141
- <a name="l00116"></a>00116 <span class="comment"> * after having caught these exceptions.</span>
142
- <a name="l00117"></a>00117 <span class="comment"> *</span>
143
- <a name="l00118"></a>00118 <span class="comment"> * @ingroup Support</span>
144
- <a name="l00119"></a>00119 <span class="comment"> */</span>
145
- <a name="l00120"></a><a class="code" href="classPassenger_1_1MessageChannel.html">00120</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> {
146
- <a name="l00121"></a>00121 <span class="keyword">private</span>:
147
- <a name="l00122"></a>00122 <span class="keyword">const</span> <span class="keyword">static</span> <span class="keywordtype">char</span> DELIMITER = <span class="charliteral">&#39;\0&#39;</span>;
148
- <a name="l00123"></a>00123 <span class="keywordtype">int</span> fd;
149
- <a name="l00124"></a>00124
150
- <a name="l00125"></a>00125 <span class="preprocessor"> #ifdef __OpenBSD__</span>
151
- <a name="l00126"></a>00126 <span class="preprocessor"></span> <span class="keyword">typedef</span> u_int32_t uint32_t;
152
- <a name="l00127"></a>00127 <span class="keyword">typedef</span> u_int16_t uint16_t;
153
- <a name="l00128"></a>00128 <span class="preprocessor"> #endif</span>
154
- <a name="l00129"></a>00129 <span class="preprocessor"></span>
155
- <a name="l00130"></a>00130 <span class="keyword">public</span>:<span class="comment"></span>
156
- <a name="l00131"></a>00131 <span class="comment"> /**</span>
157
- <a name="l00132"></a>00132 <span class="comment"> * Construct a new MessageChannel with no underlying file descriptor.</span>
158
- <a name="l00133"></a>00133 <span class="comment"> * Thus the resulting MessageChannel object will not be usable.</span>
159
- <a name="l00134"></a>00134 <span class="comment"> * This constructor exists to allow one to declare an &quot;empty&quot;</span>
160
- <a name="l00135"></a>00135 <span class="comment"> * MessageChannel variable which is to be initialized later.</span>
161
- <a name="l00136"></a>00136 <span class="comment"> */</span>
162
- <a name="l00137"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a73e7c9a8e421d29558838176aff02ca4">00137</a> <a class="code" href="classPassenger_1_1MessageChannel.html#a73e7c9a8e421d29558838176aff02ca4" title="Construct a new MessageChannel with no underlying file descriptor.">MessageChannel</a>() {
163
- <a name="l00138"></a>00138 this-&gt;fd = -1;
164
- <a name="l00139"></a>00139 }
165
- <a name="l00140"></a>00140 <span class="comment"></span>
166
- <a name="l00141"></a>00141 <span class="comment"> /**</span>
167
- <a name="l00142"></a>00142 <span class="comment"> * Construct a new MessageChannel with the given file descriptor.</span>
168
- <a name="l00143"></a>00143 <span class="comment"> */</span>
169
- <a name="l00144"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a486b6e74c4d0973eefbcfde65f898ca7">00144</a> <a class="code" href="classPassenger_1_1MessageChannel.html#a486b6e74c4d0973eefbcfde65f898ca7" title="Construct a new MessageChannel with the given file descriptor.">MessageChannel</a>(<span class="keywordtype">int</span> fd) {
170
- <a name="l00145"></a>00145 this-&gt;fd = fd;
171
- <a name="l00146"></a>00146 }
172
- <a name="l00147"></a>00147 <span class="comment"></span>
173
- <a name="l00148"></a>00148 <span class="comment"> /**</span>
174
- <a name="l00149"></a>00149 <span class="comment"> * Returns the underlying file descriptor. -1 if it has already been closed.</span>
175
- <a name="l00150"></a>00150 <span class="comment"> */</span>
176
- <a name="l00151"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a0b1e25dd75783d9753f8a0d1dd42606a">00151</a> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a0b1e25dd75783d9753f8a0d1dd42606a" title="Returns the underlying file descriptor.">filenum</a>()<span class="keyword"> const </span>{
177
- <a name="l00152"></a>00152 <span class="keywordflow">return</span> fd;
178
- <a name="l00153"></a>00153 }
179
- <a name="l00154"></a>00154 <span class="comment"></span>
180
- <a name="l00155"></a>00155 <span class="comment"> /**</span>
181
- <a name="l00156"></a>00156 <span class="comment"> * Returns whether close() has been called.</span>
182
- <a name="l00157"></a>00157 <span class="comment"> */</span>
183
- <a name="l00158"></a><a class="code" href="classPassenger_1_1MessageChannel.html#aa5ee9617bb17bdeaba30b757ecffa1b5">00158</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#aa5ee9617bb17bdeaba30b757ecffa1b5" title="Returns whether close() has been called.">connected</a>()<span class="keyword"> const </span>{
184
- <a name="l00159"></a>00159 <span class="keywordflow">return</span> fd != -1;
185
- <a name="l00160"></a>00160 }
186
- <a name="l00161"></a>00161 <span class="comment"></span>
187
- <a name="l00162"></a>00162 <span class="comment"> /**</span>
188
- <a name="l00163"></a>00163 <span class="comment"> * Close the underlying file descriptor. If this method is called multiple</span>
189
- <a name="l00164"></a>00164 <span class="comment"> * times, the file descriptor will only be closed the first time.</span>
190
- <a name="l00165"></a>00165 <span class="comment"> *</span>
191
- <a name="l00166"></a>00166 <span class="comment"> * @throw SystemException</span>
192
- <a name="l00167"></a>00167 <span class="comment"> * @throw boost::thread_interrupted</span>
193
- <a name="l00168"></a>00168 <span class="comment"> * @post filenum() == -1</span>
194
- <a name="l00169"></a>00169 <span class="comment"> * @post !connected()</span>
195
- <a name="l00170"></a>00170 <span class="comment"> */</span>
196
- <a name="l00171"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a06309e208fc5e10642a2e9bbe0f351eb">00171</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a06309e208fc5e10642a2e9bbe0f351eb" title="Close the underlying file descriptor.">close</a>() {
197
- <a name="l00172"></a>00172 <span class="keywordflow">if</span> (fd != -1) {
198
- <a name="l00173"></a>00173 <span class="keywordtype">int</span> ret = <a class="code" href="classPassenger_1_1MessageChannel.html#a06309e208fc5e10642a2e9bbe0f351eb" title="Close the underlying file descriptor.">syscalls::close</a>(fd);
199
- <a name="l00174"></a>00174 fd = -1;
200
- <a name="l00175"></a>00175 <span class="keywordflow">if</span> (ret == -1) {
201
- <a name="l00176"></a>00176 <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">&quot;Cannot close file descriptor&quot;</span>, errno);
202
- <a name="l00177"></a>00177 }
203
- <a name="l00178"></a>00178 }
204
- <a name="l00179"></a>00179 }
205
- <a name="l00180"></a>00180 <span class="comment"></span>
206
- <a name="l00181"></a>00181 <span class="comment"> /**</span>
207
- <a name="l00182"></a>00182 <span class="comment"> * Send an array message, which consists of the given elements, over the underlying</span>
208
- <a name="l00183"></a>00183 <span class="comment"> * file descriptor.</span>
209
- <a name="l00184"></a>00184 <span class="comment"> *</span>
210
- <a name="l00185"></a>00185 <span class="comment"> * @param args An object which contains the message elements. This object must</span>
211
- <a name="l00186"></a>00186 <span class="comment"> * support STL-style iteration, and each iterator must have an</span>
212
- <a name="l00187"></a>00187 <span class="comment"> * std::string as value. Use the StringArrayType and</span>
213
- <a name="l00188"></a>00188 <span class="comment"> * StringArrayConstIteratorType template parameters to specify the exact type names.</span>
214
- <a name="l00189"></a>00189 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
215
- <a name="l00190"></a>00190 <span class="comment"> * @throws boost::thread_interrupted</span>
216
- <a name="l00191"></a>00191 <span class="comment"> * @pre None of the message elements may contain a NUL character (&lt;tt&gt;&#39;\\0&#39;&lt;/tt&gt;).</span>
217
- <a name="l00192"></a>00192 <span class="comment"> * @see read(), write(const char *, ...)</span>
218
- <a name="l00193"></a>00193 <span class="comment"> */</span>
219
- <a name="l00194"></a>00194 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> StringArrayType, <span class="keyword">typename</span> StringArrayConstIteratorType&gt;
220
- <a name="l00195"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d">00195</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="keyword">const</span> StringArrayType &amp;args) {
221
- <a name="l00196"></a>00196 StringArrayConstIteratorType it;
222
- <a name="l00197"></a>00197 <span class="keywordtype">string</span> data;
223
- <a name="l00198"></a>00198 uint16_t dataSize = 0;
224
- <a name="l00199"></a>00199
225
- <a name="l00200"></a>00200 <span class="keywordflow">for</span> (it = args.begin(); it != args.end(); it++) {
226
- <a name="l00201"></a>00201 dataSize += it-&gt;size() + 1;
227
- <a name="l00202"></a>00202 }
228
- <a name="l00203"></a>00203 data.reserve(dataSize + <span class="keyword">sizeof</span>(dataSize));
229
- <a name="l00204"></a>00204 dataSize = htons(dataSize);
230
- <a name="l00205"></a>00205 data.append((<span class="keyword">const</span> <span class="keywordtype">char</span> *) &amp;dataSize, <span class="keyword">sizeof</span>(dataSize));
231
- <a name="l00206"></a>00206 <span class="keywordflow">for</span> (it = args.begin(); it != args.end(); it++) {
232
- <a name="l00207"></a>00207 data.append(*it);
233
- <a name="l00208"></a>00208 data.append(1, DELIMITER);
234
- <a name="l00209"></a>00209 }
235
- <a name="l00210"></a>00210
236
- <a name="l00211"></a>00211 <a class="code" href="classPassenger_1_1MessageChannel.html#a069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>(data);
237
- <a name="l00212"></a>00212 }
238
- <a name="l00213"></a>00213 <span class="comment"></span>
239
- <a name="l00214"></a>00214 <span class="comment"> /**</span>
240
- <a name="l00215"></a>00215 <span class="comment"> * Send an array message, which consists of the given elements, over the underlying</span>
241
- <a name="l00216"></a>00216 <span class="comment"> * file descriptor.</span>
242
- <a name="l00217"></a>00217 <span class="comment"> *</span>
243
- <a name="l00218"></a>00218 <span class="comment"> * @param args The message elements.</span>
244
- <a name="l00219"></a>00219 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
245
- <a name="l00220"></a>00220 <span class="comment"> * @throws boost::thread_interrupted</span>
246
- <a name="l00221"></a>00221 <span class="comment"> * @pre None of the message elements may contain a NUL character (&lt;tt&gt;&#39;\\0&#39;&lt;/tt&gt;).</span>
247
- <a name="l00222"></a>00222 <span class="comment"> * @see read(), write(const char *, ...)</span>
248
- <a name="l00223"></a>00223 <span class="comment"> */</span>
249
- <a name="l00224"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a9ad7a978cf8409e01ab2f0a2b6be5a0a">00224</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="keyword">const</span> list&lt;string&gt; &amp;args) {
250
- <a name="l00225"></a>00225 write&lt;list&lt;string&gt;, list&lt;string&gt;::const_iterator&gt;(args);
251
- <a name="l00226"></a>00226 }
252
- <a name="l00227"></a>00227 <span class="comment"></span>
253
- <a name="l00228"></a>00228 <span class="comment"> /**</span>
254
- <a name="l00229"></a>00229 <span class="comment"> * Send an array message, which consists of the given elements, over the underlying</span>
255
- <a name="l00230"></a>00230 <span class="comment"> * file descriptor.</span>
256
- <a name="l00231"></a>00231 <span class="comment"> *</span>
257
- <a name="l00232"></a>00232 <span class="comment"> * @param args The message elements.</span>
258
- <a name="l00233"></a>00233 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
259
- <a name="l00234"></a>00234 <span class="comment"> * @throws boost::thread_interrupted</span>
260
- <a name="l00235"></a>00235 <span class="comment"> * @pre None of the message elements may contain a NUL character (&lt;tt&gt;&#39;\\0&#39;&lt;/tt&gt;).</span>
261
- <a name="l00236"></a>00236 <span class="comment"> * @see read(), write(const char *, ...)</span>
262
- <a name="l00237"></a>00237 <span class="comment"> */</span>
263
- <a name="l00238"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a6a9bc5d72715cb7ba0e437c8851ef487">00238</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a6a9bc5d72715cb7ba0e437c8851ef487" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="keyword">const</span> vector&lt;string&gt; &amp;args) {
264
- <a name="l00239"></a>00239 write&lt;vector&lt;string&gt;, vector&lt;string&gt;::const_iterator&gt;(args);
265
- <a name="l00240"></a>00240 }
266
- <a name="l00241"></a>00241 <span class="comment"></span>
267
- <a name="l00242"></a>00242 <span class="comment"> /**</span>
268
- <a name="l00243"></a>00243 <span class="comment"> * Send an array message, which consists of the given strings, over the underlying</span>
269
- <a name="l00244"></a>00244 <span class="comment"> * file descriptor. Like &lt;tt&gt;write(const char *name, ...)&lt;/tt&gt; but takes a va_list</span>
270
- <a name="l00245"></a>00245 <span class="comment"> * instead.</span>
271
- <a name="l00246"></a>00246 <span class="comment"> *</span>
272
- <a name="l00247"></a>00247 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
273
- <a name="l00248"></a>00248 <span class="comment"> * @throws boost::thread_interrupted</span>
274
- <a name="l00249"></a>00249 <span class="comment"> * @pre None of the message elements may contain a NUL character (&lt;tt&gt;&#39;\\0&#39;&lt;/tt&gt;).</span>
275
- <a name="l00250"></a>00250 <span class="comment"> */</span>
276
- <a name="l00251"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a70cc924c1ce7e2cedcbab61155d3aec9">00251</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a70cc924c1ce7e2cedcbab61155d3aec9" title="Send an array message, which consists of the given strings, over the underlying file...">write</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, va_list &amp;ap) {
277
- <a name="l00252"></a>00252 list&lt;string&gt; args;
278
- <a name="l00253"></a>00253 args.push_back(name);
279
- <a name="l00254"></a>00254
280
- <a name="l00255"></a>00255 <span class="keywordflow">while</span> (<span class="keyword">true</span>) {
281
- <a name="l00256"></a>00256 <span class="keyword">const</span> <span class="keywordtype">char</span> *arg = va_arg(ap, <span class="keyword">const</span> <span class="keywordtype">char</span> *);
282
- <a name="l00257"></a>00257 <span class="keywordflow">if</span> (arg == NULL) {
283
- <a name="l00258"></a>00258 <span class="keywordflow">break</span>;
284
- <a name="l00259"></a>00259 } <span class="keywordflow">else</span> {
285
- <a name="l00260"></a>00260 args.push_back(arg);
286
- <a name="l00261"></a>00261 }
287
- <a name="l00262"></a>00262 }
288
- <a name="l00263"></a>00263 <a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(args);
289
- <a name="l00264"></a>00264 }
290
- <a name="l00265"></a>00265 <span class="comment"></span>
291
- <a name="l00266"></a>00266 <span class="comment"> /**</span>
292
- <a name="l00267"></a>00267 <span class="comment"> * Send an array message, which consists of the given strings, over the underlying</span>
293
- <a name="l00268"></a>00268 <span class="comment"> * file descriptor.</span>
294
- <a name="l00269"></a>00269 <span class="comment"> *</span>
295
- <a name="l00270"></a>00270 <span class="comment"> * @param name The first element of the message to send.</span>
296
- <a name="l00271"></a>00271 <span class="comment"> * @param ... Other elements of the message. These *must* be strings, i.e. of type char*.</span>
297
- <a name="l00272"></a>00272 <span class="comment"> * It is also required to terminate this list with a NULL.</span>
298
- <a name="l00273"></a>00273 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
299
- <a name="l00274"></a>00274 <span class="comment"> * @throws boost::thread_interrupted</span>
300
- <a name="l00275"></a>00275 <span class="comment"> * @pre None of the message elements may contain a NUL character (&lt;tt&gt;&#39;\\0&#39;&lt;/tt&gt;).</span>
301
- <a name="l00276"></a>00276 <span class="comment"> * @see read(), write(const list&lt;string&gt; &amp;)</span>
302
- <a name="l00277"></a>00277 <span class="comment"> */</span>
303
- <a name="l00278"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a12cce3364023eacbe4fe09006cf3d38d">00278</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a12cce3364023eacbe4fe09006cf3d38d" title="Send an array message, which consists of the given strings, over the underlying file...">write</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, ...) {
304
- <a name="l00279"></a>00279 va_list ap;
305
- <a name="l00280"></a>00280 va_start(ap, name);
306
- <a name="l00281"></a>00281 <span class="keywordflow">try</span> {
307
- <a name="l00282"></a>00282 <a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(name, ap);
308
- <a name="l00283"></a>00283 va_end(ap);
309
- <a name="l00284"></a>00284 } <span class="keywordflow">catch</span> (...) {
310
- <a name="l00285"></a>00285 va_end(ap);
311
- <a name="l00286"></a>00286 <span class="keywordflow">throw</span>;
312
- <a name="l00287"></a>00287 }
313
- <a name="l00288"></a>00288 }
314
- <a name="l00289"></a>00289 <span class="comment"></span>
315
- <a name="l00290"></a>00290 <span class="comment"> /**</span>
316
- <a name="l00291"></a>00291 <span class="comment"> * Write a 32-bit big-endian unsigned integer to the underlying file descriptor.</span>
317
- <a name="l00292"></a>00292 <span class="comment"> *</span>
318
- <a name="l00293"></a>00293 <span class="comment"> * @throws SystemException An error occurred while writing the data to the file descriptor.</span>
319
- <a name="l00294"></a>00294 <span class="comment"> * @throws boost::thread_interrupted</span>
320
- <a name="l00295"></a>00295 <span class="comment"> */</span>
321
- <a name="l00296"></a><a class="code" href="classPassenger_1_1MessageChannel.html#abf02c51a74477650de8d5d5db661063b">00296</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#abf02c51a74477650de8d5d5db661063b" title="Write a 32-bit big-endian unsigned integer to the underlying file descriptor.">writeUint32</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> value) {
322
- <a name="l00297"></a>00297 uint32_t l = htonl(value);
323
- <a name="l00298"></a>00298 <a class="code" href="classPassenger_1_1MessageChannel.html#a069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>((<span class="keyword">const</span> <span class="keywordtype">char</span> *) &amp;l, <span class="keyword">sizeof</span>(uint32_t));
324
- <a name="l00299"></a>00299 }
325
- <a name="l00300"></a>00300 <span class="comment"></span>
326
- <a name="l00301"></a>00301 <span class="comment"> /**</span>
327
- <a name="l00302"></a>00302 <span class="comment"> * Write a scalar message to the underlying file descriptor.</span>
328
- <a name="l00303"></a>00303 <span class="comment"> *</span>
329
- <a name="l00304"></a>00304 <span class="comment"> * @note Security guarantee: this method will not copy the data in memory,</span>
330
- <a name="l00305"></a>00305 <span class="comment"> * so it&#39;s safe to use this method to write passwords to the underlying</span>
331
- <a name="l00306"></a>00306 <span class="comment"> * file descriptor.</span>
332
- <a name="l00307"></a>00307 <span class="comment"> *</span>
333
- <a name="l00308"></a>00308 <span class="comment"> * @param str The scalar message&#39;s content.</span>
334
- <a name="l00309"></a>00309 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
335
- <a name="l00310"></a>00310 <span class="comment"> * @throws boost::thread_interrupted</span>
336
- <a name="l00311"></a>00311 <span class="comment"> * @see readScalar(), writeScalar(const char *, unsigned int)</span>
337
- <a name="l00312"></a>00312 <span class="comment"> */</span>
338
- <a name="l00313"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a44e01a783c48abadeea0d915b9893bfb">00313</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a44e01a783c48abadeea0d915b9893bfb" title="Write a scalar message to the underlying file descriptor.">writeScalar</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;str) {
339
- <a name="l00314"></a>00314 <a class="code" href="classPassenger_1_1MessageChannel.html#a44e01a783c48abadeea0d915b9893bfb" title="Write a scalar message to the underlying file descriptor.">writeScalar</a>(str.c_str(), str.size());
340
- <a name="l00315"></a>00315 }
341
- <a name="l00316"></a>00316 <span class="comment"></span>
342
- <a name="l00317"></a>00317 <span class="comment"> /**</span>
343
- <a name="l00318"></a>00318 <span class="comment"> * Write a scalar message to the underlying file descriptor.</span>
344
- <a name="l00319"></a>00319 <span class="comment"> *</span>
345
- <a name="l00320"></a>00320 <span class="comment"> * @note Security guarantee: this method will not copy the data in memory,</span>
346
- <a name="l00321"></a>00321 <span class="comment"> * so it&#39;s safe to use this method to write passwords to the underlying</span>
347
- <a name="l00322"></a>00322 <span class="comment"> * file descriptor.</span>
348
- <a name="l00323"></a>00323 <span class="comment"> *</span>
349
- <a name="l00324"></a>00324 <span class="comment"> * @param data The scalar message&#39;s content.</span>
350
- <a name="l00325"></a>00325 <span class="comment"> * @param size The number of bytes in &lt;tt&gt;data&lt;/tt&gt;.</span>
351
- <a name="l00326"></a>00326 <span class="comment"> * @pre &lt;tt&gt;data != NULL&lt;/tt&gt;</span>
352
- <a name="l00327"></a>00327 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
353
- <a name="l00328"></a>00328 <span class="comment"> * @throws boost::thread_interrupted</span>
354
- <a name="l00329"></a>00329 <span class="comment"> * @see readScalar(), writeScalar(const string &amp;)</span>
355
- <a name="l00330"></a>00330 <span class="comment"> */</span>
356
- <a name="l00331"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a80977020ef895f3ea790c5d28a333dda">00331</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a80977020ef895f3ea790c5d28a333dda" title="Write a scalar message to the underlying file descriptor.">writeScalar</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
357
- <a name="l00332"></a>00332 <a class="code" href="classPassenger_1_1MessageChannel.html#abf02c51a74477650de8d5d5db661063b" title="Write a 32-bit big-endian unsigned integer to the underlying file descriptor.">writeUint32</a>(size);
358
- <a name="l00333"></a>00333 <a class="code" href="classPassenger_1_1MessageChannel.html#a069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>(data, size);
359
- <a name="l00334"></a>00334 }
360
- <a name="l00335"></a>00335 <span class="comment"></span>
361
- <a name="l00336"></a>00336 <span class="comment"> /**</span>
362
- <a name="l00337"></a>00337 <span class="comment"> * Send a block of data over the underlying file descriptor.</span>
363
- <a name="l00338"></a>00338 <span class="comment"> * This method blocks until everything is sent.</span>
364
- <a name="l00339"></a>00339 <span class="comment"> *</span>
365
- <a name="l00340"></a>00340 <span class="comment"> * @note Security guarantee: this method will not copy the data in memory,</span>
366
- <a name="l00341"></a>00341 <span class="comment"> * so it&#39;s safe to use this method to write passwords to the underlying</span>
367
- <a name="l00342"></a>00342 <span class="comment"> * file descriptor.</span>
368
- <a name="l00343"></a>00343 <span class="comment"> *</span>
369
- <a name="l00344"></a>00344 <span class="comment"> * @param data The data to send.</span>
370
- <a name="l00345"></a>00345 <span class="comment"> * @param size The number of bytes in &lt;tt&gt;data&lt;/tt&gt;.</span>
371
- <a name="l00346"></a>00346 <span class="comment"> * @pre &lt;tt&gt;data != NULL&lt;/tt&gt;</span>
372
- <a name="l00347"></a>00347 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
373
- <a name="l00348"></a>00348 <span class="comment"> * @throws boost::thread_interrupted</span>
374
- <a name="l00349"></a>00349 <span class="comment"> * @see readRaw()</span>
375
- <a name="l00350"></a>00350 <span class="comment"> */</span>
376
- <a name="l00351"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a069314e4c7e1fe8c8ab36e16d2cc5fef">00351</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
377
- <a name="l00352"></a>00352 ssize_t ret;
378
- <a name="l00353"></a>00353 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> written = 0;
379
- <a name="l00354"></a>00354 <span class="keywordflow">do</span> {
380
- <a name="l00355"></a>00355 ret = <a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">syscalls::write</a>(fd, data + written, size - written);
381
- <a name="l00356"></a>00356 <span class="keywordflow">if</span> (ret == -1) {
382
- <a name="l00357"></a>00357 <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">&quot;write() failed&quot;</span>, errno);
383
- <a name="l00358"></a>00358 } <span class="keywordflow">else</span> {
384
- <a name="l00359"></a>00359 written += ret;
385
- <a name="l00360"></a>00360 }
386
- <a name="l00361"></a>00361 } <span class="keywordflow">while</span> (written &lt; size);
387
- <a name="l00362"></a>00362 }
388
- <a name="l00363"></a>00363 <span class="comment"></span>
389
- <a name="l00364"></a>00364 <span class="comment"> /**</span>
390
- <a name="l00365"></a>00365 <span class="comment"> * Send a block of data over the underlying file descriptor.</span>
391
- <a name="l00366"></a>00366 <span class="comment"> * This method blocks until everything is sent.</span>
392
- <a name="l00367"></a>00367 <span class="comment"> *</span>
393
- <a name="l00368"></a>00368 <span class="comment"> * @note Security guarantee: this method will not copy the data in memory,</span>
394
- <a name="l00369"></a>00369 <span class="comment"> * so it&#39;s safe to use this method to write passwords to the underlying</span>
395
- <a name="l00370"></a>00370 <span class="comment"> * file descriptor.</span>
396
- <a name="l00371"></a>00371 <span class="comment"> *</span>
397
- <a name="l00372"></a>00372 <span class="comment"> * @param data The data to send.</span>
398
- <a name="l00373"></a>00373 <span class="comment"> * @pre &lt;tt&gt;data != NULL&lt;/tt&gt;</span>
399
- <a name="l00374"></a>00374 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
400
- <a name="l00375"></a>00375 <span class="comment"> * @throws boost::thread_interrupted</span>
401
- <a name="l00376"></a>00376 <span class="comment"> */</span>
402
- <a name="l00377"></a><a class="code" href="classPassenger_1_1MessageChannel.html#acfa38f4f0e22ec16350b8cc159e8e364">00377</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#acfa38f4f0e22ec16350b8cc159e8e364" title="Send a block of data over the underlying file descriptor.">writeRaw</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;data) {
403
- <a name="l00378"></a>00378 <a class="code" href="classPassenger_1_1MessageChannel.html#a069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>(data.c_str(), data.size());
404
- <a name="l00379"></a>00379 }
405
- <a name="l00380"></a>00380 <span class="comment"></span>
406
- <a name="l00381"></a>00381 <span class="comment"> /**</span>
407
- <a name="l00382"></a>00382 <span class="comment"> * Pass a file descriptor. This only works if the underlying file</span>
408
- <a name="l00383"></a>00383 <span class="comment"> * descriptor is a Unix socket.</span>
409
- <a name="l00384"></a>00384 <span class="comment"> *</span>
410
- <a name="l00385"></a>00385 <span class="comment"> * @param fileDescriptor The file descriptor to pass.</span>
411
- <a name="l00386"></a>00386 <span class="comment"> * @param negotiate See Ruby&#39;s MessageChannel#send_io method&#39;s comments.</span>
412
- <a name="l00387"></a>00387 <span class="comment"> * @throws SystemException Something went wrong during file descriptor passing.</span>
413
- <a name="l00388"></a>00388 <span class="comment"> * @throws boost::thread_interrupted</span>
414
- <a name="l00389"></a>00389 <span class="comment"> * @pre &lt;tt&gt;fileDescriptor &gt;= 0&lt;/tt&gt;</span>
415
- <a name="l00390"></a>00390 <span class="comment"> * @see readFileDescriptor()</span>
416
- <a name="l00391"></a>00391 <span class="comment"> */</span>
417
- <a name="l00392"></a><a class="code" href="classPassenger_1_1MessageChannel.html#ae0c558e07dcc91900016773b2bec38d8">00392</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#ae0c558e07dcc91900016773b2bec38d8" title="Pass a file descriptor.">writeFileDescriptor</a>(<span class="keywordtype">int</span> fileDescriptor, <span class="keywordtype">bool</span> negotiate = <span class="keyword">true</span>) {
418
- <a name="l00393"></a>00393 <span class="comment">// See message_channel.rb for more info about negotiation.</span>
419
- <a name="l00394"></a>00394 <span class="keywordflow">if</span> (negotiate) {
420
- <a name="l00395"></a>00395 vector&lt;string&gt; args;
421
- <a name="l00396"></a>00396
422
- <a name="l00397"></a>00397 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">read</a>(args)) {
423
- <a name="l00398"></a>00398 <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">&quot;Unexpected end of stream encountered while pre-negotiating a file descriptor&quot;</span>);
424
- <a name="l00399"></a>00399 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (args.size() != 1 || args[0] != <span class="stringliteral">&quot;pass IO&quot;</span>) {
425
- <a name="l00400"></a>00400 <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">&quot;FD passing pre-negotiation message expected.&quot;</span>);
426
- <a name="l00401"></a>00401 }
427
- <a name="l00402"></a>00402 }
428
- <a name="l00403"></a>00403
429
- <a name="l00404"></a>00404 <span class="keyword">struct </span>msghdr msg;
430
- <a name="l00405"></a>00405 <span class="keyword">struct </span>iovec vec;
431
- <a name="l00406"></a>00406 <span class="keywordtype">char</span> dummy[1];
432
- <a name="l00407"></a>00407 <span class="preprocessor"> #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
433
- <a name="l00408"></a>00408 <span class="preprocessor"></span> <span class="keyword">struct </span>{
434
- <a name="l00409"></a>00409 <span class="keyword">struct </span>cmsghdr header;
435
- <a name="l00410"></a>00410 <span class="keywordtype">int</span> fd;
436
- <a name="l00411"></a>00411 } control_data;
437
- <a name="l00412"></a>00412 <span class="preprocessor"> #else</span>
438
- <a name="l00413"></a>00413 <span class="preprocessor"></span> <span class="keywordtype">char</span> control_data[CMSG_SPACE(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>))];
439
- <a name="l00414"></a>00414 <span class="preprocessor"> #endif</span>
440
- <a name="l00415"></a>00415 <span class="preprocessor"></span> <span class="keyword">struct </span>cmsghdr *control_header;
441
- <a name="l00416"></a>00416 <span class="keywordtype">int</span> ret;
442
- <a name="l00417"></a>00417
443
- <a name="l00418"></a>00418 msg.msg_name = NULL;
444
- <a name="l00419"></a>00419 msg.msg_namelen = 0;
445
- <a name="l00420"></a>00420
446
- <a name="l00421"></a>00421 <span class="comment">/* Linux and Solaris require msg_iov to be non-NULL. */</span>
447
- <a name="l00422"></a>00422 dummy[0] = <span class="charliteral">&#39;\0&#39;</span>;
448
- <a name="l00423"></a>00423 vec.iov_base = dummy;
449
- <a name="l00424"></a>00424 vec.iov_len = <span class="keyword">sizeof</span>(dummy);
450
- <a name="l00425"></a>00425 msg.msg_iov = &amp;vec;
451
- <a name="l00426"></a>00426 msg.msg_iovlen = 1;
452
- <a name="l00427"></a>00427
453
- <a name="l00428"></a>00428 msg.msg_control = (caddr_t) &amp;control_data;
454
- <a name="l00429"></a>00429 msg.msg_controllen = <span class="keyword">sizeof</span>(control_data);
455
- <a name="l00430"></a>00430 msg.msg_flags = 0;
82
+ <a name="l00057"></a>00057 <span class="keyword">namespace </span>Passenger {
83
+ <a name="l00058"></a>00058
84
+ <a name="l00059"></a>00059 <span class="keyword">using namespace </span>std;
85
+ <a name="l00060"></a>00060 <span class="keyword">using namespace </span>oxt;
86
+ <a name="l00061"></a>00061
87
+ <a name="l00062"></a>00062 <span class="comment"></span>
88
+ <a name="l00063"></a>00063 <span class="comment">/**</span>
89
+ <a name="l00064"></a>00064 <span class="comment"> * Convenience class for I/O operations on file descriptors.</span>
90
+ <a name="l00065"></a>00065 <span class="comment"> *</span>
91
+ <a name="l00066"></a>00066 <span class="comment"> * This class provides convenience methods for:</span>
92
+ <a name="l00067"></a>00067 <span class="comment"> * - sending and receiving raw data over a file descriptor.</span>
93
+ <a name="l00068"></a>00068 <span class="comment"> * - sending and receiving messages over a file descriptor.</span>
94
+ <a name="l00069"></a>00069 <span class="comment"> * - file descriptor passing over a Unix socket.</span>
95
+ <a name="l00070"></a>00070 <span class="comment"> * - data size limit enforcement and time constraint enforcement.</span>
96
+ <a name="l00071"></a>00071 <span class="comment"> * All of these methods use exceptions for error reporting.</span>
97
+ <a name="l00072"></a>00072 <span class="comment"> *</span>
98
+ <a name="l00073"></a>00073 <span class="comment"> * There are two kinds of messages:</span>
99
+ <a name="l00074"></a>00074 <span class="comment"> * - Array messages. These are just a list of strings, and the message</span>
100
+ <a name="l00075"></a>00075 <span class="comment"> * itself has a specific length. The contained strings may not</span>
101
+ <a name="l00076"></a>00076 <span class="comment"> * contain NUL characters (&lt;tt&gt;&#39;\\0&#39;&lt;/tt&gt;). Note that an array message</span>
102
+ <a name="l00077"></a>00077 <span class="comment"> * must have at least one element.</span>
103
+ <a name="l00078"></a>00078 <span class="comment"> * - Scalar messages. These are byte strings which may contain arbitrary</span>
104
+ <a name="l00079"></a>00079 <span class="comment"> * binary data. Scalar messages also have a specific length.</span>
105
+ <a name="l00080"></a>00080 <span class="comment"> * The protocol is designed to be low overhead, easy to implement and</span>
106
+ <a name="l00081"></a>00081 <span class="comment"> * easy to parse.</span>
107
+ <a name="l00082"></a>00082 <span class="comment"> *</span>
108
+ <a name="l00083"></a>00083 <span class="comment"> * MessageChannel is to be wrapped around a file descriptor. For example:</span>
109
+ <a name="l00084"></a>00084 <span class="comment"> * @code</span>
110
+ <a name="l00085"></a>00085 <span class="comment"> * int p[2];</span>
111
+ <a name="l00086"></a>00086 <span class="comment"> * pipe(p);</span>
112
+ <a name="l00087"></a>00087 <span class="comment"> * MessageChannel channel1(p[0]);</span>
113
+ <a name="l00088"></a>00088 <span class="comment"> * MessageChannel channel2(p[1]);</span>
114
+ <a name="l00089"></a>00089 <span class="comment"> * </span>
115
+ <a name="l00090"></a>00090 <span class="comment"> * // Send an array message.</span>
116
+ <a name="l00091"></a>00091 <span class="comment"> * channel2.write(&quot;hello&quot;, &quot;world !!&quot;, NULL);</span>
117
+ <a name="l00092"></a>00092 <span class="comment"> * list&lt;string&gt; args;</span>
118
+ <a name="l00093"></a>00093 <span class="comment"> * channel1.read(args); // args now contains { &quot;hello&quot;, &quot;world !!&quot; }</span>
119
+ <a name="l00094"></a>00094 <span class="comment"> *</span>
120
+ <a name="l00095"></a>00095 <span class="comment"> * // Send a scalar message.</span>
121
+ <a name="l00096"></a>00096 <span class="comment"> * channel2.writeScalar(&quot;some long string which can contain arbitrary binary data&quot;);</span>
122
+ <a name="l00097"></a>00097 <span class="comment"> * string str;</span>
123
+ <a name="l00098"></a>00098 <span class="comment"> * channel1.readScalar(str);</span>
124
+ <a name="l00099"></a>00099 <span class="comment"> * @endcode</span>
125
+ <a name="l00100"></a>00100 <span class="comment"> *</span>
126
+ <a name="l00101"></a>00101 <span class="comment"> * The life time of a MessageChannel is independent from that of the</span>
127
+ <a name="l00102"></a>00102 <span class="comment"> * wrapped file descriptor. If a MessageChannel object is destroyed,</span>
128
+ <a name="l00103"></a>00103 <span class="comment"> * the file descriptor is not automatically closed. Call close()</span>
129
+ <a name="l00104"></a>00104 <span class="comment"> * if you want to close the file descriptor.</span>
130
+ <a name="l00105"></a>00105 <span class="comment"> *</span>
131
+ <a name="l00106"></a>00106 <span class="comment"> * @note I/O operations are not buffered.</span>
132
+ <a name="l00107"></a>00107 <span class="comment"> * @note Be careful with mixing the sending/receiving of array messages,</span>
133
+ <a name="l00108"></a>00108 <span class="comment"> * scalar messages and file descriptors. If you send a collection of any</span>
134
+ <a name="l00109"></a>00109 <span class="comment"> * of these in a specific order, then the receiving side must receive them</span>
135
+ <a name="l00110"></a>00110 <span class="comment"> * in the exact some order. So suppose you first send a message, then a</span>
136
+ <a name="l00111"></a>00111 <span class="comment"> * file descriptor, then a scalar, then the receiving side must first</span>
137
+ <a name="l00112"></a>00112 <span class="comment"> * receive a message, then a file descriptor, then a scalar. If the</span>
138
+ <a name="l00113"></a>00113 <span class="comment"> * receiving side does things in the wrong order then bad things will</span>
139
+ <a name="l00114"></a>00114 <span class="comment"> * happen.</span>
140
+ <a name="l00115"></a>00115 <span class="comment"> * @note MessageChannel is not thread-safe, but is reentrant.</span>
141
+ <a name="l00116"></a>00116 <span class="comment"> * @note Some methods throw SecurityException and TimeoutException. When these</span>
142
+ <a name="l00117"></a>00117 <span class="comment"> * exceptions are thrown, the channel will be left in an inconsistent state</span>
143
+ <a name="l00118"></a>00118 <span class="comment"> * because only parts of the data have been read. You should close the channel</span>
144
+ <a name="l00119"></a>00119 <span class="comment"> * after having caught these exceptions.</span>
145
+ <a name="l00120"></a>00120 <span class="comment"> *</span>
146
+ <a name="l00121"></a>00121 <span class="comment"> * @ingroup Support</span>
147
+ <a name="l00122"></a>00122 <span class="comment"> */</span>
148
+ <a name="l00123"></a><a class="code" href="classPassenger_1_1MessageChannel.html">00123</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> {
149
+ <a name="l00124"></a>00124 <span class="keyword">private</span>:
150
+ <a name="l00125"></a>00125 <span class="keyword">const</span> <span class="keyword">static</span> <span class="keywordtype">char</span> DELIMITER = <span class="charliteral">&#39;\0&#39;</span>;
151
+ <a name="l00126"></a>00126 <span class="keywordtype">int</span> fd;
152
+ <a name="l00127"></a>00127
153
+ <a name="l00128"></a>00128 <span class="preprocessor"> #ifdef __OpenBSD__</span>
154
+ <a name="l00129"></a>00129 <span class="preprocessor"></span> <span class="keyword">typedef</span> u_int32_t uint32_t;
155
+ <a name="l00130"></a>00130 <span class="keyword">typedef</span> u_int16_t uint16_t;
156
+ <a name="l00131"></a>00131 <span class="preprocessor"> #endif</span>
157
+ <a name="l00132"></a>00132 <span class="preprocessor"></span>
158
+ <a name="l00133"></a>00133 <span class="keyword">public</span>:<span class="comment"></span>
159
+ <a name="l00134"></a>00134 <span class="comment"> /**</span>
160
+ <a name="l00135"></a>00135 <span class="comment"> * Construct a new MessageChannel with no underlying file descriptor.</span>
161
+ <a name="l00136"></a>00136 <span class="comment"> * Thus the resulting MessageChannel object will not be usable.</span>
162
+ <a name="l00137"></a>00137 <span class="comment"> * This constructor exists to allow one to declare an &quot;empty&quot;</span>
163
+ <a name="l00138"></a>00138 <span class="comment"> * MessageChannel variable which is to be initialized later.</span>
164
+ <a name="l00139"></a>00139 <span class="comment"> */</span>
165
+ <a name="l00140"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a73e7c9a8e421d29558838176aff02ca4">00140</a> <a class="code" href="classPassenger_1_1MessageChannel.html#a73e7c9a8e421d29558838176aff02ca4" title="Construct a new MessageChannel with no underlying file descriptor.">MessageChannel</a>() {
166
+ <a name="l00141"></a>00141 this-&gt;fd = -1;
167
+ <a name="l00142"></a>00142 }
168
+ <a name="l00143"></a>00143 <span class="comment"></span>
169
+ <a name="l00144"></a>00144 <span class="comment"> /**</span>
170
+ <a name="l00145"></a>00145 <span class="comment"> * Construct a new MessageChannel with the given file descriptor.</span>
171
+ <a name="l00146"></a>00146 <span class="comment"> */</span>
172
+ <a name="l00147"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a486b6e74c4d0973eefbcfde65f898ca7">00147</a> <a class="code" href="classPassenger_1_1MessageChannel.html#a486b6e74c4d0973eefbcfde65f898ca7" title="Construct a new MessageChannel with the given file descriptor.">MessageChannel</a>(<span class="keywordtype">int</span> fd) {
173
+ <a name="l00148"></a>00148 this-&gt;fd = fd;
174
+ <a name="l00149"></a>00149 }
175
+ <a name="l00150"></a>00150 <span class="comment"></span>
176
+ <a name="l00151"></a>00151 <span class="comment"> /**</span>
177
+ <a name="l00152"></a>00152 <span class="comment"> * Returns the underlying file descriptor. -1 if it has already been closed.</span>
178
+ <a name="l00153"></a>00153 <span class="comment"> */</span>
179
+ <a name="l00154"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a0b1e25dd75783d9753f8a0d1dd42606a">00154</a> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a0b1e25dd75783d9753f8a0d1dd42606a" title="Returns the underlying file descriptor.">filenum</a>()<span class="keyword"> const </span>{
180
+ <a name="l00155"></a>00155 <span class="keywordflow">return</span> fd;
181
+ <a name="l00156"></a>00156 }
182
+ <a name="l00157"></a>00157 <span class="comment"></span>
183
+ <a name="l00158"></a>00158 <span class="comment"> /**</span>
184
+ <a name="l00159"></a>00159 <span class="comment"> * Returns whether close() has been called.</span>
185
+ <a name="l00160"></a>00160 <span class="comment"> */</span>
186
+ <a name="l00161"></a><a class="code" href="classPassenger_1_1MessageChannel.html#aa5ee9617bb17bdeaba30b757ecffa1b5">00161</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#aa5ee9617bb17bdeaba30b757ecffa1b5" title="Returns whether close() has been called.">connected</a>()<span class="keyword"> const </span>{
187
+ <a name="l00162"></a>00162 <span class="keywordflow">return</span> fd != -1;
188
+ <a name="l00163"></a>00163 }
189
+ <a name="l00164"></a>00164 <span class="comment"></span>
190
+ <a name="l00165"></a>00165 <span class="comment"> /**</span>
191
+ <a name="l00166"></a>00166 <span class="comment"> * Close the underlying file descriptor. If this method is called multiple</span>
192
+ <a name="l00167"></a>00167 <span class="comment"> * times, the file descriptor will only be closed the first time.</span>
193
+ <a name="l00168"></a>00168 <span class="comment"> *</span>
194
+ <a name="l00169"></a>00169 <span class="comment"> * @throw SystemException</span>
195
+ <a name="l00170"></a>00170 <span class="comment"> * @throw boost::thread_interrupted</span>
196
+ <a name="l00171"></a>00171 <span class="comment"> * @post filenum() == -1</span>
197
+ <a name="l00172"></a>00172 <span class="comment"> * @post !connected()</span>
198
+ <a name="l00173"></a>00173 <span class="comment"> */</span>
199
+ <a name="l00174"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a06309e208fc5e10642a2e9bbe0f351eb">00174</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a06309e208fc5e10642a2e9bbe0f351eb" title="Close the underlying file descriptor.">close</a>() {
200
+ <a name="l00175"></a>00175 <span class="keywordflow">if</span> (fd != -1) {
201
+ <a name="l00176"></a>00176 <span class="keywordtype">int</span> ret = <a class="code" href="classPassenger_1_1MessageChannel.html#a06309e208fc5e10642a2e9bbe0f351eb" title="Close the underlying file descriptor.">syscalls::close</a>(fd);
202
+ <a name="l00177"></a>00177 fd = -1;
203
+ <a name="l00178"></a>00178 <span class="keywordflow">if</span> (ret == -1) {
204
+ <a name="l00179"></a>00179 <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">&quot;Cannot close file descriptor&quot;</span>, errno);
205
+ <a name="l00180"></a>00180 }
206
+ <a name="l00181"></a>00181 }
207
+ <a name="l00182"></a>00182 }
208
+ <a name="l00183"></a>00183 <span class="comment"></span>
209
+ <a name="l00184"></a>00184 <span class="comment"> /**</span>
210
+ <a name="l00185"></a>00185 <span class="comment"> * Send an array message, which consists of the given elements, over the underlying</span>
211
+ <a name="l00186"></a>00186 <span class="comment"> * file descriptor.</span>
212
+ <a name="l00187"></a>00187 <span class="comment"> *</span>
213
+ <a name="l00188"></a>00188 <span class="comment"> * @param args An object which contains the message elements. This object must</span>
214
+ <a name="l00189"></a>00189 <span class="comment"> * support STL-style iteration, and each iterator must have an</span>
215
+ <a name="l00190"></a>00190 <span class="comment"> * std::string as value. Use the StringArrayType and</span>
216
+ <a name="l00191"></a>00191 <span class="comment"> * StringArrayConstIteratorType template parameters to specify the exact type names.</span>
217
+ <a name="l00192"></a>00192 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
218
+ <a name="l00193"></a>00193 <span class="comment"> * @throws boost::thread_interrupted</span>
219
+ <a name="l00194"></a>00194 <span class="comment"> * @pre None of the message elements may contain a NUL character (&lt;tt&gt;&#39;\\0&#39;&lt;/tt&gt;).</span>
220
+ <a name="l00195"></a>00195 <span class="comment"> * @see read(), write(const char *, ...)</span>
221
+ <a name="l00196"></a>00196 <span class="comment"> */</span>
222
+ <a name="l00197"></a>00197 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> StringArrayType, <span class="keyword">typename</span> StringArrayConstIteratorType&gt;
223
+ <a name="l00198"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d">00198</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="keyword">const</span> StringArrayType &amp;args) {
224
+ <a name="l00199"></a>00199 StringArrayConstIteratorType it;
225
+ <a name="l00200"></a>00200 <span class="keywordtype">string</span> data;
226
+ <a name="l00201"></a>00201 uint16_t dataSize = 0;
227
+ <a name="l00202"></a>00202
228
+ <a name="l00203"></a>00203 <span class="keywordflow">for</span> (it = args.begin(); it != args.end(); it++) {
229
+ <a name="l00204"></a>00204 dataSize += it-&gt;size() + 1;
230
+ <a name="l00205"></a>00205 }
231
+ <a name="l00206"></a>00206 data.reserve(dataSize + <span class="keyword">sizeof</span>(dataSize));
232
+ <a name="l00207"></a>00207 dataSize = htons(dataSize);
233
+ <a name="l00208"></a>00208 data.append((<span class="keyword">const</span> <span class="keywordtype">char</span> *) &amp;dataSize, <span class="keyword">sizeof</span>(dataSize));
234
+ <a name="l00209"></a>00209 <span class="keywordflow">for</span> (it = args.begin(); it != args.end(); it++) {
235
+ <a name="l00210"></a>00210 data.append(*it);
236
+ <a name="l00211"></a>00211 data.append(1, DELIMITER);
237
+ <a name="l00212"></a>00212 }
238
+ <a name="l00213"></a>00213
239
+ <a name="l00214"></a>00214 writeExact(fd, data);
240
+ <a name="l00215"></a>00215 }
241
+ <a name="l00216"></a>00216 <span class="comment"></span>
242
+ <a name="l00217"></a>00217 <span class="comment"> /**</span>
243
+ <a name="l00218"></a>00218 <span class="comment"> * Send an array message, which consists of the given elements, over the underlying</span>
244
+ <a name="l00219"></a>00219 <span class="comment"> * file descriptor.</span>
245
+ <a name="l00220"></a>00220 <span class="comment"> *</span>
246
+ <a name="l00221"></a>00221 <span class="comment"> * @param args The message elements.</span>
247
+ <a name="l00222"></a>00222 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
248
+ <a name="l00223"></a>00223 <span class="comment"> * @throws boost::thread_interrupted</span>
249
+ <a name="l00224"></a>00224 <span class="comment"> * @pre None of the message elements may contain a NUL character (&lt;tt&gt;&#39;\\0&#39;&lt;/tt&gt;).</span>
250
+ <a name="l00225"></a>00225 <span class="comment"> * @see read(), write(const char *, ...)</span>
251
+ <a name="l00226"></a>00226 <span class="comment"> */</span>
252
+ <a name="l00227"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a9ad7a978cf8409e01ab2f0a2b6be5a0a">00227</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="keyword">const</span> list&lt;string&gt; &amp;args) {
253
+ <a name="l00228"></a>00228 write&lt;list&lt;string&gt;, list&lt;string&gt;::const_iterator&gt;(args);
254
+ <a name="l00229"></a>00229 }
255
+ <a name="l00230"></a>00230 <span class="comment"></span>
256
+ <a name="l00231"></a>00231 <span class="comment"> /**</span>
257
+ <a name="l00232"></a>00232 <span class="comment"> * Send an array message, which consists of the given elements, over the underlying</span>
258
+ <a name="l00233"></a>00233 <span class="comment"> * file descriptor.</span>
259
+ <a name="l00234"></a>00234 <span class="comment"> *</span>
260
+ <a name="l00235"></a>00235 <span class="comment"> * @param args The message elements.</span>
261
+ <a name="l00236"></a>00236 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
262
+ <a name="l00237"></a>00237 <span class="comment"> * @throws boost::thread_interrupted</span>
263
+ <a name="l00238"></a>00238 <span class="comment"> * @pre None of the message elements may contain a NUL character (&lt;tt&gt;&#39;\\0&#39;&lt;/tt&gt;).</span>
264
+ <a name="l00239"></a>00239 <span class="comment"> * @see read(), write(const char *, ...)</span>
265
+ <a name="l00240"></a>00240 <span class="comment"> */</span>
266
+ <a name="l00241"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a6a9bc5d72715cb7ba0e437c8851ef487">00241</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a6a9bc5d72715cb7ba0e437c8851ef487" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="keyword">const</span> vector&lt;string&gt; &amp;args) {
267
+ <a name="l00242"></a>00242 write&lt;vector&lt;string&gt;, vector&lt;string&gt;::const_iterator&gt;(args);
268
+ <a name="l00243"></a>00243 }
269
+ <a name="l00244"></a>00244 <span class="comment"></span>
270
+ <a name="l00245"></a>00245 <span class="comment"> /**</span>
271
+ <a name="l00246"></a>00246 <span class="comment"> * Send an array message, which consists of the given strings, over the underlying</span>
272
+ <a name="l00247"></a>00247 <span class="comment"> * file descriptor. Like &lt;tt&gt;write(const char *name, ...)&lt;/tt&gt; but takes a va_list</span>
273
+ <a name="l00248"></a>00248 <span class="comment"> * instead.</span>
274
+ <a name="l00249"></a>00249 <span class="comment"> *</span>
275
+ <a name="l00250"></a>00250 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
276
+ <a name="l00251"></a>00251 <span class="comment"> * @throws boost::thread_interrupted</span>
277
+ <a name="l00252"></a>00252 <span class="comment"> * @pre None of the message elements may contain a NUL character (&lt;tt&gt;&#39;\\0&#39;&lt;/tt&gt;).</span>
278
+ <a name="l00253"></a>00253 <span class="comment"> */</span>
279
+ <a name="l00254"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a70cc924c1ce7e2cedcbab61155d3aec9">00254</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a70cc924c1ce7e2cedcbab61155d3aec9" title="Send an array message, which consists of the given strings, over the underlying file...">write</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, va_list &amp;ap) {
280
+ <a name="l00255"></a>00255 list&lt;string&gt; args;
281
+ <a name="l00256"></a>00256 args.push_back(name);
282
+ <a name="l00257"></a>00257
283
+ <a name="l00258"></a>00258 <span class="keywordflow">while</span> (<span class="keyword">true</span>) {
284
+ <a name="l00259"></a>00259 <span class="keyword">const</span> <span class="keywordtype">char</span> *arg = va_arg(ap, <span class="keyword">const</span> <span class="keywordtype">char</span> *);
285
+ <a name="l00260"></a>00260 <span class="keywordflow">if</span> (arg == NULL) {
286
+ <a name="l00261"></a>00261 <span class="keywordflow">break</span>;
287
+ <a name="l00262"></a>00262 } <span class="keywordflow">else</span> {
288
+ <a name="l00263"></a>00263 args.push_back(arg);
289
+ <a name="l00264"></a>00264 }
290
+ <a name="l00265"></a>00265 }
291
+ <a name="l00266"></a>00266 <a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(args);
292
+ <a name="l00267"></a>00267 }
293
+ <a name="l00268"></a>00268 <span class="comment"></span>
294
+ <a name="l00269"></a>00269 <span class="comment"> /**</span>
295
+ <a name="l00270"></a>00270 <span class="comment"> * Send an array message, which consists of the given strings, over the underlying</span>
296
+ <a name="l00271"></a>00271 <span class="comment"> * file descriptor.</span>
297
+ <a name="l00272"></a>00272 <span class="comment"> *</span>
298
+ <a name="l00273"></a>00273 <span class="comment"> * @param name The first element of the message to send.</span>
299
+ <a name="l00274"></a>00274 <span class="comment"> * @param ... Other elements of the message. These *must* be strings, i.e. of type char*.</span>
300
+ <a name="l00275"></a>00275 <span class="comment"> * It is also required to terminate this list with a NULL.</span>
301
+ <a name="l00276"></a>00276 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
302
+ <a name="l00277"></a>00277 <span class="comment"> * @throws boost::thread_interrupted</span>
303
+ <a name="l00278"></a>00278 <span class="comment"> * @pre None of the message elements may contain a NUL character (&lt;tt&gt;&#39;\\0&#39;&lt;/tt&gt;).</span>
304
+ <a name="l00279"></a>00279 <span class="comment"> * @see read(), write(const list&lt;string&gt; &amp;)</span>
305
+ <a name="l00280"></a>00280 <span class="comment"> */</span>
306
+ <a name="l00281"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a12cce3364023eacbe4fe09006cf3d38d">00281</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a12cce3364023eacbe4fe09006cf3d38d" title="Send an array message, which consists of the given strings, over the underlying file...">write</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, ...) {
307
+ <a name="l00282"></a>00282 va_list ap;
308
+ <a name="l00283"></a>00283 va_start(ap, name);
309
+ <a name="l00284"></a>00284 <span class="keywordflow">try</span> {
310
+ <a name="l00285"></a>00285 <a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(name, ap);
311
+ <a name="l00286"></a>00286 va_end(ap);
312
+ <a name="l00287"></a>00287 } <span class="keywordflow">catch</span> (...) {
313
+ <a name="l00288"></a>00288 va_end(ap);
314
+ <a name="l00289"></a>00289 <span class="keywordflow">throw</span>;
315
+ <a name="l00290"></a>00290 }
316
+ <a name="l00291"></a>00291 }
317
+ <a name="l00292"></a>00292 <span class="comment"></span>
318
+ <a name="l00293"></a>00293 <span class="comment"> /**</span>
319
+ <a name="l00294"></a>00294 <span class="comment"> * Write a 32-bit big-endian unsigned integer to the underlying file descriptor.</span>
320
+ <a name="l00295"></a>00295 <span class="comment"> *</span>
321
+ <a name="l00296"></a>00296 <span class="comment"> * @throws SystemException An error occurred while writing the data to the file descriptor.</span>
322
+ <a name="l00297"></a>00297 <span class="comment"> * @throws boost::thread_interrupted</span>
323
+ <a name="l00298"></a>00298 <span class="comment"> */</span>
324
+ <a name="l00299"></a><a class="code" href="classPassenger_1_1MessageChannel.html#abf02c51a74477650de8d5d5db661063b">00299</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#abf02c51a74477650de8d5d5db661063b" title="Write a 32-bit big-endian unsigned integer to the underlying file descriptor.">writeUint32</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> value) {
325
+ <a name="l00300"></a>00300 uint32_t l = htonl(value);
326
+ <a name="l00301"></a>00301 writeExact(fd, &amp;l, <span class="keyword">sizeof</span>(uint32_t));
327
+ <a name="l00302"></a>00302 }
328
+ <a name="l00303"></a>00303 <span class="comment"></span>
329
+ <a name="l00304"></a>00304 <span class="comment"> /**</span>
330
+ <a name="l00305"></a>00305 <span class="comment"> * Write a scalar message to the underlying file descriptor.</span>
331
+ <a name="l00306"></a>00306 <span class="comment"> *</span>
332
+ <a name="l00307"></a>00307 <span class="comment"> * @note Security guarantee: this method will not copy the data in memory,</span>
333
+ <a name="l00308"></a>00308 <span class="comment"> * so it&#39;s safe to use this method to write passwords to the underlying</span>
334
+ <a name="l00309"></a>00309 <span class="comment"> * file descriptor.</span>
335
+ <a name="l00310"></a>00310 <span class="comment"> *</span>
336
+ <a name="l00311"></a>00311 <span class="comment"> * @param str The scalar message&#39;s content.</span>
337
+ <a name="l00312"></a>00312 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
338
+ <a name="l00313"></a>00313 <span class="comment"> * @throws boost::thread_interrupted</span>
339
+ <a name="l00314"></a>00314 <span class="comment"> * @see readScalar(), writeScalar(const char *, unsigned int)</span>
340
+ <a name="l00315"></a>00315 <span class="comment"> */</span>
341
+ <a name="l00316"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a44e01a783c48abadeea0d915b9893bfb">00316</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a44e01a783c48abadeea0d915b9893bfb" title="Write a scalar message to the underlying file descriptor.">writeScalar</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;str) {
342
+ <a name="l00317"></a>00317 <a class="code" href="classPassenger_1_1MessageChannel.html#a44e01a783c48abadeea0d915b9893bfb" title="Write a scalar message to the underlying file descriptor.">writeScalar</a>(str.c_str(), str.size());
343
+ <a name="l00318"></a>00318 }
344
+ <a name="l00319"></a>00319 <span class="comment"></span>
345
+ <a name="l00320"></a>00320 <span class="comment"> /**</span>
346
+ <a name="l00321"></a>00321 <span class="comment"> * Write a scalar message to the underlying file descriptor.</span>
347
+ <a name="l00322"></a>00322 <span class="comment"> *</span>
348
+ <a name="l00323"></a>00323 <span class="comment"> * @note Security guarantee: this method will not copy the data in memory,</span>
349
+ <a name="l00324"></a>00324 <span class="comment"> * so it&#39;s safe to use this method to write passwords to the underlying</span>
350
+ <a name="l00325"></a>00325 <span class="comment"> * file descriptor.</span>
351
+ <a name="l00326"></a>00326 <span class="comment"> *</span>
352
+ <a name="l00327"></a>00327 <span class="comment"> * @param data The scalar message&#39;s content.</span>
353
+ <a name="l00328"></a>00328 <span class="comment"> * @param size The number of bytes in &lt;tt&gt;data&lt;/tt&gt;.</span>
354
+ <a name="l00329"></a>00329 <span class="comment"> * @pre &lt;tt&gt;data != NULL&lt;/tt&gt;</span>
355
+ <a name="l00330"></a>00330 <span class="comment"> * @throws SystemException An error occured while writing the data to the file descriptor.</span>
356
+ <a name="l00331"></a>00331 <span class="comment"> * @throws boost::thread_interrupted</span>
357
+ <a name="l00332"></a>00332 <span class="comment"> * @see readScalar(), writeScalar(const string &amp;)</span>
358
+ <a name="l00333"></a>00333 <span class="comment"> */</span>
359
+ <a name="l00334"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a80977020ef895f3ea790c5d28a333dda">00334</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a80977020ef895f3ea790c5d28a333dda" title="Write a scalar message to the underlying file descriptor.">writeScalar</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size) {
360
+ <a name="l00335"></a>00335 <a class="code" href="classPassenger_1_1MessageChannel.html#abf02c51a74477650de8d5d5db661063b" title="Write a 32-bit big-endian unsigned integer to the underlying file descriptor.">writeUint32</a>(size);
361
+ <a name="l00336"></a>00336 writeExact(fd, data, size);
362
+ <a name="l00337"></a>00337 }
363
+ <a name="l00338"></a>00338 <span class="comment"></span>
364
+ <a name="l00339"></a>00339 <span class="comment"> /**</span>
365
+ <a name="l00340"></a>00340 <span class="comment"> * Pass a file descriptor. This only works if the underlying file</span>
366
+ <a name="l00341"></a>00341 <span class="comment"> * descriptor is a Unix socket.</span>
367
+ <a name="l00342"></a>00342 <span class="comment"> *</span>
368
+ <a name="l00343"></a>00343 <span class="comment"> * @param fileDescriptor The file descriptor to pass.</span>
369
+ <a name="l00344"></a>00344 <span class="comment"> * @param negotiate See Ruby&#39;s MessageChannel#send_io method&#39;s comments.</span>
370
+ <a name="l00345"></a>00345 <span class="comment"> * @throws SystemException Something went wrong during file descriptor passing.</span>
371
+ <a name="l00346"></a>00346 <span class="comment"> * @throws boost::thread_interrupted</span>
372
+ <a name="l00347"></a>00347 <span class="comment"> * @pre &lt;tt&gt;fileDescriptor &gt;= 0&lt;/tt&gt;</span>
373
+ <a name="l00348"></a>00348 <span class="comment"> * @see readFileDescriptor()</span>
374
+ <a name="l00349"></a>00349 <span class="comment"> */</span>
375
+ <a name="l00350"></a><a class="code" href="classPassenger_1_1MessageChannel.html#ae0c558e07dcc91900016773b2bec38d8">00350</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#ae0c558e07dcc91900016773b2bec38d8" title="Pass a file descriptor.">writeFileDescriptor</a>(<span class="keywordtype">int</span> fileDescriptor, <span class="keywordtype">bool</span> negotiate = <span class="keyword">true</span>) {
376
+ <a name="l00351"></a>00351 <span class="comment">// See message_channel.rb for more info about negotiation.</span>
377
+ <a name="l00352"></a>00352 <span class="keywordflow">if</span> (negotiate) {
378
+ <a name="l00353"></a>00353 vector&lt;string&gt; args;
379
+ <a name="l00354"></a>00354
380
+ <a name="l00355"></a>00355 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">read</a>(args)) {
381
+ <a name="l00356"></a>00356 <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">&quot;Unexpected end of stream encountered while pre-negotiating a file descriptor&quot;</span>);
382
+ <a name="l00357"></a>00357 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (args.size() != 1 || args[0] != <span class="stringliteral">&quot;pass IO&quot;</span>) {
383
+ <a name="l00358"></a>00358 <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">&quot;FD passing pre-negotiation message expected.&quot;</span>);
384
+ <a name="l00359"></a>00359 }
385
+ <a name="l00360"></a>00360 }
386
+ <a name="l00361"></a>00361
387
+ <a name="l00362"></a>00362 <span class="keyword">struct </span>msghdr msg;
388
+ <a name="l00363"></a>00363 <span class="keyword">struct </span>iovec vec;
389
+ <a name="l00364"></a>00364 <span class="keywordtype">char</span> dummy[1];
390
+ <a name="l00365"></a>00365 <span class="preprocessor"> #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
391
+ <a name="l00366"></a>00366 <span class="preprocessor"></span> <span class="keyword">struct </span>{
392
+ <a name="l00367"></a>00367 <span class="keyword">struct </span>cmsghdr header;
393
+ <a name="l00368"></a>00368 <span class="keywordtype">int</span> fd;
394
+ <a name="l00369"></a>00369 } control_data;
395
+ <a name="l00370"></a>00370 <span class="preprocessor"> #else</span>
396
+ <a name="l00371"></a>00371 <span class="preprocessor"></span> <span class="keywordtype">char</span> control_data[CMSG_SPACE(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>))];
397
+ <a name="l00372"></a>00372 <span class="preprocessor"> #endif</span>
398
+ <a name="l00373"></a>00373 <span class="preprocessor"></span> <span class="keyword">struct </span>cmsghdr *control_header;
399
+ <a name="l00374"></a>00374 <span class="keywordtype">int</span> ret;
400
+ <a name="l00375"></a>00375
401
+ <a name="l00376"></a>00376 msg.msg_name = NULL;
402
+ <a name="l00377"></a>00377 msg.msg_namelen = 0;
403
+ <a name="l00378"></a>00378
404
+ <a name="l00379"></a>00379 <span class="comment">/* Linux and Solaris require msg_iov to be non-NULL. */</span>
405
+ <a name="l00380"></a>00380 dummy[0] = <span class="charliteral">&#39;\0&#39;</span>;
406
+ <a name="l00381"></a>00381 vec.iov_base = dummy;
407
+ <a name="l00382"></a>00382 vec.iov_len = <span class="keyword">sizeof</span>(dummy);
408
+ <a name="l00383"></a>00383 msg.msg_iov = &amp;vec;
409
+ <a name="l00384"></a>00384 msg.msg_iovlen = 1;
410
+ <a name="l00385"></a>00385
411
+ <a name="l00386"></a>00386 msg.msg_control = (caddr_t) &amp;control_data;
412
+ <a name="l00387"></a>00387 msg.msg_controllen = <span class="keyword">sizeof</span>(control_data);
413
+ <a name="l00388"></a>00388 msg.msg_flags = 0;
414
+ <a name="l00389"></a>00389
415
+ <a name="l00390"></a>00390 control_header = CMSG_FIRSTHDR(&amp;msg);
416
+ <a name="l00391"></a>00391 control_header-&gt;cmsg_level = SOL_SOCKET;
417
+ <a name="l00392"></a>00392 control_header-&gt;cmsg_type = SCM_RIGHTS;
418
+ <a name="l00393"></a>00393 <span class="preprocessor"> #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
419
+ <a name="l00394"></a>00394 <span class="preprocessor"></span> control_header-&gt;cmsg_len = <span class="keyword">sizeof</span>(control_data);
420
+ <a name="l00395"></a>00395 control_data.fd = fileDescriptor;
421
+ <a name="l00396"></a>00396 <span class="preprocessor"> #else</span>
422
+ <a name="l00397"></a>00397 <span class="preprocessor"></span> control_header-&gt;cmsg_len = CMSG_LEN(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>));
423
+ <a name="l00398"></a>00398 memcpy(CMSG_DATA(control_header), &amp;fileDescriptor, <span class="keyword">sizeof</span>(<span class="keywordtype">int</span>));
424
+ <a name="l00399"></a>00399 <span class="preprocessor"> #endif</span>
425
+ <a name="l00400"></a>00400 <span class="preprocessor"></span>
426
+ <a name="l00401"></a>00401 ret = syscalls::sendmsg(fd, &amp;msg, 0);
427
+ <a name="l00402"></a>00402 <span class="keywordflow">if</span> (ret == -1) {
428
+ <a name="l00403"></a>00403 <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">&quot;Cannot send file descriptor with sendmsg()&quot;</span>, errno);
429
+ <a name="l00404"></a>00404 }
430
+ <a name="l00405"></a>00405
431
+ <a name="l00406"></a>00406 <span class="keywordflow">if</span> (negotiate) {
432
+ <a name="l00407"></a>00407 vector&lt;string&gt; args;
433
+ <a name="l00408"></a>00408
434
+ <a name="l00409"></a>00409 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">read</a>(args)) {
435
+ <a name="l00410"></a>00410 <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">&quot;Unexpected end of stream encountered while post-negotiating a file descriptor&quot;</span>);
436
+ <a name="l00411"></a>00411 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (args.size() != 1 || args[0] != <span class="stringliteral">&quot;got IO&quot;</span>) {
437
+ <a name="l00412"></a>00412 <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">&quot;FD passing post-negotiation message expected.&quot;</span>);
438
+ <a name="l00413"></a>00413 }
439
+ <a name="l00414"></a>00414 }
440
+ <a name="l00415"></a>00415 }
441
+ <a name="l00416"></a>00416 <span class="comment"></span>
442
+ <a name="l00417"></a>00417 <span class="comment"> /**</span>
443
+ <a name="l00418"></a>00418 <span class="comment"> * Read an array message from the underlying file descriptor.</span>
444
+ <a name="l00419"></a>00419 <span class="comment"> *</span>
445
+ <a name="l00420"></a>00420 <span class="comment"> * @param args The message will be put in this variable.</span>
446
+ <a name="l00421"></a>00421 <span class="comment"> * @return Whether end-of-file has been reached. If so, then the contents</span>
447
+ <a name="l00422"></a>00422 <span class="comment"> * of &lt;tt&gt;args&lt;/tt&gt; will be undefined.</span>
448
+ <a name="l00423"></a>00423 <span class="comment"> * @throws SystemException If an error occured while receiving the message.</span>
449
+ <a name="l00424"></a>00424 <span class="comment"> * @throws boost::thread_interrupted</span>
450
+ <a name="l00425"></a>00425 <span class="comment"> * @see write()</span>
451
+ <a name="l00426"></a>00426 <span class="comment"> */</span>
452
+ <a name="l00427"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e">00427</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">read</a>(vector&lt;string&gt; &amp;args) {
453
+ <a name="l00428"></a>00428 uint16_t size;
454
+ <a name="l00429"></a>00429 <span class="keywordtype">int</span> ret;
455
+ <a name="l00430"></a>00430 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> alreadyRead = 0;
456
456
  <a name="l00431"></a>00431
457
- <a name="l00432"></a>00432 control_header = CMSG_FIRSTHDR(&amp;msg);
458
- <a name="l00433"></a>00433 control_header-&gt;cmsg_level = SOL_SOCKET;
459
- <a name="l00434"></a>00434 control_header-&gt;cmsg_type = SCM_RIGHTS;
460
- <a name="l00435"></a>00435 <span class="preprocessor"> #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
461
- <a name="l00436"></a>00436 <span class="preprocessor"></span> control_header-&gt;cmsg_len = <span class="keyword">sizeof</span>(control_data);
462
- <a name="l00437"></a>00437 control_data.fd = fileDescriptor;
463
- <a name="l00438"></a>00438 <span class="preprocessor"> #else</span>
464
- <a name="l00439"></a>00439 <span class="preprocessor"></span> control_header-&gt;cmsg_len = CMSG_LEN(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>));
465
- <a name="l00440"></a>00440 memcpy(CMSG_DATA(control_header), &amp;fileDescriptor, <span class="keyword">sizeof</span>(<span class="keywordtype">int</span>));
466
- <a name="l00441"></a>00441 <span class="preprocessor"> #endif</span>
467
- <a name="l00442"></a>00442 <span class="preprocessor"></span>
468
- <a name="l00443"></a>00443 ret = syscalls::sendmsg(fd, &amp;msg, 0);
469
- <a name="l00444"></a>00444 <span class="keywordflow">if</span> (ret == -1) {
470
- <a name="l00445"></a>00445 <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">&quot;Cannot send file descriptor with sendmsg()&quot;</span>, errno);
471
- <a name="l00446"></a>00446 }
472
- <a name="l00447"></a>00447
473
- <a name="l00448"></a>00448 <span class="keywordflow">if</span> (negotiate) {
474
- <a name="l00449"></a>00449 vector&lt;string&gt; args;
475
- <a name="l00450"></a>00450
476
- <a name="l00451"></a>00451 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">read</a>(args)) {
477
- <a name="l00452"></a>00452 <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">&quot;Unexpected end of stream encountered while post-negotiating a file descriptor&quot;</span>);
478
- <a name="l00453"></a>00453 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (args.size() != 1 || args[0] != <span class="stringliteral">&quot;got IO&quot;</span>) {
479
- <a name="l00454"></a>00454 <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">&quot;FD passing post-negotiation message expected.&quot;</span>);
480
- <a name="l00455"></a>00455 }
481
- <a name="l00456"></a>00456 }
482
- <a name="l00457"></a>00457 }
483
- <a name="l00458"></a>00458 <span class="comment"></span>
484
- <a name="l00459"></a>00459 <span class="comment"> /**</span>
485
- <a name="l00460"></a>00460 <span class="comment"> * Read an array message from the underlying file descriptor.</span>
486
- <a name="l00461"></a>00461 <span class="comment"> *</span>
487
- <a name="l00462"></a>00462 <span class="comment"> * @param args The message will be put in this variable.</span>
488
- <a name="l00463"></a>00463 <span class="comment"> * @return Whether end-of-file has been reached. If so, then the contents</span>
489
- <a name="l00464"></a>00464 <span class="comment"> * of &lt;tt&gt;args&lt;/tt&gt; will be undefined.</span>
490
- <a name="l00465"></a>00465 <span class="comment"> * @throws SystemException If an error occured while receiving the message.</span>
491
- <a name="l00466"></a>00466 <span class="comment"> * @throws boost::thread_interrupted</span>
492
- <a name="l00467"></a>00467 <span class="comment"> * @see write()</span>
493
- <a name="l00468"></a>00468 <span class="comment"> */</span>
494
- <a name="l00469"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e">00469</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">read</a>(vector&lt;string&gt; &amp;args) {
495
- <a name="l00470"></a>00470 uint16_t size;
496
- <a name="l00471"></a>00471 <span class="keywordtype">int</span> ret;
497
- <a name="l00472"></a>00472 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> alreadyRead = 0;
498
- <a name="l00473"></a>00473
499
- <a name="l00474"></a>00474 <span class="keywordflow">do</span> {
500
- <a name="l00475"></a>00475 ret = <a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">syscalls::read</a>(fd, (<span class="keywordtype">char</span> *) &amp;size + alreadyRead, <span class="keyword">sizeof</span>(size) - alreadyRead);
501
- <a name="l00476"></a>00476 <span class="keywordflow">if</span> (ret == -1) {
502
- <a name="l00477"></a>00477 <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">&quot;read() failed&quot;</span>, errno);
503
- <a name="l00478"></a>00478 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ret == 0) {
504
- <a name="l00479"></a>00479 <span class="keywordflow">return</span> <span class="keyword">false</span>;
505
- <a name="l00480"></a>00480 }
506
- <a name="l00481"></a>00481 alreadyRead += ret;
507
- <a name="l00482"></a>00482 } <span class="keywordflow">while</span> (alreadyRead &lt; <span class="keyword">sizeof</span>(size));
508
- <a name="l00483"></a>00483 size = ntohs(size);
509
- <a name="l00484"></a>00484
510
- <a name="l00485"></a>00485 <span class="keywordtype">string</span> buffer;
511
- <a name="l00486"></a>00486 args.clear();
512
- <a name="l00487"></a>00487 buffer.reserve(size);
513
- <a name="l00488"></a>00488 <span class="keywordflow">while</span> (buffer.size() &lt; size) {
514
- <a name="l00489"></a>00489 <span class="keywordtype">char</span> tmp[1024 * 8];
515
- <a name="l00490"></a>00490 ret = <a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">syscalls::read</a>(fd, tmp, min(size - buffer.size(), <span class="keyword">sizeof</span>(tmp)));
516
- <a name="l00491"></a>00491 <span class="keywordflow">if</span> (ret == -1) {
517
- <a name="l00492"></a>00492 <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">&quot;read() failed&quot;</span>, errno);
518
- <a name="l00493"></a>00493 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ret == 0) {
519
- <a name="l00494"></a>00494 <span class="keywordflow">return</span> <span class="keyword">false</span>;
520
- <a name="l00495"></a>00495 }
521
- <a name="l00496"></a>00496 buffer.append(tmp, ret);
522
- <a name="l00497"></a>00497 }
523
- <a name="l00498"></a>00498
524
- <a name="l00499"></a>00499 <span class="keywordflow">if</span> (!buffer.empty()) {
525
- <a name="l00500"></a>00500 string::size_type start = 0, pos;
526
- <a name="l00501"></a>00501 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;const_buffer(buffer);
527
- <a name="l00502"></a>00502 <span class="keywordflow">while</span> ((pos = const_buffer.find(<span class="charliteral">&#39;\0&#39;</span>, start)) != string::npos) {
528
- <a name="l00503"></a>00503 args.push_back(const_buffer.substr(start, pos - start));
529
- <a name="l00504"></a>00504 start = pos + 1;
530
- <a name="l00505"></a>00505 }
531
- <a name="l00506"></a>00506 }
532
- <a name="l00507"></a>00507 <span class="keywordflow">return</span> <span class="keyword">true</span>;
533
- <a name="l00508"></a>00508 }
534
- <a name="l00509"></a>00509 <span class="comment"></span>
535
- <a name="l00510"></a>00510 <span class="comment"> /**</span>
536
- <a name="l00511"></a>00511 <span class="comment"> * Read a 32-bit big-endian unsigned integer from the underlying file descriptor.</span>
537
- <a name="l00512"></a>00512 <span class="comment"> *</span>
538
- <a name="l00513"></a>00513 <span class="comment"> * @param value Upon success, the read value will be stored in here.</span>
539
- <a name="l00514"></a>00514 <span class="comment"> * @param timeout A pointer to an integer, representing the maximum number of</span>
540
- <a name="l00515"></a>00515 <span class="comment"> * milliseconds to spend on reading the entire integer.</span>
541
- <a name="l00516"></a>00516 <span class="comment"> * A TimeoutException will be thrown if the timeout expires.</span>
542
- <a name="l00517"></a>00517 <span class="comment"> * If no exception is thrown, the the amount of time spent on waiting</span>
543
- <a name="l00518"></a>00518 <span class="comment"> * will be deducted from &lt;tt&gt;*timeout&lt;/tt&gt;.</span>
544
- <a name="l00519"></a>00519 <span class="comment"> * Pass NULL if you do not want to enforce any time limits.</span>
545
- <a name="l00520"></a>00520 <span class="comment"> * @return True if a value was read, false if EOF was reached before all data can be</span>
546
- <a name="l00521"></a>00521 <span class="comment"> * read.</span>
547
- <a name="l00522"></a>00522 <span class="comment"> * @throws SystemException An error occurred while reading data from the file descriptor.</span>
548
- <a name="l00523"></a>00523 <span class="comment"> * @throws boost::thread_interrupted</span>
549
- <a name="l00524"></a>00524 <span class="comment"> */</span>
550
- <a name="l00525"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a7b0c67852ea8ab455af75b1037c7f8b6">00525</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a7b0c67852ea8ab455af75b1037c7f8b6" title="Read a 32-bit big-endian unsigned integer from the underlying file descriptor.">readUint32</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> &amp;value, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *timeout = NULL) {
551
- <a name="l00526"></a>00526 uint32_t temp;
457
+ <a name="l00432"></a>00432 <span class="keywordflow">do</span> {
458
+ <a name="l00433"></a>00433 ret = <a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">syscalls::read</a>(fd, (<span class="keywordtype">char</span> *) &amp;size + alreadyRead, <span class="keyword">sizeof</span>(size) - alreadyRead);
459
+ <a name="l00434"></a>00434 <span class="keywordflow">if</span> (ret == -1) {
460
+ <a name="l00435"></a>00435 <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">&quot;read() failed&quot;</span>, errno);
461
+ <a name="l00436"></a>00436 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ret == 0) {
462
+ <a name="l00437"></a>00437 <span class="keywordflow">return</span> <span class="keyword">false</span>;
463
+ <a name="l00438"></a>00438 }
464
+ <a name="l00439"></a>00439 alreadyRead += ret;
465
+ <a name="l00440"></a>00440 } <span class="keywordflow">while</span> (alreadyRead &lt; <span class="keyword">sizeof</span>(size));
466
+ <a name="l00441"></a>00441 size = ntohs(size);
467
+ <a name="l00442"></a>00442
468
+ <a name="l00443"></a>00443 <span class="keywordtype">string</span> buffer;
469
+ <a name="l00444"></a>00444 args.clear();
470
+ <a name="l00445"></a>00445 buffer.reserve(size);
471
+ <a name="l00446"></a>00446 <span class="keywordflow">while</span> (buffer.size() &lt; size) {
472
+ <a name="l00447"></a>00447 <span class="keywordtype">char</span> tmp[1024 * 8];
473
+ <a name="l00448"></a>00448 ret = <a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">syscalls::read</a>(fd, tmp, min(size - buffer.size(), <span class="keyword">sizeof</span>(tmp)));
474
+ <a name="l00449"></a>00449 <span class="keywordflow">if</span> (ret == -1) {
475
+ <a name="l00450"></a>00450 <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">&quot;read() failed&quot;</span>, errno);
476
+ <a name="l00451"></a>00451 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ret == 0) {
477
+ <a name="l00452"></a>00452 <span class="keywordflow">return</span> <span class="keyword">false</span>;
478
+ <a name="l00453"></a>00453 }
479
+ <a name="l00454"></a>00454 buffer.append(tmp, ret);
480
+ <a name="l00455"></a>00455 }
481
+ <a name="l00456"></a>00456
482
+ <a name="l00457"></a>00457 <span class="keywordflow">if</span> (!buffer.empty()) {
483
+ <a name="l00458"></a>00458 string::size_type start = 0, pos;
484
+ <a name="l00459"></a>00459 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;const_buffer(buffer);
485
+ <a name="l00460"></a>00460 <span class="keywordflow">while</span> ((pos = const_buffer.find(<span class="charliteral">&#39;\0&#39;</span>, start)) != string::npos) {
486
+ <a name="l00461"></a>00461 args.push_back(const_buffer.substr(start, pos - start));
487
+ <a name="l00462"></a>00462 start = pos + 1;
488
+ <a name="l00463"></a>00463 }
489
+ <a name="l00464"></a>00464 }
490
+ <a name="l00465"></a>00465 <span class="keywordflow">return</span> <span class="keyword">true</span>;
491
+ <a name="l00466"></a>00466 }
492
+ <a name="l00467"></a>00467 <span class="comment"></span>
493
+ <a name="l00468"></a>00468 <span class="comment"> /**</span>
494
+ <a name="l00469"></a>00469 <span class="comment"> * Read a 32-bit big-endian unsigned integer from the underlying file descriptor.</span>
495
+ <a name="l00470"></a>00470 <span class="comment"> *</span>
496
+ <a name="l00471"></a>00471 <span class="comment"> * @param value Upon success, the read value will be stored in here.</span>
497
+ <a name="l00472"></a>00472 <span class="comment"> * @param timeout A pointer to an integer, representing the maximum number of</span>
498
+ <a name="l00473"></a>00473 <span class="comment"> * milliseconds to spend on reading the entire integer.</span>
499
+ <a name="l00474"></a>00474 <span class="comment"> * A TimeoutException will be thrown if the timeout expires.</span>
500
+ <a name="l00475"></a>00475 <span class="comment"> * If no exception is thrown, the the amount of time spent on waiting</span>
501
+ <a name="l00476"></a>00476 <span class="comment"> * will be deducted from &lt;tt&gt;*timeout&lt;/tt&gt;.</span>
502
+ <a name="l00477"></a>00477 <span class="comment"> * Pass NULL if you do not want to enforce any time limits.</span>
503
+ <a name="l00478"></a>00478 <span class="comment"> * @return True if a value was read, false if EOF was reached before all data can be</span>
504
+ <a name="l00479"></a>00479 <span class="comment"> * read.</span>
505
+ <a name="l00480"></a>00480 <span class="comment"> * @throws SystemException An error occurred while reading data from the file descriptor.</span>
506
+ <a name="l00481"></a>00481 <span class="comment"> * @throws boost::thread_interrupted</span>
507
+ <a name="l00482"></a>00482 <span class="comment"> */</span>
508
+ <a name="l00483"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a7b0c67852ea8ab455af75b1037c7f8b6">00483</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a7b0c67852ea8ab455af75b1037c7f8b6" title="Read a 32-bit big-endian unsigned integer from the underlying file descriptor.">readUint32</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> &amp;value, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *timeout = NULL) {
509
+ <a name="l00484"></a>00484 uint32_t temp;
510
+ <a name="l00485"></a>00485
511
+ <a name="l00486"></a>00486 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#ab471dc1888f030e20ed23068a160ec2a" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(&amp;temp, <span class="keyword">sizeof</span>(uint32_t), timeout)) {
512
+ <a name="l00487"></a>00487 <span class="keywordflow">return</span> <span class="keyword">false</span>;
513
+ <a name="l00488"></a>00488 } <span class="keywordflow">else</span> {
514
+ <a name="l00489"></a>00489 value = ntohl(temp);
515
+ <a name="l00490"></a>00490 <span class="keywordflow">return</span> <span class="keyword">true</span>;
516
+ <a name="l00491"></a>00491 }
517
+ <a name="l00492"></a>00492 }
518
+ <a name="l00493"></a>00493 <span class="comment"></span>
519
+ <a name="l00494"></a>00494 <span class="comment"> /**</span>
520
+ <a name="l00495"></a>00495 <span class="comment"> * Read a scalar message from the underlying file descriptor.</span>
521
+ <a name="l00496"></a>00496 <span class="comment"> *</span>
522
+ <a name="l00497"></a>00497 <span class="comment"> * @param output The message will be put in here.</span>
523
+ <a name="l00498"></a>00498 <span class="comment"> * @param maxSize The maximum number of bytes that may be read. If the</span>
524
+ <a name="l00499"></a>00499 <span class="comment"> * scalar to read is larger than this, then a SecurityException</span>
525
+ <a name="l00500"></a>00500 <span class="comment"> * will be thrown. Set to 0 for no size limit.</span>
526
+ <a name="l00501"></a>00501 <span class="comment"> * @param timeout A pointer to an integer, representing the maximum number of</span>
527
+ <a name="l00502"></a>00502 <span class="comment"> * milliseconds to spend on reading the entire scalar.</span>
528
+ <a name="l00503"></a>00503 <span class="comment"> * A TimeoutException will be thrown if unable to read the entire</span>
529
+ <a name="l00504"></a>00504 <span class="comment"> * scalar within this time period.</span>
530
+ <a name="l00505"></a>00505 <span class="comment"> * If no exception is thrown, the the amount of time spent on waiting</span>
531
+ <a name="l00506"></a>00506 <span class="comment"> * will be deducted from &lt;tt&gt;*timeout&lt;/tt&gt;.</span>
532
+ <a name="l00507"></a>00507 <span class="comment"> * Pass NULL if you do not want to enforce any time limits.</span>
533
+ <a name="l00508"></a>00508 <span class="comment"> * @returns Whether end-of-file was reached during reading.</span>
534
+ <a name="l00509"></a>00509 <span class="comment"> * @throws SystemException An error occured while reading data from the file descriptor.</span>
535
+ <a name="l00510"></a>00510 <span class="comment"> * @throws SecurityException There is more data to read than allowed by maxSize.</span>
536
+ <a name="l00511"></a>00511 <span class="comment"> * @throws TimeoutException Unable to read the entire scalar within &lt;tt&gt;timeout&lt;/tt&gt;</span>
537
+ <a name="l00512"></a>00512 <span class="comment"> * milliseconds.</span>
538
+ <a name="l00513"></a>00513 <span class="comment"> * @throws boost::thread_interrupted</span>
539
+ <a name="l00514"></a>00514 <span class="comment"> * @see writeScalar()</span>
540
+ <a name="l00515"></a>00515 <span class="comment"> */</span>
541
+ <a name="l00516"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a1f3cf672b566166ed920c2bba4d19604">00516</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a1f3cf672b566166ed920c2bba4d19604" title="Read a scalar message from the underlying file descriptor.">readScalar</a>(<span class="keywordtype">string</span> &amp;output, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxSize = 0, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *timeout = NULL) {
542
+ <a name="l00517"></a>00517 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size;
543
+ <a name="l00518"></a>00518 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> remaining;
544
+ <a name="l00519"></a>00519
545
+ <a name="l00520"></a>00520 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#a7b0c67852ea8ab455af75b1037c7f8b6" title="Read a 32-bit big-endian unsigned integer from the underlying file descriptor.">readUint32</a>(size, timeout)) {
546
+ <a name="l00521"></a>00521 <span class="keywordflow">return</span> <span class="keyword">false</span>;
547
+ <a name="l00522"></a>00522 }
548
+ <a name="l00523"></a>00523
549
+ <a name="l00524"></a>00524 <span class="keywordflow">if</span> (maxSize != 0 &amp;&amp; size &gt; maxSize) {
550
+ <a name="l00525"></a>00525 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SecurityException.html" title="Represents some kind of security error.">SecurityException</a>(<span class="stringliteral">&quot;There is more data available than is allowed by the size limit.&quot;</span>);
551
+ <a name="l00526"></a>00526 }
552
552
  <a name="l00527"></a>00527
553
- <a name="l00528"></a>00528 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#ab471dc1888f030e20ed23068a160ec2a" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(&amp;temp, <span class="keyword">sizeof</span>(uint32_t), timeout)) {
554
- <a name="l00529"></a>00529 <span class="keywordflow">return</span> <span class="keyword">false</span>;
555
- <a name="l00530"></a>00530 } <span class="keywordflow">else</span> {
556
- <a name="l00531"></a>00531 value = ntohl(temp);
557
- <a name="l00532"></a>00532 <span class="keywordflow">return</span> <span class="keyword">true</span>;
558
- <a name="l00533"></a>00533 }
559
- <a name="l00534"></a>00534 }
560
- <a name="l00535"></a>00535 <span class="comment"></span>
561
- <a name="l00536"></a>00536 <span class="comment"> /**</span>
562
- <a name="l00537"></a>00537 <span class="comment"> * Read a scalar message from the underlying file descriptor.</span>
563
- <a name="l00538"></a>00538 <span class="comment"> *</span>
564
- <a name="l00539"></a>00539 <span class="comment"> * @param output The message will be put in here.</span>
565
- <a name="l00540"></a>00540 <span class="comment"> * @param maxSize The maximum number of bytes that may be read. If the</span>
566
- <a name="l00541"></a>00541 <span class="comment"> * scalar to read is larger than this, then a SecurityException</span>
567
- <a name="l00542"></a>00542 <span class="comment"> * will be thrown. Set to 0 for no size limit.</span>
568
- <a name="l00543"></a>00543 <span class="comment"> * @param timeout A pointer to an integer, representing the maximum number of</span>
569
- <a name="l00544"></a>00544 <span class="comment"> * milliseconds to spend on reading the entire scalar.</span>
570
- <a name="l00545"></a>00545 <span class="comment"> * A TimeoutException will be thrown if unable to read the entire</span>
571
- <a name="l00546"></a>00546 <span class="comment"> * scalar within this time period.</span>
572
- <a name="l00547"></a>00547 <span class="comment"> * If no exception is thrown, the the amount of time spent on waiting</span>
573
- <a name="l00548"></a>00548 <span class="comment"> * will be deducted from &lt;tt&gt;*timeout&lt;/tt&gt;.</span>
574
- <a name="l00549"></a>00549 <span class="comment"> * Pass NULL if you do not want to enforce any time limits.</span>
575
- <a name="l00550"></a>00550 <span class="comment"> * @returns Whether end-of-file was reached during reading.</span>
576
- <a name="l00551"></a>00551 <span class="comment"> * @throws SystemException An error occured while reading data from the file descriptor.</span>
577
- <a name="l00552"></a>00552 <span class="comment"> * @throws SecurityException There is more data to read than allowed by maxSize.</span>
578
- <a name="l00553"></a>00553 <span class="comment"> * @throws TimeoutException Unable to read the entire scalar within &lt;tt&gt;timeout&lt;/tt&gt;</span>
579
- <a name="l00554"></a>00554 <span class="comment"> * milliseconds.</span>
580
- <a name="l00555"></a>00555 <span class="comment"> * @throws boost::thread_interrupted</span>
581
- <a name="l00556"></a>00556 <span class="comment"> * @see writeScalar()</span>
582
- <a name="l00557"></a>00557 <span class="comment"> */</span>
583
- <a name="l00558"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a1f3cf672b566166ed920c2bba4d19604">00558</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a1f3cf672b566166ed920c2bba4d19604" title="Read a scalar message from the underlying file descriptor.">readScalar</a>(<span class="keywordtype">string</span> &amp;output, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxSize = 0, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *timeout = NULL) {
584
- <a name="l00559"></a>00559 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size;
585
- <a name="l00560"></a>00560 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> remaining;
586
- <a name="l00561"></a>00561
587
- <a name="l00562"></a>00562 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#a7b0c67852ea8ab455af75b1037c7f8b6" title="Read a 32-bit big-endian unsigned integer from the underlying file descriptor.">readUint32</a>(size, timeout)) {
588
- <a name="l00563"></a>00563 <span class="keywordflow">return</span> <span class="keyword">false</span>;
589
- <a name="l00564"></a>00564 }
590
- <a name="l00565"></a>00565
591
- <a name="l00566"></a>00566 <span class="keywordflow">if</span> (maxSize != 0 &amp;&amp; size &gt; maxSize) {
592
- <a name="l00567"></a>00567 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1SecurityException.html" title="Represents some kind of security error.">SecurityException</a>(<span class="stringliteral">&quot;There is more data available than is allowed by the size limit.&quot;</span>);
593
- <a name="l00568"></a>00568 }
594
- <a name="l00569"></a>00569
595
- <a name="l00570"></a>00570 output.clear();
596
- <a name="l00571"></a>00571 output.reserve(size);
597
- <a name="l00572"></a>00572 remaining = size;
598
- <a name="l00573"></a>00573 <span class="keywordflow">if</span> (OXT_LIKELY(remaining &gt; 0)) {
599
- <a name="l00574"></a>00574 <span class="keywordtype">char</span> buf[1024 * 32];
600
- <a name="l00575"></a>00575 <span class="comment">// Wipe the buffer when we&#39;re done; it might contain sensitive data.</span>
601
- <a name="l00576"></a>00576 MemZeroGuard g(buf, <span class="keyword">sizeof</span>(buf));
602
- <a name="l00577"></a>00577
603
- <a name="l00578"></a>00578 <span class="keywordflow">while</span> (remaining &gt; 0) {
604
- <a name="l00579"></a>00579 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> blockSize = min((<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) <span class="keyword">sizeof</span>(buf), remaining);
605
- <a name="l00580"></a>00580
606
- <a name="l00581"></a>00581 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#ab471dc1888f030e20ed23068a160ec2a" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(buf, blockSize, timeout)) {
607
- <a name="l00582"></a>00582 <span class="keywordflow">return</span> <span class="keyword">false</span>;
608
- <a name="l00583"></a>00583 }
609
- <a name="l00584"></a>00584 output.append(buf, blockSize);
610
- <a name="l00585"></a>00585 remaining -= blockSize;
611
- <a name="l00586"></a>00586 }
612
- <a name="l00587"></a>00587 }
613
- <a name="l00588"></a>00588 <span class="keywordflow">return</span> <span class="keyword">true</span>;
553
+ <a name="l00528"></a>00528 output.clear();
554
+ <a name="l00529"></a>00529 output.reserve(size);
555
+ <a name="l00530"></a>00530 remaining = size;
556
+ <a name="l00531"></a>00531 <span class="keywordflow">if</span> (OXT_LIKELY(remaining &gt; 0)) {
557
+ <a name="l00532"></a>00532 <span class="keywordtype">char</span> buf[1024 * 32];
558
+ <a name="l00533"></a>00533 <span class="comment">// Wipe the buffer when we&#39;re done; it might contain sensitive data.</span>
559
+ <a name="l00534"></a>00534 MemZeroGuard g(buf, <span class="keyword">sizeof</span>(buf));
560
+ <a name="l00535"></a>00535
561
+ <a name="l00536"></a>00536 <span class="keywordflow">while</span> (remaining &gt; 0) {
562
+ <a name="l00537"></a>00537 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> blockSize = min((<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) <span class="keyword">sizeof</span>(buf), remaining);
563
+ <a name="l00538"></a>00538
564
+ <a name="l00539"></a>00539 <span class="keywordflow">if</span> (!<a class="code" href="classPassenger_1_1MessageChannel.html#ab471dc1888f030e20ed23068a160ec2a" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(buf, blockSize, timeout)) {
565
+ <a name="l00540"></a>00540 <span class="keywordflow">return</span> <span class="keyword">false</span>;
566
+ <a name="l00541"></a>00541 }
567
+ <a name="l00542"></a>00542 output.append(buf, blockSize);
568
+ <a name="l00543"></a>00543 remaining -= blockSize;
569
+ <a name="l00544"></a>00544 }
570
+ <a name="l00545"></a>00545 }
571
+ <a name="l00546"></a>00546 <span class="keywordflow">return</span> <span class="keyword">true</span>;
572
+ <a name="l00547"></a>00547 }
573
+ <a name="l00548"></a>00548 <span class="comment"></span>
574
+ <a name="l00549"></a>00549 <span class="comment"> /**</span>
575
+ <a name="l00550"></a>00550 <span class="comment"> * Read exactly &lt;tt&gt;size&lt;/tt&gt; bytes of data from the underlying file descriptor,</span>
576
+ <a name="l00551"></a>00551 <span class="comment"> * and put the result in &lt;tt&gt;buf&lt;/tt&gt;. If end-of-file has been reached, or if</span>
577
+ <a name="l00552"></a>00552 <span class="comment"> * end-of-file was encountered before &lt;tt&gt;size&lt;/tt&gt; bytes have been read, then</span>
578
+ <a name="l00553"></a>00553 <span class="comment"> * &lt;tt&gt;false&lt;/tt&gt; will be returned. Otherwise (i.e. if the read was successful),</span>
579
+ <a name="l00554"></a>00554 <span class="comment"> * &lt;tt&gt;true&lt;/tt&gt; will be returned.</span>
580
+ <a name="l00555"></a>00555 <span class="comment"> *</span>
581
+ <a name="l00556"></a>00556 <span class="comment"> * @param buf The buffer to place the read data in. This buffer must be at least</span>
582
+ <a name="l00557"></a>00557 <span class="comment"> * &lt;tt&gt;size&lt;/tt&gt; bytes long.</span>
583
+ <a name="l00558"></a>00558 <span class="comment"> * @param size The number of bytes to read.</span>
584
+ <a name="l00559"></a>00559 <span class="comment"> * @param timeout A pointer to an integer, which specifies the maximum number of</span>
585
+ <a name="l00560"></a>00560 <span class="comment"> * milliseconds that may be spent on reading the &lt;tt&gt;size&lt;/tt&gt; bytes</span>
586
+ <a name="l00561"></a>00561 <span class="comment"> * of data. If the timeout expired then TimeoutException will be</span>
587
+ <a name="l00562"></a>00562 <span class="comment"> * thrown.</span>
588
+ <a name="l00563"></a>00563 <span class="comment"> * If this function returns without throwing an exception, then the</span>
589
+ <a name="l00564"></a>00564 <span class="comment"> * total number of milliseconds spent on reading will be deducted</span>
590
+ <a name="l00565"></a>00565 <span class="comment"> * from &lt;tt&gt;timeout&lt;/tt&gt;.</span>
591
+ <a name="l00566"></a>00566 <span class="comment"> * Pass NULL if you do not want to enforce a timeout.</span>
592
+ <a name="l00567"></a>00567 <span class="comment"> * @return Whether reading was successful or whether EOF was reached.</span>
593
+ <a name="l00568"></a>00568 <span class="comment"> * @pre buf != NULL</span>
594
+ <a name="l00569"></a>00569 <span class="comment"> * @throws SystemException Something went wrong during reading.</span>
595
+ <a name="l00570"></a>00570 <span class="comment"> * @throws TimeoutException Unable to read &lt;tt&gt;size&lt;/tt&gt; bytes of data within</span>
596
+ <a name="l00571"></a>00571 <span class="comment"> * &lt;tt&gt;timeout&lt;/tt&gt; milliseconds.</span>
597
+ <a name="l00572"></a>00572 <span class="comment"> * @throws boost::thread_interrupted</span>
598
+ <a name="l00573"></a>00573 <span class="comment"> */</span>
599
+ <a name="l00574"></a><a class="code" href="classPassenger_1_1MessageChannel.html#ab471dc1888f030e20ed23068a160ec2a">00574</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#ab471dc1888f030e20ed23068a160ec2a" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(<span class="keywordtype">void</span> *buf, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *timeout = NULL) {
600
+ <a name="l00575"></a>00575 <span class="keywordflow">if</span> (timeout != NULL) {
601
+ <a name="l00576"></a>00576 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> t = *timeout * 1000;
602
+ <a name="l00577"></a>00577 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> ret;
603
+ <a name="l00578"></a>00578 <span class="keywordflow">try</span> {
604
+ <a name="l00579"></a>00579 ret = Passenger::readExact(fd, buf, size, &amp;t);
605
+ <a name="l00580"></a>00580 *timeout = llroundl((<span class="keywordtype">long</span> <span class="keywordtype">double</span>) t / 1000);
606
+ <a name="l00581"></a>00581 <span class="keywordflow">return</span> ret == size;
607
+ <a name="l00582"></a>00582 } <span class="keywordflow">catch</span> (...) {
608
+ <a name="l00583"></a>00583 *timeout = llroundl((<span class="keywordtype">long</span> <span class="keywordtype">double</span>) t / 1000);
609
+ <a name="l00584"></a>00584 <span class="keywordflow">throw</span>;
610
+ <a name="l00585"></a>00585 }
611
+ <a name="l00586"></a>00586 } <span class="keywordflow">else</span> {
612
+ <a name="l00587"></a>00587 <span class="keywordflow">return</span> Passenger::readExact(fd, buf, size) == size;
613
+ <a name="l00588"></a>00588 }
614
614
  <a name="l00589"></a>00589 }
615
615
  <a name="l00590"></a>00590 <span class="comment"></span>
616
616
  <a name="l00591"></a>00591 <span class="comment"> /**</span>
617
- <a name="l00592"></a>00592 <span class="comment"> * Read exactly &lt;tt&gt;size&lt;/tt&gt; bytes of data from the underlying file descriptor,</span>
618
- <a name="l00593"></a>00593 <span class="comment"> * and put the result in &lt;tt&gt;buf&lt;/tt&gt;. If end-of-file has been reached, or if</span>
619
- <a name="l00594"></a>00594 <span class="comment"> * end-of-file was encountered before &lt;tt&gt;size&lt;/tt&gt; bytes have been read, then</span>
620
- <a name="l00595"></a>00595 <span class="comment"> * &lt;tt&gt;false&lt;/tt&gt; will be returned. Otherwise (i.e. if the read was successful),</span>
621
- <a name="l00596"></a>00596 <span class="comment"> * &lt;tt&gt;true&lt;/tt&gt; will be returned.</span>
622
- <a name="l00597"></a>00597 <span class="comment"> *</span>
623
- <a name="l00598"></a>00598 <span class="comment"> * @param buf The buffer to place the read data in. This buffer must be at least</span>
624
- <a name="l00599"></a>00599 <span class="comment"> * &lt;tt&gt;size&lt;/tt&gt; bytes long.</span>
625
- <a name="l00600"></a>00600 <span class="comment"> * @param size The number of bytes to read.</span>
626
- <a name="l00601"></a>00601 <span class="comment"> * @param timeout A pointer to an integer, which specifies the maximum number of</span>
627
- <a name="l00602"></a>00602 <span class="comment"> * milliseconds that may be spent on reading the &lt;tt&gt;size&lt;/tt&gt; bytes</span>
628
- <a name="l00603"></a>00603 <span class="comment"> * of data. If the timeout expired then TimeoutException will be</span>
629
- <a name="l00604"></a>00604 <span class="comment"> * thrown.</span>
630
- <a name="l00605"></a>00605 <span class="comment"> * If this function returns without throwing an exception, then the</span>
631
- <a name="l00606"></a>00606 <span class="comment"> * total number of milliseconds spent on reading will be deducted</span>
632
- <a name="l00607"></a>00607 <span class="comment"> * from &lt;tt&gt;timeout&lt;/tt&gt;.</span>
633
- <a name="l00608"></a>00608 <span class="comment"> * Pass NULL if you do not want to enforce a timeout.</span>
634
- <a name="l00609"></a>00609 <span class="comment"> * @return Whether reading was successful or whether EOF was reached.</span>
635
- <a name="l00610"></a>00610 <span class="comment"> * @pre buf != NULL</span>
636
- <a name="l00611"></a>00611 <span class="comment"> * @throws SystemException Something went wrong during reading.</span>
637
- <a name="l00612"></a>00612 <span class="comment"> * @throws TimeoutException Unable to read &lt;tt&gt;size&lt;/tt&gt; bytes of data within</span>
638
- <a name="l00613"></a>00613 <span class="comment"> * &lt;tt&gt;timeout&lt;/tt&gt; milliseconds.</span>
639
- <a name="l00614"></a>00614 <span class="comment"> * @throws boost::thread_interrupted</span>
640
- <a name="l00615"></a>00615 <span class="comment"> * @see writeRaw()</span>
641
- <a name="l00616"></a>00616 <span class="comment"> */</span>
642
- <a name="l00617"></a><a class="code" href="classPassenger_1_1MessageChannel.html#ab471dc1888f030e20ed23068a160ec2a">00617</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#ab471dc1888f030e20ed23068a160ec2a" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(<span class="keywordtype">void</span> *buf, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *timeout = NULL) {
643
- <a name="l00618"></a>00618 ssize_t ret;
644
- <a name="l00619"></a>00619 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> alreadyRead = 0;
645
- <a name="l00620"></a>00620
646
- <a name="l00621"></a>00621 <span class="keywordflow">while</span> (alreadyRead &lt; size) {
647
- <a name="l00622"></a>00622 <span class="keywordflow">if</span> (timeout != NULL &amp;&amp; !<a class="code" href="classPassenger_1_1MessageChannel.html#ac2407ed109785b49794989507c570149" title="Waits at most *timeout milliseconds for the file descriptor to become readable.">waitUntilReadable</a>(timeout)) {
648
- <a name="l00623"></a>00623 <span class="keywordflow">throw</span> <a class="code" href="classPassenger_1_1TimeoutException.html" title="An exception indicating that some timeout expired.">TimeoutException</a>(<span class="stringliteral">&quot;Cannot read enough data within the specified timeout.&quot;</span>);
649
- <a name="l00624"></a>00624 }
650
- <a name="l00625"></a>00625 ret = <a class="code" href="classPassenger_1_1MessageChannel.html#a129659b60d1a663337873d2af944431e" title="Read an array message from the underlying file descriptor.">syscalls::read</a>(fd, (<span class="keywordtype">char</span> *) buf + alreadyRead, size - alreadyRead);
651
- <a name="l00626"></a>00626 <span class="keywordflow">if</span> (ret == -1) {
652
- <a name="l00627"></a>00627 <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">&quot;read() failed&quot;</span>, errno);
653
- <a name="l00628"></a>00628 } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (ret == 0) {
654
- <a name="l00629"></a>00629 <span class="keywordflow">return</span> <span class="keyword">false</span>;
655
- <a name="l00630"></a>00630 } <span class="keywordflow">else</span> {
656
- <a name="l00631"></a>00631 alreadyRead += ret;
657
- <a name="l00632"></a>00632 }
658
- <a name="l00633"></a>00633 }
659
- <a name="l00634"></a>00634 <span class="keywordflow">return</span> <span class="keyword">true</span>;
660
- <a name="l00635"></a>00635 }
661
- <a name="l00636"></a>00636 <span class="comment"></span>
662
- <a name="l00637"></a>00637 <span class="comment"> /**</span>
663
- <a name="l00638"></a>00638 <span class="comment"> * Waits at most &lt;tt&gt;*timeout&lt;/tt&gt; milliseconds for the file descriptor to become readable.</span>
664
- <a name="l00639"></a>00639 <span class="comment"> * Returns true if it become readable within the timeout, false if the timeout expired.</span>
665
- <a name="l00640"></a>00640 <span class="comment"> *</span>
666
- <a name="l00641"></a>00641 <span class="comment"> * &lt;tt&gt;*timeout&lt;/tt&gt; may be 0, in which case this method will check whether the file</span>
667
- <a name="l00642"></a>00642 <span class="comment"> * descriptor is readable, and immediately returns without waiting.</span>
668
- <a name="l00643"></a>00643 <span class="comment"> *</span>
669
- <a name="l00644"></a>00644 <span class="comment"> * If no exception is thrown, this method deducts the number of milliseconds that has</span>
670
- <a name="l00645"></a>00645 <span class="comment"> * passed from &lt;tt&gt;*timeout&lt;/tt&gt;.</span>
671
- <a name="l00646"></a>00646 <span class="comment"> *</span>
672
- <a name="l00647"></a>00647 <span class="comment"> * @throws SystemException</span>
673
- <a name="l00648"></a>00648 <span class="comment"> * @throws boost::thread_interrupted</span>
674
- <a name="l00649"></a>00649 <span class="comment"> */</span>
675
- <a name="l00650"></a><a class="code" href="classPassenger_1_1MessageChannel.html#ac2407ed109785b49794989507c570149">00650</a> <span class="keywordtype">bool</span> <a class="code" href="classPassenger_1_1MessageChannel.html#ac2407ed109785b49794989507c570149" title="Waits at most *timeout milliseconds for the file descriptor to become readable.">waitUntilReadable</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> *timeout) {
676
- <a name="l00651"></a>00651 fd_set fds;
677
- <a name="l00652"></a>00652 <span class="keyword">struct </span>timeval tv;
678
- <a name="l00653"></a>00653 <span class="keywordtype">int</span> ret;
679
- <a name="l00654"></a>00654
680
- <a name="l00655"></a>00655 FD_ZERO(&amp;fds);
681
- <a name="l00656"></a>00656 FD_SET(fd, &amp;fds);
682
- <a name="l00657"></a>00657 tv.tv_sec = *timeout / 1000;
683
- <a name="l00658"></a>00658 tv.tv_usec = *timeout % 1000 * 1000;
684
- <a name="l00659"></a>00659
685
- <a name="l00660"></a>00660 Timer timer;
686
- <a name="l00661"></a>00661 ret = syscalls::select(fd + 1, &amp;fds, NULL, NULL, &amp;tv);
687
- <a name="l00662"></a>00662 <span class="keywordflow">if</span> (ret == -1) {
688
- <a name="l00663"></a>00663 <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">&quot;select() failed&quot;</span>, errno);
689
- <a name="l00664"></a>00664 } <span class="keywordflow">else</span> {
690
- <a name="l00665"></a>00665 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> elapsed = timer.elapsed();
691
- <a name="l00666"></a>00666 <span class="keywordflow">if</span> (elapsed &gt; *timeout) {
692
- <a name="l00667"></a>00667 *timeout = 0;
693
- <a name="l00668"></a>00668 } <span class="keywordflow">else</span> {
694
- <a name="l00669"></a>00669 *timeout -= elapsed;
695
- <a name="l00670"></a>00670 }
696
- <a name="l00671"></a>00671 <span class="keywordflow">return</span> ret != 0;
697
- <a name="l00672"></a>00672 }
617
+ <a name="l00592"></a>00592 <span class="comment"> * Receive a file descriptor, which had been passed over the underlying</span>
618
+ <a name="l00593"></a>00593 <span class="comment"> * file descriptor.</span>
619
+ <a name="l00594"></a>00594 <span class="comment"> *</span>
620
+ <a name="l00595"></a>00595 <span class="comment"> * @param negotiate See Ruby&#39;s MessageChannel#send_io method&#39;s comments.</span>
621
+ <a name="l00596"></a>00596 <span class="comment"> * @return The passed file descriptor.</span>
622
+ <a name="l00597"></a>00597 <span class="comment"> * @throws SystemException If something went wrong during the</span>
623
+ <a name="l00598"></a>00598 <span class="comment"> * receiving of a file descriptor. Perhaps the underlying</span>
624
+ <a name="l00599"></a>00599 <span class="comment"> * file descriptor isn&#39;t a Unix socket.</span>
625
+ <a name="l00600"></a>00600 <span class="comment"> * @throws IOException Whatever was received doesn&#39;t seem to be a</span>
626
+ <a name="l00601"></a>00601 <span class="comment"> * file descriptor.</span>
627
+ <a name="l00602"></a>00602 <span class="comment"> * @throws boost::thread_interrupted</span>
628
+ <a name="l00603"></a>00603 <span class="comment"> */</span>
629
+ <a name="l00604"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a1a28ba9d078f38f2831673092ac9dcbc">00604</a> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a1a28ba9d078f38f2831673092ac9dcbc" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>(<span class="keywordtype">bool</span> negotiate = <span class="keyword">true</span>) {
630
+ <a name="l00605"></a>00605 <span class="comment">// See message_channel.rb for more info about negotiation.</span>
631
+ <a name="l00606"></a>00606 <span class="keywordflow">if</span> (negotiate) {
632
+ <a name="l00607"></a>00607 <a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;pass IO&quot;</span>, NULL);
633
+ <a name="l00608"></a>00608 }
634
+ <a name="l00609"></a>00609
635
+ <a name="l00610"></a>00610 <span class="keyword">struct </span>msghdr msg;
636
+ <a name="l00611"></a>00611 <span class="keyword">struct </span>iovec vec;
637
+ <a name="l00612"></a>00612 <span class="keywordtype">char</span> dummy[1];
638
+ <a name="l00613"></a>00613 <span class="preprocessor"> #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
639
+ <a name="l00614"></a>00614 <span class="preprocessor"></span> <span class="comment">// File descriptor passing macros (CMSG_*) seem to be broken</span>
640
+ <a name="l00615"></a>00615 <span class="comment">// on 64-bit MacOS X. This structure works around the problem.</span>
641
+ <a name="l00616"></a>00616 <span class="keyword">struct </span>{
642
+ <a name="l00617"></a>00617 <span class="keyword">struct </span>cmsghdr header;
643
+ <a name="l00618"></a>00618 <span class="keywordtype">int</span> fd;
644
+ <a name="l00619"></a>00619 } control_data;
645
+ <a name="l00620"></a>00620 <span class="preprocessor"> #define EXPECTED_CMSG_LEN sizeof(control_data)</span>
646
+ <a name="l00621"></a>00621 <span class="preprocessor"></span><span class="preprocessor"> #else</span>
647
+ <a name="l00622"></a>00622 <span class="preprocessor"></span> <span class="keywordtype">char</span> control_data[CMSG_SPACE(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>))];
648
+ <a name="l00623"></a>00623 <span class="preprocessor"> #define EXPECTED_CMSG_LEN CMSG_LEN(sizeof(int))</span>
649
+ <a name="l00624"></a>00624 <span class="preprocessor"></span><span class="preprocessor"> #endif</span>
650
+ <a name="l00625"></a>00625 <span class="preprocessor"></span> <span class="keyword">struct </span>cmsghdr *control_header;
651
+ <a name="l00626"></a>00626 <span class="keywordtype">int</span> ret;
652
+ <a name="l00627"></a>00627
653
+ <a name="l00628"></a>00628 msg.msg_name = NULL;
654
+ <a name="l00629"></a>00629 msg.msg_namelen = 0;
655
+ <a name="l00630"></a>00630
656
+ <a name="l00631"></a>00631 dummy[0] = <span class="charliteral">&#39;\0&#39;</span>;
657
+ <a name="l00632"></a>00632 vec.iov_base = dummy;
658
+ <a name="l00633"></a>00633 vec.iov_len = <span class="keyword">sizeof</span>(dummy);
659
+ <a name="l00634"></a>00634 msg.msg_iov = &amp;vec;
660
+ <a name="l00635"></a>00635 msg.msg_iovlen = 1;
661
+ <a name="l00636"></a>00636
662
+ <a name="l00637"></a>00637 msg.msg_control = (caddr_t) &amp;control_data;
663
+ <a name="l00638"></a>00638 msg.msg_controllen = <span class="keyword">sizeof</span>(control_data);
664
+ <a name="l00639"></a>00639 msg.msg_flags = 0;
665
+ <a name="l00640"></a>00640
666
+ <a name="l00641"></a>00641 ret = syscalls::recvmsg(fd, &amp;msg, 0);
667
+ <a name="l00642"></a>00642 <span class="keywordflow">if</span> (ret == -1) {
668
+ <a name="l00643"></a>00643 <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">&quot;Cannot read file descriptor with recvmsg()&quot;</span>, errno);
669
+ <a name="l00644"></a>00644 }
670
+ <a name="l00645"></a>00645
671
+ <a name="l00646"></a>00646 control_header = CMSG_FIRSTHDR(&amp;msg);
672
+ <a name="l00647"></a>00647 <span class="keywordflow">if</span> (control_header == NULL) {
673
+ <a name="l00648"></a>00648 <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">&quot;No valid file descriptor received.&quot;</span>);
674
+ <a name="l00649"></a>00649 }
675
+ <a name="l00650"></a>00650 <span class="keywordflow">if</span> (control_header-&gt;cmsg_len != EXPECTED_CMSG_LEN
676
+ <a name="l00651"></a>00651 || control_header-&gt;cmsg_level != SOL_SOCKET
677
+ <a name="l00652"></a>00652 || control_header-&gt;cmsg_type != SCM_RIGHTS) {
678
+ <a name="l00653"></a>00653 <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">&quot;No valid file descriptor received.&quot;</span>);
679
+ <a name="l00654"></a>00654 }
680
+ <a name="l00655"></a>00655
681
+ <a name="l00656"></a>00656 <span class="preprocessor"> #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
682
+ <a name="l00657"></a>00657 <span class="preprocessor"></span> <span class="keywordtype">int</span> fd = control_data.fd;
683
+ <a name="l00658"></a>00658 <span class="preprocessor"> #else</span>
684
+ <a name="l00659"></a>00659 <span class="preprocessor"></span> <span class="keywordtype">int</span> fd = *((<span class="keywordtype">int</span> *) CMSG_DATA(control_header));
685
+ <a name="l00660"></a>00660 <span class="preprocessor"> #endif</span>
686
+ <a name="l00661"></a>00661 <span class="preprocessor"></span>
687
+ <a name="l00662"></a>00662 <span class="keywordflow">if</span> (negotiate) {
688
+ <a name="l00663"></a>00663 <span class="keywordflow">try</span> {
689
+ <a name="l00664"></a>00664 <a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;got IO&quot;</span>, NULL);
690
+ <a name="l00665"></a>00665 } <span class="keywordflow">catch</span> (...) {
691
+ <a name="l00666"></a>00666 this_thread::disable_syscall_interruption dsi;
692
+ <a name="l00667"></a>00667 <a class="code" href="classPassenger_1_1MessageChannel.html#a06309e208fc5e10642a2e9bbe0f351eb" title="Close the underlying file descriptor.">syscalls::close</a>(fd);
693
+ <a name="l00668"></a>00668 <span class="keywordflow">throw</span>;
694
+ <a name="l00669"></a>00669 }
695
+ <a name="l00670"></a>00670 }
696
+ <a name="l00671"></a>00671
697
+ <a name="l00672"></a>00672 <span class="keywordflow">return</span> fd;
698
698
  <a name="l00673"></a>00673 }
699
699
  <a name="l00674"></a>00674 <span class="comment"></span>
700
700
  <a name="l00675"></a>00675 <span class="comment"> /**</span>
701
- <a name="l00676"></a>00676 <span class="comment"> * Receive a file descriptor, which had been passed over the underlying</span>
702
- <a name="l00677"></a>00677 <span class="comment"> * file descriptor.</span>
703
- <a name="l00678"></a>00678 <span class="comment"> *</span>
704
- <a name="l00679"></a>00679 <span class="comment"> * @param negotiate See Ruby&#39;s MessageChannel#send_io method&#39;s comments.</span>
705
- <a name="l00680"></a>00680 <span class="comment"> * @return The passed file descriptor.</span>
706
- <a name="l00681"></a>00681 <span class="comment"> * @throws SystemException If something went wrong during the</span>
707
- <a name="l00682"></a>00682 <span class="comment"> * receiving of a file descriptor. Perhaps the underlying</span>
708
- <a name="l00683"></a>00683 <span class="comment"> * file descriptor isn&#39;t a Unix socket.</span>
709
- <a name="l00684"></a>00684 <span class="comment"> * @throws IOException Whatever was received doesn&#39;t seem to be a</span>
710
- <a name="l00685"></a>00685 <span class="comment"> * file descriptor.</span>
711
- <a name="l00686"></a>00686 <span class="comment"> * @throws boost::thread_interrupted</span>
712
- <a name="l00687"></a>00687 <span class="comment"> */</span>
713
- <a name="l00688"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a1a28ba9d078f38f2831673092ac9dcbc">00688</a> <span class="keywordtype">int</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a1a28ba9d078f38f2831673092ac9dcbc" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>(<span class="keywordtype">bool</span> negotiate = <span class="keyword">true</span>) {
714
- <a name="l00689"></a>00689 <span class="comment">// See message_channel.rb for more info about negotiation.</span>
715
- <a name="l00690"></a>00690 <span class="keywordflow">if</span> (negotiate) {
716
- <a name="l00691"></a>00691 <a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;pass IO&quot;</span>, NULL);
717
- <a name="l00692"></a>00692 }
718
- <a name="l00693"></a>00693
719
- <a name="l00694"></a>00694 <span class="keyword">struct </span>msghdr msg;
720
- <a name="l00695"></a>00695 <span class="keyword">struct </span>iovec vec;
721
- <a name="l00696"></a>00696 <span class="keywordtype">char</span> dummy[1];
722
- <a name="l00697"></a>00697 <span class="preprocessor"> #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
723
- <a name="l00698"></a>00698 <span class="preprocessor"></span> <span class="comment">// File descriptor passing macros (CMSG_*) seem to be broken</span>
724
- <a name="l00699"></a>00699 <span class="comment">// on 64-bit MacOS X. This structure works around the problem.</span>
725
- <a name="l00700"></a>00700 <span class="keyword">struct </span>{
726
- <a name="l00701"></a>00701 <span class="keyword">struct </span>cmsghdr header;
727
- <a name="l00702"></a>00702 <span class="keywordtype">int</span> fd;
728
- <a name="l00703"></a>00703 } control_data;
729
- <a name="l00704"></a>00704 <span class="preprocessor"> #define EXPECTED_CMSG_LEN sizeof(control_data)</span>
730
- <a name="l00705"></a>00705 <span class="preprocessor"></span><span class="preprocessor"> #else</span>
731
- <a name="l00706"></a>00706 <span class="preprocessor"></span> <span class="keywordtype">char</span> control_data[CMSG_SPACE(<span class="keyword">sizeof</span>(<span class="keywordtype">int</span>))];
732
- <a name="l00707"></a>00707 <span class="preprocessor"> #define EXPECTED_CMSG_LEN CMSG_LEN(sizeof(int))</span>
733
- <a name="l00708"></a>00708 <span class="preprocessor"></span><span class="preprocessor"> #endif</span>
734
- <a name="l00709"></a>00709 <span class="preprocessor"></span> <span class="keyword">struct </span>cmsghdr *control_header;
735
- <a name="l00710"></a>00710 <span class="keywordtype">int</span> ret;
736
- <a name="l00711"></a>00711
737
- <a name="l00712"></a>00712 msg.msg_name = NULL;
738
- <a name="l00713"></a>00713 msg.msg_namelen = 0;
739
- <a name="l00714"></a>00714
740
- <a name="l00715"></a>00715 dummy[0] = <span class="charliteral">&#39;\0&#39;</span>;
741
- <a name="l00716"></a>00716 vec.iov_base = dummy;
742
- <a name="l00717"></a>00717 vec.iov_len = <span class="keyword">sizeof</span>(dummy);
743
- <a name="l00718"></a>00718 msg.msg_iov = &amp;vec;
744
- <a name="l00719"></a>00719 msg.msg_iovlen = 1;
745
- <a name="l00720"></a>00720
746
- <a name="l00721"></a>00721 msg.msg_control = (caddr_t) &amp;control_data;
747
- <a name="l00722"></a>00722 msg.msg_controllen = <span class="keyword">sizeof</span>(control_data);
748
- <a name="l00723"></a>00723 msg.msg_flags = 0;
749
- <a name="l00724"></a>00724
750
- <a name="l00725"></a>00725 ret = syscalls::recvmsg(fd, &amp;msg, 0);
751
- <a name="l00726"></a>00726 <span class="keywordflow">if</span> (ret == -1) {
752
- <a name="l00727"></a>00727 <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">&quot;Cannot read file descriptor with recvmsg()&quot;</span>, errno);
753
- <a name="l00728"></a>00728 }
754
- <a name="l00729"></a>00729
755
- <a name="l00730"></a>00730 control_header = CMSG_FIRSTHDR(&amp;msg);
756
- <a name="l00731"></a>00731 <span class="keywordflow">if</span> (control_header == NULL) {
757
- <a name="l00732"></a>00732 <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">&quot;No valid file descriptor received.&quot;</span>);
758
- <a name="l00733"></a>00733 }
759
- <a name="l00734"></a>00734 <span class="keywordflow">if</span> (control_header-&gt;cmsg_len != EXPECTED_CMSG_LEN
760
- <a name="l00735"></a>00735 || control_header-&gt;cmsg_level != SOL_SOCKET
761
- <a name="l00736"></a>00736 || control_header-&gt;cmsg_type != SCM_RIGHTS) {
762
- <a name="l00737"></a>00737 <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">&quot;No valid file descriptor received.&quot;</span>);
763
- <a name="l00738"></a>00738 }
764
- <a name="l00739"></a>00739
765
- <a name="l00740"></a>00740 <span class="preprocessor"> #if defined(__APPLE__) || defined(__SOLARIS__) || defined(__arm__)</span>
766
- <a name="l00741"></a>00741 <span class="preprocessor"></span> <span class="keywordtype">int</span> fd = control_data.fd;
767
- <a name="l00742"></a>00742 <span class="preprocessor"> #else</span>
768
- <a name="l00743"></a>00743 <span class="preprocessor"></span> <span class="keywordtype">int</span> fd = *((<span class="keywordtype">int</span> *) CMSG_DATA(control_header));
769
- <a name="l00744"></a>00744 <span class="preprocessor"> #endif</span>
770
- <a name="l00745"></a>00745 <span class="preprocessor"></span>
771
- <a name="l00746"></a>00746 <span class="keywordflow">if</span> (negotiate) {
772
- <a name="l00747"></a>00747 <span class="keywordflow">try</span> {
773
- <a name="l00748"></a>00748 <a class="code" href="classPassenger_1_1MessageChannel.html#a150f68bc47e060dcc6ca35bee047914d" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<span class="stringliteral">&quot;got IO&quot;</span>, NULL);
774
- <a name="l00749"></a>00749 } <span class="keywordflow">catch</span> (...) {
775
- <a name="l00750"></a>00750 this_thread::disable_syscall_interruption dsi;
776
- <a name="l00751"></a>00751 <a class="code" href="classPassenger_1_1MessageChannel.html#a06309e208fc5e10642a2e9bbe0f351eb" title="Close the underlying file descriptor.">syscalls::close</a>(fd);
777
- <a name="l00752"></a>00752 <span class="keywordflow">throw</span>;
778
- <a name="l00753"></a>00753 }
779
- <a name="l00754"></a>00754 }
780
- <a name="l00755"></a>00755
781
- <a name="l00756"></a>00756 <span class="keywordflow">return</span> fd;
782
- <a name="l00757"></a>00757 }
783
- <a name="l00758"></a>00758 <span class="comment"></span>
784
- <a name="l00759"></a>00759 <span class="comment"> /**</span>
785
- <a name="l00760"></a>00760 <span class="comment"> * Set the timeout value for reading data from this channel.</span>
786
- <a name="l00761"></a>00761 <span class="comment"> * If no data can be read within the timeout period, then a</span>
787
- <a name="l00762"></a>00762 <span class="comment"> * SystemException will be thrown by one of the read methods,</span>
788
- <a name="l00763"></a>00763 <span class="comment"> * with error code EAGAIN or EWOULDBLOCK.</span>
789
- <a name="l00764"></a>00764 <span class="comment"> *</span>
790
- <a name="l00765"></a>00765 <span class="comment"> * @param msec The timeout, in milliseconds. If 0 is given,</span>
791
- <a name="l00766"></a>00766 <span class="comment"> * there will be no timeout.</span>
792
- <a name="l00767"></a>00767 <span class="comment"> * @throws SystemException Cannot set the timeout.</span>
793
- <a name="l00768"></a>00768 <span class="comment"> */</span>
794
- <a name="l00769"></a><a class="code" href="classPassenger_1_1MessageChannel.html#aeb69bffbbb148c9bc8662e20b416c4e2">00769</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#aeb69bffbbb148c9bc8662e20b416c4e2" title="Set the timeout value for reading data from this channel.">setReadTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) {
795
- <a name="l00770"></a>00770 <span class="comment">// See the comment for setWriteTimeout().</span>
796
- <a name="l00771"></a>00771 <span class="keyword">struct </span>timeval tv;
797
- <a name="l00772"></a>00772 <span class="keywordtype">int</span> ret;
798
- <a name="l00773"></a>00773
799
- <a name="l00774"></a>00774 tv.tv_sec = msec / 1000;
800
- <a name="l00775"></a>00775 tv.tv_usec = msec % 1000 * 1000;
801
- <a name="l00776"></a>00776 ret = syscalls::setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO,
802
- <a name="l00777"></a>00777 &amp;tv, <span class="keyword">sizeof</span>(tv));
803
- <a name="l00778"></a>00778 <span class="preprocessor"> #ifndef __SOLARIS__</span>
804
- <a name="l00779"></a>00779 <span class="preprocessor"></span> <span class="comment">// SO_RCVTIMEO is unimplemented and returns an error on Solaris</span>
805
- <a name="l00780"></a>00780 <span class="comment">// 9 and 10 SPARC. Seems to work okay without it.</span>
806
- <a name="l00781"></a>00781 <span class="keywordflow">if</span> (ret == -1) {
807
- <a name="l00782"></a>00782 <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">&quot;Cannot set read timeout for socket&quot;</span>, errno);
808
- <a name="l00783"></a>00783 }
809
- <a name="l00784"></a>00784 <span class="preprocessor"> #endif</span>
810
- <a name="l00785"></a>00785 <span class="preprocessor"></span> }
811
- <a name="l00786"></a>00786 <span class="comment"></span>
812
- <a name="l00787"></a>00787 <span class="comment"> /**</span>
813
- <a name="l00788"></a>00788 <span class="comment"> * Set the timeout value for writing data to this channel.</span>
814
- <a name="l00789"></a>00789 <span class="comment"> * If no data can be written within the timeout period, then a</span>
815
- <a name="l00790"></a>00790 <span class="comment"> * SystemException will be thrown, with error code EAGAIN or</span>
816
- <a name="l00791"></a>00791 <span class="comment"> * EWOULDBLOCK.</span>
817
- <a name="l00792"></a>00792 <span class="comment"> *</span>
818
- <a name="l00793"></a>00793 <span class="comment"> * @param msec The timeout, in milliseconds. If 0 is given,</span>
819
- <a name="l00794"></a>00794 <span class="comment"> * there will be no timeout.</span>
820
- <a name="l00795"></a>00795 <span class="comment"> * @throws SystemException Cannot set the timeout.</span>
821
- <a name="l00796"></a>00796 <span class="comment"> */</span>
822
- <a name="l00797"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a77c5d7c47f387cf43992ebeb14e3c6c7">00797</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a77c5d7c47f387cf43992ebeb14e3c6c7" title="Set the timeout value for writing data to this channel.">setWriteTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) {
823
- <a name="l00798"></a>00798 <span class="comment">// People say that SO_RCVTIMEO/SO_SNDTIMEO are unreliable and</span>
824
- <a name="l00799"></a>00799 <span class="comment">// not well-implemented on all platforms.</span>
825
- <a name="l00800"></a>00800 <span class="comment">// http://www.developerweb.net/forum/archive/index.php/t-3439.html</span>
826
- <a name="l00801"></a>00801 <span class="comment">// That&#39;s why we use APR&#39;s timeout facilities as well (see Hooks.cpp).</span>
827
- <a name="l00802"></a>00802 <span class="keyword">struct </span>timeval tv;
828
- <a name="l00803"></a>00803 <span class="keywordtype">int</span> ret;
829
- <a name="l00804"></a>00804
830
- <a name="l00805"></a>00805 tv.tv_sec = msec / 1000;
831
- <a name="l00806"></a>00806 tv.tv_usec = msec % 1000 * 1000;
832
- <a name="l00807"></a>00807 ret = syscalls::setsockopt(fd, SOL_SOCKET, SO_SNDTIMEO,
833
- <a name="l00808"></a>00808 &amp;tv, <span class="keyword">sizeof</span>(tv));
834
- <a name="l00809"></a>00809 <span class="preprocessor"> #ifndef __SOLARIS__</span>
835
- <a name="l00810"></a>00810 <span class="preprocessor"></span> <span class="comment">// SO_SNDTIMEO is unimplemented and returns an error on Solaris</span>
836
- <a name="l00811"></a>00811 <span class="comment">// 9 and 10 SPARC. Seems to work okay without it.</span>
837
- <a name="l00812"></a>00812 <span class="keywordflow">if</span> (ret == -1) {
838
- <a name="l00813"></a>00813 <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">&quot;Cannot set read timeout for socket&quot;</span>, errno);
839
- <a name="l00814"></a>00814 }
840
- <a name="l00815"></a>00815 <span class="preprocessor"> #endif</span>
841
- <a name="l00816"></a>00816 <span class="preprocessor"></span> }
842
- <a name="l00817"></a>00817 };
843
- <a name="l00818"></a>00818
844
- <a name="l00819"></a>00819 } <span class="comment">// namespace Passenger</span>
845
- <a name="l00820"></a>00820
846
- <a name="l00821"></a>00821 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_MESSAGE_CHANNEL_H_ */</span>
701
+ <a name="l00676"></a>00676 <span class="comment"> * Set the timeout value for reading data from this channel.</span>
702
+ <a name="l00677"></a>00677 <span class="comment"> * If no data can be read within the timeout period, then a</span>
703
+ <a name="l00678"></a>00678 <span class="comment"> * SystemException will be thrown by one of the read methods,</span>
704
+ <a name="l00679"></a>00679 <span class="comment"> * with error code EAGAIN or EWOULDBLOCK.</span>
705
+ <a name="l00680"></a>00680 <span class="comment"> *</span>
706
+ <a name="l00681"></a>00681 <span class="comment"> * @param msec The timeout, in milliseconds. If 0 is given,</span>
707
+ <a name="l00682"></a>00682 <span class="comment"> * there will be no timeout.</span>
708
+ <a name="l00683"></a>00683 <span class="comment"> * @throws SystemException Cannot set the timeout.</span>
709
+ <a name="l00684"></a>00684 <span class="comment"> */</span>
710
+ <a name="l00685"></a><a class="code" href="classPassenger_1_1MessageChannel.html#aeb69bffbbb148c9bc8662e20b416c4e2">00685</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#aeb69bffbbb148c9bc8662e20b416c4e2" title="Set the timeout value for reading data from this channel.">setReadTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) {
711
+ <a name="l00686"></a>00686 <span class="comment">// See the comment for setWriteTimeout().</span>
712
+ <a name="l00687"></a>00687 <span class="keyword">struct </span>timeval tv;
713
+ <a name="l00688"></a>00688 <span class="keywordtype">int</span> ret;
714
+ <a name="l00689"></a>00689
715
+ <a name="l00690"></a>00690 tv.tv_sec = msec / 1000;
716
+ <a name="l00691"></a>00691 tv.tv_usec = msec % 1000 * 1000;
717
+ <a name="l00692"></a>00692 ret = syscalls::setsockopt(fd, SOL_SOCKET, SO_RCVTIMEO,
718
+ <a name="l00693"></a>00693 &amp;tv, <span class="keyword">sizeof</span>(tv));
719
+ <a name="l00694"></a>00694 <span class="preprocessor"> #ifndef __SOLARIS__</span>
720
+ <a name="l00695"></a>00695 <span class="preprocessor"></span> <span class="comment">// SO_RCVTIMEO is unimplemented and returns an error on Solaris</span>
721
+ <a name="l00696"></a>00696 <span class="comment">// 9 and 10 SPARC. Seems to work okay without it.</span>
722
+ <a name="l00697"></a>00697 <span class="keywordflow">if</span> (ret == -1) {
723
+ <a name="l00698"></a>00698 <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">&quot;Cannot set read timeout for socket&quot;</span>, errno);
724
+ <a name="l00699"></a>00699 }
725
+ <a name="l00700"></a>00700 <span class="preprocessor"> #endif</span>
726
+ <a name="l00701"></a>00701 <span class="preprocessor"></span> }
727
+ <a name="l00702"></a>00702 <span class="comment"></span>
728
+ <a name="l00703"></a>00703 <span class="comment"> /**</span>
729
+ <a name="l00704"></a>00704 <span class="comment"> * Set the timeout value for writing data to this channel.</span>
730
+ <a name="l00705"></a>00705 <span class="comment"> * If no data can be written within the timeout period, then a</span>
731
+ <a name="l00706"></a>00706 <span class="comment"> * SystemException will be thrown, with error code EAGAIN or</span>
732
+ <a name="l00707"></a>00707 <span class="comment"> * EWOULDBLOCK.</span>
733
+ <a name="l00708"></a>00708 <span class="comment"> *</span>
734
+ <a name="l00709"></a>00709 <span class="comment"> * @param msec The timeout, in milliseconds. If 0 is given,</span>
735
+ <a name="l00710"></a>00710 <span class="comment"> * there will be no timeout.</span>
736
+ <a name="l00711"></a>00711 <span class="comment"> * @throws SystemException Cannot set the timeout.</span>
737
+ <a name="l00712"></a>00712 <span class="comment"> */</span>
738
+ <a name="l00713"></a><a class="code" href="classPassenger_1_1MessageChannel.html#a77c5d7c47f387cf43992ebeb14e3c6c7">00713</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MessageChannel.html#a77c5d7c47f387cf43992ebeb14e3c6c7" title="Set the timeout value for writing data to this channel.">setWriteTimeout</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> msec) {
739
+ <a name="l00714"></a>00714 <span class="comment">// People say that SO_RCVTIMEO/SO_SNDTIMEO are unreliable and</span>
740
+ <a name="l00715"></a>00715 <span class="comment">// not well-implemented on all platforms.</span>
741
+ <a name="l00716"></a>00716 <span class="comment">// http://www.developerweb.net/forum/archive/index.php/t-3439.html</span>
742
+ <a name="l00717"></a>00717 <span class="comment">// That&#39;s why we use APR&#39;s timeout facilities as well (see Hooks.cpp).</span>
743
+ <a name="l00718"></a>00718 <span class="keyword">struct </span>timeval tv;
744
+ <a name="l00719"></a>00719 <span class="keywordtype">int</span> ret;
745
+ <a name="l00720"></a>00720
746
+ <a name="l00721"></a>00721 tv.tv_sec = msec / 1000;
747
+ <a name="l00722"></a>00722 tv.tv_usec = msec % 1000 * 1000;
748
+ <a name="l00723"></a>00723 ret = syscalls::setsockopt(fd, SOL_SOCKET, SO_SNDTIMEO,
749
+ <a name="l00724"></a>00724 &amp;tv, <span class="keyword">sizeof</span>(tv));
750
+ <a name="l00725"></a>00725 <span class="preprocessor"> #ifndef __SOLARIS__</span>
751
+ <a name="l00726"></a>00726 <span class="preprocessor"></span> <span class="comment">// SO_SNDTIMEO is unimplemented and returns an error on Solaris</span>
752
+ <a name="l00727"></a>00727 <span class="comment">// 9 and 10 SPARC. Seems to work okay without it.</span>
753
+ <a name="l00728"></a>00728 <span class="keywordflow">if</span> (ret == -1) {
754
+ <a name="l00729"></a>00729 <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">&quot;Cannot set read timeout for socket&quot;</span>, errno);
755
+ <a name="l00730"></a>00730 }
756
+ <a name="l00731"></a>00731 <span class="preprocessor"> #endif</span>
757
+ <a name="l00732"></a>00732 <span class="preprocessor"></span> }
758
+ <a name="l00733"></a>00733 };
759
+ <a name="l00734"></a>00734
760
+ <a name="l00735"></a>00735 } <span class="comment">// namespace Passenger</span>
761
+ <a name="l00736"></a>00736
762
+ <a name="l00737"></a>00737 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_MESSAGE_CHANNEL_H_ */</span>
847
763
  </pre></div></div>
848
764
  <hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
849
765
  <a href="http://www.doxygen.org/index.html">