passenger 3.0.2 → 3.0.3

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 (220) hide show
  1. data/NEWS +29 -0
  2. data/build/agents.rb +1 -0
  3. data/build/apache2.rb +2 -1
  4. data/build/cxx_tests.rb +7 -0
  5. data/build/rpm.rb +17 -22
  6. data/doc/cxxapi/Constants_8h_source.html +1 -1
  7. data/doc/cxxapi/Exceptions_8h_source.html +18 -4
  8. data/doc/cxxapi/Logging_8h_source.html +332 -262
  9. data/doc/cxxapi/annotated.html +1 -0
  10. data/doc/cxxapi/classes.html +4 -4
  11. data/doc/cxxapi/group__Exceptions.html +2 -0
  12. data/doc/cxxapi/hierarchy.html +1 -0
  13. data/doc/cxxapi/inherit__graph__35.map +1 -3
  14. data/doc/cxxapi/inherit__graph__35.md5 +1 -1
  15. data/doc/cxxapi/inherit__graph__35.png +0 -0
  16. data/doc/cxxapi/inherit__graph__36.map +3 -1
  17. data/doc/cxxapi/inherit__graph__36.md5 +1 -1
  18. data/doc/cxxapi/inherit__graph__36.png +0 -0
  19. data/doc/cxxapi/inherit__graph__37.map +1 -1
  20. data/doc/cxxapi/inherit__graph__37.md5 +1 -1
  21. data/doc/cxxapi/inherit__graph__37.png +0 -0
  22. data/doc/cxxapi/inherit__graph__38.map +1 -1
  23. data/doc/cxxapi/inherit__graph__38.md5 +1 -1
  24. data/doc/cxxapi/inherit__graph__38.png +0 -0
  25. data/doc/cxxapi/inherit__graph__39.map +1 -1
  26. data/doc/cxxapi/inherit__graph__39.md5 +1 -1
  27. data/doc/cxxapi/inherit__graph__39.png +0 -0
  28. data/doc/cxxapi/inherit__graph__40.map +1 -1
  29. data/doc/cxxapi/inherit__graph__40.md5 +1 -1
  30. data/doc/cxxapi/inherit__graph__40.png +0 -0
  31. data/doc/cxxapi/inherits.html +9 -6
  32. data/doc/cxxapi/namespacePassenger.html +2 -0
  33. data/doc/cxxapi/tree.html +2 -0
  34. data/doc/rdoc/classes/ConditionVariable.html +215 -0
  35. data/doc/rdoc/classes/Exception.html +120 -0
  36. data/doc/rdoc/classes/GC.html +113 -0
  37. data/doc/rdoc/classes/IO.html +221 -0
  38. data/doc/rdoc/classes/PhusionPassenger.html +397 -0
  39. data/doc/rdoc/classes/PhusionPassenger/AbstractInstaller.html +180 -0
  40. data/doc/rdoc/classes/PhusionPassenger/AbstractRequestHandler.html +647 -0
  41. data/doc/rdoc/classes/PhusionPassenger/AbstractServer.html +654 -0
  42. data/doc/rdoc/classes/PhusionPassenger/AbstractServer/InvalidPassword.html +92 -0
  43. data/doc/rdoc/classes/PhusionPassenger/AbstractServer/ServerAlreadyStarted.html +97 -0
  44. data/doc/rdoc/classes/PhusionPassenger/AbstractServer/ServerError.html +96 -0
  45. data/doc/rdoc/classes/PhusionPassenger/AbstractServer/ServerNotStarted.html +97 -0
  46. data/doc/rdoc/classes/PhusionPassenger/AbstractServer/UnknownMessage.html +96 -0
  47. data/doc/rdoc/classes/PhusionPassenger/AbstractServerCollection.html +619 -0
  48. data/doc/rdoc/classes/PhusionPassenger/AdminTools.html +142 -0
  49. data/doc/rdoc/classes/PhusionPassenger/AdminTools/MemoryStats.html +368 -0
  50. data/doc/rdoc/classes/PhusionPassenger/AdminTools/MemoryStats/Process.html +231 -0
  51. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance.html +588 -0
  52. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance/CorruptedDirectoryError.html +92 -0
  53. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance/GenerationsAbsentError.html +92 -0
  54. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance/Group.html +147 -0
  55. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance/Process.html +279 -0
  56. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance/RoleDeniedError.html +92 -0
  57. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance/StaleDirectoryError.html +92 -0
  58. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance/Stats.html +123 -0
  59. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ServerInstance/UnsupportedGenerationStructureVersionError.html +92 -0
  60. data/doc/rdoc/classes/PhusionPassenger/AnalyticsLogger.html +368 -0
  61. data/doc/rdoc/classes/PhusionPassenger/AnalyticsLogger/Log.html +299 -0
  62. data/doc/rdoc/classes/PhusionPassenger/AnalyticsLogger/SharedData.html +206 -0
  63. data/doc/rdoc/classes/PhusionPassenger/AppInitError.html +155 -0
  64. data/doc/rdoc/classes/PhusionPassenger/AppProcess.html +367 -0
  65. data/doc/rdoc/classes/PhusionPassenger/ClassicRails.html +95 -0
  66. data/doc/rdoc/classes/PhusionPassenger/ClassicRails/ApplicationSpawner.html +351 -0
  67. data/doc/rdoc/classes/PhusionPassenger/ClassicRails/ApplicationSpawner/Error.html +98 -0
  68. data/doc/rdoc/classes/PhusionPassenger/ClassicRails/CGIFixed.html +200 -0
  69. data/doc/rdoc/classes/PhusionPassenger/ClassicRails/FrameworkSpawner.html +410 -0
  70. data/doc/rdoc/classes/PhusionPassenger/ClassicRails/FrameworkSpawner/Error.html +98 -0
  71. data/doc/rdoc/classes/PhusionPassenger/ClassicRails/RequestHandler.html +156 -0
  72. data/doc/rdoc/classes/PhusionPassenger/ClassicRailsExtensions.html +115 -0
  73. data/doc/rdoc/classes/PhusionPassenger/ClassicRailsExtensions/AnalyticsLogging.html +202 -0
  74. data/doc/rdoc/classes/PhusionPassenger/ConsoleTextTemplate.html +172 -0
  75. data/doc/rdoc/classes/PhusionPassenger/DebugLogging.html +273 -0
  76. data/doc/rdoc/classes/PhusionPassenger/FrameworkInitError.html +145 -0
  77. data/doc/rdoc/classes/PhusionPassenger/HTMLTemplate.html +162 -0
  78. data/doc/rdoc/classes/PhusionPassenger/InitializationError.html +141 -0
  79. data/doc/rdoc/classes/PhusionPassenger/InvalidPath.html +92 -0
  80. data/doc/rdoc/classes/PhusionPassenger/MessageChannel.html +673 -0
  81. data/doc/rdoc/classes/PhusionPassenger/MessageChannel/InvalidHashError.html +92 -0
  82. data/doc/rdoc/classes/PhusionPassenger/MessageClient.html +415 -0
  83. data/doc/rdoc/classes/PhusionPassenger/NativeSupportLoader.html +134 -0
  84. data/doc/rdoc/classes/PhusionPassenger/Packaging.html +129 -0
  85. data/doc/rdoc/classes/PhusionPassenger/PlatformInfo.html +1972 -0
  86. data/doc/rdoc/classes/PhusionPassenger/Plugin.html +237 -0
  87. data/doc/rdoc/classes/PhusionPassenger/Rack.html +91 -0
  88. data/doc/rdoc/classes/PhusionPassenger/Rack/ApplicationSpawner.html +312 -0
  89. data/doc/rdoc/classes/PhusionPassenger/Rack/ApplicationSpawner/Error.html +98 -0
  90. data/doc/rdoc/classes/PhusionPassenger/Rack/RequestHandler.html +218 -0
  91. data/doc/rdoc/classes/PhusionPassenger/Rails3Extensions.html +114 -0
  92. data/doc/rdoc/classes/PhusionPassenger/Rails3Extensions/AnalyticsLogging.html +259 -0
  93. data/doc/rdoc/classes/PhusionPassenger/Rails3Extensions/AnalyticsLogging/ACExtension.html +139 -0
  94. data/doc/rdoc/classes/PhusionPassenger/Rails3Extensions/AnalyticsLogging/ASBenchmarkableExtension.html +118 -0
  95. data/doc/rdoc/classes/PhusionPassenger/Rails3Extensions/AnalyticsLogging/ExceptionLogger.html +135 -0
  96. data/doc/rdoc/classes/PhusionPassenger/SpawnManager.html +378 -0
  97. data/doc/rdoc/classes/PhusionPassenger/Standalone.html +111 -0
  98. data/doc/rdoc/classes/PhusionPassenger/Standalone/AppFinder.html +252 -0
  99. data/doc/rdoc/classes/PhusionPassenger/Standalone/Command.html +161 -0
  100. data/doc/rdoc/classes/PhusionPassenger/Standalone/ConfigFile.html +368 -0
  101. data/doc/rdoc/classes/PhusionPassenger/Standalone/ConfigFile/DisallowedContextError.html +132 -0
  102. data/doc/rdoc/classes/PhusionPassenger/Standalone/HelpCommand.html +151 -0
  103. data/doc/rdoc/classes/PhusionPassenger/Standalone/Main.html +189 -0
  104. data/doc/rdoc/classes/PhusionPassenger/Standalone/PackageRuntimeCommand.html +177 -0
  105. data/doc/rdoc/classes/PhusionPassenger/Standalone/RuntimeInstaller.html +341 -0
  106. data/doc/rdoc/classes/PhusionPassenger/Standalone/StartCommand.html +203 -0
  107. data/doc/rdoc/classes/PhusionPassenger/Standalone/StatusCommand.html +156 -0
  108. data/doc/rdoc/classes/PhusionPassenger/Standalone/StopCommand.html +168 -0
  109. data/doc/rdoc/classes/PhusionPassenger/Standalone/Utils.html +86 -0
  110. data/doc/rdoc/classes/PhusionPassenger/Standalone/VersionCommand.html +135 -0
  111. data/doc/rdoc/classes/PhusionPassenger/UnknownError.html +125 -0
  112. data/doc/rdoc/classes/PhusionPassenger/Utils.html +1543 -0
  113. data/doc/rdoc/classes/PhusionPassenger/Utils/FileSystemWatcher.html +204 -0
  114. data/doc/rdoc/classes/PhusionPassenger/Utils/FileSystemWatcher/DirInfo.html +171 -0
  115. data/doc/rdoc/classes/PhusionPassenger/Utils/FileSystemWatcher/FileInfo.html +140 -0
  116. data/doc/rdoc/classes/PhusionPassenger/Utils/HostsFileParser.html +260 -0
  117. data/doc/rdoc/classes/PhusionPassenger/Utils/PseudoIO.html +194 -0
  118. data/doc/rdoc/classes/PhusionPassenger/Utils/RewindableInput.html +265 -0
  119. data/doc/rdoc/classes/PhusionPassenger/Utils/RewindableInput/Tempfile.html +120 -0
  120. data/doc/rdoc/classes/PhusionPassenger/Utils/UnseekableSocket.html +561 -0
  121. data/doc/rdoc/classes/PhusionPassenger/VersionNotFound.html +140 -0
  122. data/doc/rdoc/classes/PhusionPassenger/WSGI.html +89 -0
  123. data/doc/rdoc/classes/PhusionPassenger/WSGI/ApplicationSpawner.html +182 -0
  124. data/doc/rdoc/classes/Process.html +115 -0
  125. data/doc/rdoc/classes/Signal.html +139 -0
  126. data/doc/rdoc/created.rid +1 -0
  127. data/doc/rdoc/files/DEVELOPERS_TXT.html +280 -0
  128. data/doc/rdoc/files/README.html +157 -0
  129. data/doc/rdoc/files/lib/phusion_passenger/abstract_installer_rb.html +130 -0
  130. data/doc/rdoc/files/lib/phusion_passenger/abstract_request_handler_rb.html +135 -0
  131. data/doc/rdoc/files/lib/phusion_passenger/abstract_server_collection_rb.html +126 -0
  132. data/doc/rdoc/files/lib/phusion_passenger/abstract_server_rb.html +128 -0
  133. data/doc/rdoc/files/lib/phusion_passenger/admin_tools/memory_stats_rb.html +126 -0
  134. data/doc/rdoc/files/lib/phusion_passenger/admin_tools/server_instance_rb.html +132 -0
  135. data/doc/rdoc/files/lib/phusion_passenger/admin_tools_rb.html +122 -0
  136. data/doc/rdoc/files/lib/phusion_passenger/analytics_logger_rb.html +129 -0
  137. data/doc/rdoc/files/lib/phusion_passenger/app_process_rb.html +127 -0
  138. data/doc/rdoc/files/lib/phusion_passenger/classic_rails/application_spawner_rb.html +141 -0
  139. data/doc/rdoc/files/lib/phusion_passenger/classic_rails/cgi_fixed_rb.html +126 -0
  140. data/doc/rdoc/files/lib/phusion_passenger/classic_rails/framework_spawner_rb.html +146 -0
  141. data/doc/rdoc/files/lib/phusion_passenger/classic_rails/request_handler_rb.html +125 -0
  142. data/doc/rdoc/files/lib/phusion_passenger/classic_rails_extensions/init_rb.html +132 -0
  143. data/doc/rdoc/files/lib/phusion_passenger/console_text_template_rb.html +126 -0
  144. data/doc/rdoc/files/lib/phusion_passenger/constants_rb.html +122 -0
  145. data/doc/rdoc/files/lib/phusion_passenger/debug_logging_rb.html +122 -0
  146. data/doc/rdoc/files/lib/phusion_passenger/dependencies_rb.html +147 -0
  147. data/doc/rdoc/files/lib/phusion_passenger/exceptions_rb.html +122 -0
  148. data/doc/rdoc/files/lib/phusion_passenger/html_template_rb.html +127 -0
  149. data/doc/rdoc/files/lib/phusion_passenger/message_channel_rb.html +120 -0
  150. data/doc/rdoc/files/lib/phusion_passenger/message_client_rb.html +127 -0
  151. data/doc/rdoc/files/lib/phusion_passenger/native_support_rb.html +132 -0
  152. data/doc/rdoc/files/lib/phusion_passenger/packaging_rb.html +122 -0
  153. data/doc/rdoc/files/lib/phusion_passenger/platform_info/apache_rb.html +127 -0
  154. data/doc/rdoc/files/lib/phusion_passenger/platform_info/binary_compatibility_rb.html +129 -0
  155. data/doc/rdoc/files/lib/phusion_passenger/platform_info/compiler_rb.html +127 -0
  156. data/doc/rdoc/files/lib/phusion_passenger/platform_info/curl_rb.html +126 -0
  157. data/doc/rdoc/files/lib/phusion_passenger/platform_info/documentation_tools_rb.html +126 -0
  158. data/doc/rdoc/files/lib/phusion_passenger/platform_info/linux_rb.html +126 -0
  159. data/doc/rdoc/files/lib/phusion_passenger/platform_info/operating_system_rb.html +127 -0
  160. data/doc/rdoc/files/lib/phusion_passenger/platform_info/ruby_rb.html +128 -0
  161. data/doc/rdoc/files/lib/phusion_passenger/platform_info/zlib_rb.html +126 -0
  162. data/doc/rdoc/files/lib/phusion_passenger/platform_info_rb.html +122 -0
  163. data/doc/rdoc/files/lib/phusion_passenger/plugin_rb.html +127 -0
  164. data/doc/rdoc/files/lib/phusion_passenger/public_api_rb.html +127 -0
  165. data/doc/rdoc/files/lib/phusion_passenger/rack/application_spawner_rb.html +137 -0
  166. data/doc/rdoc/files/lib/phusion_passenger/rack/request_handler_rb.html +125 -0
  167. data/doc/rdoc/files/lib/phusion_passenger/rails3_extensions/init_rb.html +127 -0
  168. data/doc/rdoc/files/lib/phusion_passenger/simple_benchmarking_rb.html +122 -0
  169. data/doc/rdoc/files/lib/phusion_passenger/spawn_manager_rb.html +160 -0
  170. data/doc/rdoc/files/lib/phusion_passenger/standalone/app_finder_rb.html +127 -0
  171. data/doc/rdoc/files/lib/phusion_passenger/standalone/command_rb.html +136 -0
  172. data/doc/rdoc/files/lib/phusion_passenger/standalone/config_file_rb.html +126 -0
  173. data/doc/rdoc/files/lib/phusion_passenger/standalone/help_command_rb.html +126 -0
  174. data/doc/rdoc/files/lib/phusion_passenger/standalone/main_rb.html +126 -0
  175. data/doc/rdoc/files/lib/phusion_passenger/standalone/package_runtime_command_rb.html +127 -0
  176. data/doc/rdoc/files/lib/phusion_passenger/standalone/runtime_installer_rb.html +133 -0
  177. data/doc/rdoc/files/lib/phusion_passenger/standalone/start_command_rb.html +136 -0
  178. data/doc/rdoc/files/lib/phusion_passenger/standalone/status_command_rb.html +126 -0
  179. data/doc/rdoc/files/lib/phusion_passenger/standalone/stop_command_rb.html +126 -0
  180. data/doc/rdoc/files/lib/phusion_passenger/standalone/utils_rb.html +126 -0
  181. data/doc/rdoc/files/lib/phusion_passenger/standalone/version_command_rb.html +127 -0
  182. data/doc/rdoc/files/lib/phusion_passenger/utils/file_system_watcher_rb.html +126 -0
  183. data/doc/rdoc/files/lib/phusion_passenger/utils/hosts_file_parser_rb.html +120 -0
  184. data/doc/rdoc/files/lib/phusion_passenger/utils/rewindable_input_rb.html +100 -0
  185. data/doc/rdoc/files/lib/phusion_passenger/utils/tmpdir_rb.html +122 -0
  186. data/doc/rdoc/files/lib/phusion_passenger/utils/unseekable_socket_rb.html +126 -0
  187. data/doc/rdoc/files/lib/phusion_passenger/utils_rb.html +179 -0
  188. data/doc/rdoc/files/lib/phusion_passenger/wsgi/application_spawner_rb.html +132 -0
  189. data/doc/rdoc/fr_class_index.html +139 -0
  190. data/doc/rdoc/fr_file_index.html +108 -0
  191. data/doc/rdoc/fr_method_index.html +439 -0
  192. data/doc/rdoc/index.html +26 -0
  193. data/doc/rdoc/rdoc-style.css +187 -0
  194. data/ext/apache2/Configuration.cpp +41 -0
  195. data/ext/apache2/Configuration.hpp +19 -0
  196. data/ext/apache2/Hooks.cpp +67 -5
  197. data/ext/common/Constants.h +1 -1
  198. data/ext/common/Exceptions.h +14 -0
  199. data/ext/common/Logging.h +76 -6
  200. data/ext/common/LoggingAgent/FilterSupport.h +1317 -0
  201. data/ext/common/LoggingAgent/LoggingServer.h +93 -4
  202. data/ext/common/LoggingAgent/RemoteSender.h +5 -5
  203. data/ext/common/Utils/StrIntUtils.cpp +12 -1
  204. data/ext/common/Utils/StrIntUtils.h +2 -1
  205. data/ext/common/Utils/StringMap.h +100 -0
  206. data/ext/nginx/Configuration.c +0 -1
  207. data/ext/nginx/ContentHandler.c +33 -7
  208. data/lib/phusion_passenger.rb +2 -2
  209. data/lib/phusion_passenger/abstract_request_handler.rb +5 -0
  210. data/lib/phusion_passenger/analytics_logger.rb +77 -11
  211. data/lib/phusion_passenger/dependencies.rb +11 -1
  212. data/lib/phusion_passenger/platform_info.rb +1 -1
  213. data/lib/phusion_passenger/utils.rb +9 -1
  214. data/test/cxx/FilterSupportTest.cpp +276 -0
  215. data/test/cxx/LoggingTest.cpp +28 -0
  216. data/test/cxx/StringMapTest.cpp +70 -0
  217. data/test/integration_tests/cgi_environment_spec.rb +10 -0
  218. metadata +170 -8
  219. data/ext/common/libboost_oxt/aggregate.cpp +0 -10
  220. data/ext/common/libpassenger_common/aggregate.cpp +0 -15
@@ -0,0 +1,654 @@
1
+ <?xml version="1.0" encoding="iso-8859-1"?>
2
+ <!DOCTYPE html
3
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
+ <html>
6
+ <head>
7
+ <title>Class: PhusionPassenger::AbstractServer</title>
8
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
9
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
10
+
11
+ <script language="JavaScript" type="text/javascript">
12
+ // <![CDATA[
13
+
14
+ function toggleSource( id )
15
+ {
16
+ var elem
17
+ var link
18
+
19
+ if( document.getElementById )
20
+ {
21
+ elem = document.getElementById( id )
22
+ link = document.getElementById( "l_" + id )
23
+ }
24
+ else if ( document.all )
25
+ {
26
+ elem = eval( "document.all." + id )
27
+ link = eval( "document.all.l_" + id )
28
+ }
29
+ else
30
+ return false;
31
+
32
+ if( elem.style.display == "block" )
33
+ {
34
+ elem.style.display = "none"
35
+ link.innerHTML = "show source"
36
+ }
37
+ else
38
+ {
39
+ elem.style.display = "block"
40
+ link.innerHTML = "hide source"
41
+ }
42
+ }
43
+
44
+ function openCode( url )
45
+ {
46
+ window.open( url, "SOURCE_CODE", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=480,width=750" ).focus();
47
+ }
48
+ // ]]>
49
+ </script>
50
+ </head>
51
+
52
+ <body>
53
+ <table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
54
+ <td class="file-title"><span class="file-title-prefix">Class</span><br />PhusionPassenger::AbstractServer</td>
55
+ <td align="right">
56
+ <table cellspacing="0" cellpadding="2">
57
+ <tr valign="top">
58
+ <td>In:</td>
59
+ <td>
60
+ <a href="../../files/lib/phusion_passenger/abstract_server_rb.html">lib/phusion_passenger/abstract_server.rb</a>
61
+ </td>
62
+ </tr>
63
+ <tr>
64
+ <td>Parent:</td>
65
+ <td>
66
+ Object
67
+ </td>
68
+ </tr>
69
+ </table>
70
+ </td>
71
+ </tr>
72
+ </table>
73
+ <!-- banner header -->
74
+
75
+ <div id="bodyContent">
76
+ <div id="content">
77
+
78
+ <div class="description"><p>
79
+ An abstract base class for a server that has the following properties:
80
+ </p>
81
+ <ul>
82
+ <li>The server listens on a password protected Unix socket.
83
+
84
+ </li>
85
+ <li>The server is multithreaded and handles one client per thread.
86
+
87
+ </li>
88
+ <li>The server is owned by one or more processes. If all processes close their
89
+ reference to the server, then the server will quit.
90
+
91
+ </li>
92
+ <li>The server&#8216;s main loop may be run in a child process (and so is
93
+ asynchronous from the parent process).
94
+
95
+ </li>
96
+ <li>One can communicate with the server through discrete <a
97
+ href="MessageChannel.html">MessageChannel</a> messages, as opposed to byte
98
+ streams.
99
+
100
+ </li>
101
+ <li>The server can pass file descriptors (<a href="../IO.html">IO</a> objects)
102
+ back to the client.
103
+
104
+ </li>
105
+ </ul>
106
+ <p>
107
+ The server will also reset all signal handlers. That is, it will respond to
108
+ all signals in the default manner. The only exception is SIGHUP, which is
109
+ ignored. One may define additional signal handlers using <a
110
+ href="AbstractServer.html#M000344">define_signal_handler</a>().
111
+ </p>
112
+ <p>
113
+ Before an <a href="AbstractServer.html">AbstractServer</a> can be used, it
114
+ must first be started by calling <a
115
+ href="AbstractServer.html#M000334">start</a>(). When it is no longer
116
+ needed, <a href="AbstractServer.html#M000336">stop</a>() should be called.
117
+ </p>
118
+ <p>
119
+ Here&#8216;s an example on using <a
120
+ href="AbstractServer.html">AbstractServer</a>:
121
+ </p>
122
+ <pre>
123
+ class MyServer &lt; PhusionPassenger::AbstractServer
124
+ def initialize
125
+ super()
126
+ define_message_handler(:hello, :handle_hello)
127
+ end
128
+
129
+ def hello(first_name, last_name)
130
+ connect do |channel|
131
+ channel.write('hello', first_name, last_name)
132
+ reply, pointless_number = channel.read
133
+ puts &quot;The server said: #{reply}&quot;
134
+ puts &quot;In addition, it sent this pointless number: #{pointless_number}&quot;
135
+ end
136
+ end
137
+
138
+ private
139
+ def handle_hello(channel, first_name, last_name)
140
+ channel.write(&quot;Hello #{first_name} #{last_name}, how are you?&quot;, 1234)
141
+ end
142
+ end
143
+
144
+ server = MyServer.new
145
+ server.start
146
+ server.hello(&quot;Joe&quot;, &quot;Dalton&quot;)
147
+ server.stop
148
+ </pre>
149
+ </div>
150
+
151
+
152
+
153
+ <div class="sectiontitle">Methods</div>
154
+ <ul>
155
+ <li><a href="#M000340">before_fork</a></li>
156
+ <li><a href="#M000339">connect</a></li>
157
+ <li><a href="#M000343">define_message_handler</a></li>
158
+ <li><a href="#M000344">define_signal_handler</a></li>
159
+ <li><a href="#M000345">fileno_of</a></li>
160
+ <li><a href="#M000342">finalize_server</a></li>
161
+ <li><a href="#M000341">initialize_server</a></li>
162
+ <li><a href="#M000333">new</a></li>
163
+ <li><a href="#M000338">server_pid</a></li>
164
+ <li><a href="#M000334">start</a></li>
165
+ <li><a href="#M000335">start_synchronously</a></li>
166
+ <li><a href="#M000337">started?</a></li>
167
+ <li><a href="#M000336">stop</a></li>
168
+ </ul>
169
+
170
+ <div class="sectiontitle">Included Modules</div>
171
+ <ul>
172
+ <li><a href="Utils.html">Utils</a></li>
173
+ </ul>
174
+
175
+
176
+ <div class="sectiontitle">Classes and Modules</div>
177
+ Class <a href="AbstractServer/InvalidPassword.html" class="link">PhusionPassenger::AbstractServer::InvalidPassword</a><br />
178
+ Class <a href="AbstractServer/ServerAlreadyStarted.html" class="link">PhusionPassenger::AbstractServer::ServerAlreadyStarted</a><br />
179
+ Class <a href="AbstractServer/ServerError.html" class="link">PhusionPassenger::AbstractServer::ServerError</a><br />
180
+ Class <a href="AbstractServer/ServerNotStarted.html" class="link">PhusionPassenger::AbstractServer::ServerNotStarted</a><br />
181
+ Class <a href="AbstractServer/UnknownMessage.html" class="link">PhusionPassenger::AbstractServer::UnknownMessage</a><br />
182
+
183
+
184
+
185
+ <div class="sectiontitle">Attributes</div>
186
+ <table border='0' cellpadding='5'>
187
+ <tr valign='top'>
188
+ <td class='attr-rw'>
189
+ [RW]
190
+ </td>
191
+ <td class='attr-name'>ignore_password_errors</td>
192
+ <td class='attr-desc'></td>
193
+ </tr>
194
+ <tr valign='top'>
195
+ <td class='attr-rw'>
196
+ [RW]
197
+ </td>
198
+ <td class='attr-name'>max_idle_time</td>
199
+ <td class='attr-desc'>
200
+ The maximum time that this <a href="AbstractServer.html">AbstractServer</a>
201
+ may be idle. Used by <a
202
+ href="AbstractServerCollection.html">AbstractServerCollection</a> to
203
+ determine when this object should be cleaned up. nil or 0 indicate that
204
+ this object should never be idle cleaned.
205
+
206
+ </td>
207
+ </tr>
208
+ <tr valign='top'>
209
+ <td class='attr-rw'>
210
+ [RW]
211
+ </td>
212
+ <td class='attr-name'>next_cleaning_time</td>
213
+ <td class='attr-desc'>
214
+ Used by <a
215
+ href="AbstractServerCollection.html">AbstractServerCollection</a> to
216
+ remember when this <a href="AbstractServer.html">AbstractServer</a> should
217
+ be idle cleaned.
218
+
219
+ </td>
220
+ </tr>
221
+ <tr valign='top'>
222
+ <td class='attr-rw'>
223
+ [R]
224
+ </td>
225
+ <td class='attr-name'>password</td>
226
+ <td class='attr-desc'></td>
227
+ </tr>
228
+ </table>
229
+
230
+ <div class="sectiontitle">Public Class methods</div>
231
+ <div class="method">
232
+ <div class="title">
233
+ <a name="M000333"></a><b>new</b>(socket_filename = nil, password = nil)
234
+ </div>
235
+ <div class="sourcecode">
236
+ <p class="source-link">[ <a href="javascript:toggleSource('M000333_source')" id="l_M000333_source">show source</a> ]</p>
237
+ <div id="M000333_source" class="dyn-source">
238
+ <pre>
239
+ <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 116</span>
240
+ 116: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">socket_filename</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">password</span> = <span class="ruby-keyword kw">nil</span>)
241
+ 117: <span class="ruby-ivar">@socket_filename</span> = <span class="ruby-identifier">socket_filename</span>
242
+ 118: <span class="ruby-ivar">@password</span> = <span class="ruby-identifier">password</span>
243
+ 119: <span class="ruby-ivar">@socket_filename</span> <span class="ruby-operator">||=</span> <span class="ruby-node">&quot;#{passenger_tmpdir}/spawn-server/socket.#{Process.pid}.#{object_id}&quot;</span>
244
+ 120: <span class="ruby-ivar">@password</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">generate_random_id</span>(<span class="ruby-identifier">:base64</span>)
245
+ 121:
246
+ 122: <span class="ruby-ivar">@message_handlers</span> = {}
247
+ 123: <span class="ruby-ivar">@signal_handlers</span> = {}
248
+ 124: <span class="ruby-ivar">@orig_signal_handlers</span> = {}
249
+ 125: <span class="ruby-keyword kw">end</span>
250
+ </pre>
251
+ </div>
252
+ </div>
253
+ </div>
254
+ <div class="sectiontitle">Public Instance methods</div>
255
+ <div class="method">
256
+ <div class="title">
257
+ <a name="M000339"></a><b>connect</b>() {|channel| ...}
258
+ </div>
259
+ <div class="description">
260
+ <p>
261
+ Connects to the server and yields a channel for communication. The first
262
+ message&#8216;s name must match a handler name. The connection can only be
263
+ used for a single handler cycle; after the handler is done, the connection
264
+ will be closed.
265
+ </p>
266
+ <pre>
267
+ server.connect do |channel|
268
+ channel.write(&quot;a message&quot;)
269
+ ...
270
+ end
271
+ </pre>
272
+ <p>
273
+ Raises: SystemCallError, IOError, SocketError
274
+ </p>
275
+ </div>
276
+ <div class="sourcecode">
277
+ <p class="source-link">[ <a href="javascript:toggleSource('M000339_source')" id="l_M000339_source">show source</a> ]</p>
278
+ <div id="M000339_source" class="dyn-source">
279
+ <pre>
280
+ <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 267</span>
281
+ 267: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">connect</span>
282
+ 268: <span class="ruby-identifier">channel</span> = <span class="ruby-constant">MessageChannel</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">UNIXSocket</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@socket_filename</span>))
283
+ 269: <span class="ruby-keyword kw">begin</span>
284
+ 270: <span class="ruby-identifier">channel</span>.<span class="ruby-identifier">write_scalar</span>(<span class="ruby-ivar">@password</span>)
285
+ 271: <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">channel</span>
286
+ 272: <span class="ruby-keyword kw">ensure</span>
287
+ 273: <span class="ruby-identifier">channel</span>.<span class="ruby-identifier">close</span>
288
+ 274: <span class="ruby-keyword kw">end</span>
289
+ 275: <span class="ruby-keyword kw">end</span>
290
+ </pre>
291
+ </div>
292
+ </div>
293
+ </div>
294
+ <div class="method">
295
+ <div class="title">
296
+ <a name="M000338"></a><b>server_pid</b>()
297
+ </div>
298
+ <div class="description">
299
+ <p>
300
+ Return the PID of the started server. This is only valid if <a
301
+ href="AbstractServer.html#M000334">#start</a> has been called.
302
+ </p>
303
+ </div>
304
+ <div class="sourcecode">
305
+ <p class="source-link">[ <a href="javascript:toggleSource('M000338_source')" id="l_M000338_source">show source</a> ]</p>
306
+ <div id="M000338_source" class="dyn-source">
307
+ <pre>
308
+ <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 252</span>
309
+ 252: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">server_pid</span>
310
+ 253: <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@pid</span>
311
+ 254: <span class="ruby-keyword kw">end</span>
312
+ </pre>
313
+ </div>
314
+ </div>
315
+ </div>
316
+ <div class="method">
317
+ <div class="title">
318
+ <a name="M000334"></a><b>start</b>()
319
+ </div>
320
+ <div class="description">
321
+ <p>
322
+ Start the server. This method does not block since the server runs
323
+ asynchronously from the current process.
324
+ </p>
325
+ <p>
326
+ You may only call this method if the server is not already started.
327
+ Otherwise, a <a
328
+ href="AbstractServer/ServerAlreadyStarted.html">ServerAlreadyStarted</a>
329
+ will be raised.
330
+ </p>
331
+ <p>
332
+ Derived classes may raise additional exceptions.
333
+ </p>
334
+ </div>
335
+ <div class="sourcecode">
336
+ <p class="source-link">[ <a href="javascript:toggleSource('M000334_source')" id="l_M000334_source">show source</a> ]</p>
337
+ <div id="M000334_source" class="dyn-source">
338
+ <pre>
339
+ <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 134</span>
340
+ 134: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start</span>
341
+ 135: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">started?</span>
342
+ 136: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ServerAlreadyStarted</span>, <span class="ruby-value str">&quot;Server is already started&quot;</span>
343
+ 137: <span class="ruby-keyword kw">end</span>
344
+ 138:
345
+ 139: <span class="ruby-identifier">a</span>, <span class="ruby-identifier">b</span> = <span class="ruby-constant">UNIXSocket</span>.<span class="ruby-identifier">pair</span>
346
+ 140: <span class="ruby-constant">File</span>.<span class="ruby-identifier">unlink</span>(<span class="ruby-ivar">@socket_filename</span>) <span class="ruby-keyword kw">rescue</span> <span class="ruby-keyword kw">nil</span>
347
+ 141: <span class="ruby-identifier">server_socket</span> = <span class="ruby-constant">UNIXServer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@socket_filename</span>)
348
+ 142: <span class="ruby-constant">File</span>.<span class="ruby-identifier">chmod</span>(<span class="ruby-value">0700</span>, <span class="ruby-ivar">@socket_filename</span>)
349
+ 143:
350
+ 144: <span class="ruby-identifier">before_fork</span>
351
+ 145: <span class="ruby-ivar">@pid</span> = <span class="ruby-identifier">fork</span>
352
+ 146: <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@pid</span>.<span class="ruby-identifier">nil?</span>
353
+ 147: <span class="ruby-identifier">has_exception</span> = <span class="ruby-keyword kw">false</span>
354
+ 148: <span class="ruby-keyword kw">begin</span>
355
+ 149: <span class="ruby-constant">STDOUT</span>.<span class="ruby-identifier">sync</span> = <span class="ruby-keyword kw">true</span>
356
+ 150: <span class="ruby-constant">STDERR</span>.<span class="ruby-identifier">sync</span> = <span class="ruby-keyword kw">true</span>
357
+ 151: <span class="ruby-identifier">a</span>.<span class="ruby-identifier">close</span>
358
+ 152:
359
+ 153: <span class="ruby-comment cmt"># During Passenger's early days, we used to close file descriptors based</span>
360
+ 154: <span class="ruby-comment cmt"># on a white list of file descriptors. That proved to be way too fragile:</span>
361
+ 155: <span class="ruby-comment cmt"># too many file descriptors are being left open even though they shouldn't</span>
362
+ 156: <span class="ruby-comment cmt"># be. So now we close file descriptors based on a black list.</span>
363
+ 157: <span class="ruby-comment cmt">#</span>
364
+ 158: <span class="ruby-comment cmt"># Note that STDIN, STDOUT and STDERR may be temporarily set to</span>
365
+ 159: <span class="ruby-comment cmt"># different file descriptors than 0, 1 and 2, e.g. in unit tests.</span>
366
+ 160: <span class="ruby-comment cmt"># We don't want to close these either.</span>
367
+ 161: <span class="ruby-identifier">file_descriptors_to_leave_open</span> = [<span class="ruby-value">0</span>, <span class="ruby-value">1</span>, <span class="ruby-value">2</span>,
368
+ 162: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">fileno</span>, <span class="ruby-identifier">server_socket</span>.<span class="ruby-identifier">fileno</span>,
369
+ 163: <span class="ruby-identifier">fileno_of</span>(<span class="ruby-constant">STDIN</span>), <span class="ruby-identifier">fileno_of</span>(<span class="ruby-constant">STDOUT</span>), <span class="ruby-identifier">fileno_of</span>(<span class="ruby-constant">STDERR</span>)
370
+ 164: ].<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">uniq</span>
371
+ 165: <span class="ruby-constant">NativeSupport</span>.<span class="ruby-identifier">close_all_file_descriptors</span>(<span class="ruby-identifier">file_descriptors_to_leave_open</span>)
372
+ 166: <span class="ruby-comment cmt"># In addition to closing the file descriptors, one must also close</span>
373
+ 167: <span class="ruby-comment cmt"># the associated IO objects. This is to prevent IO.close from</span>
374
+ 168: <span class="ruby-comment cmt"># double-closing already closed file descriptors.</span>
375
+ 169: <span class="ruby-identifier">close_all_io_objects_for_fds</span>(<span class="ruby-identifier">file_descriptors_to_leave_open</span>)
376
+ 170:
377
+ 171: <span class="ruby-comment cmt"># At this point, RubyGems might have open file handles for which</span>
378
+ 172: <span class="ruby-comment cmt"># the associated file descriptors have just been closed. This can</span>
379
+ 173: <span class="ruby-comment cmt"># result in mysterious 'EBADFD' errors. So we force RubyGems to</span>
380
+ 174: <span class="ruby-comment cmt"># clear all open file handles.</span>
381
+ 175: <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">clear_paths</span>
382
+ 176:
383
+ 177: <span class="ruby-comment cmt"># Reseed pseudo-random number generator for security reasons.</span>
384
+ 178: <span class="ruby-identifier">srand</span>
385
+ 179:
386
+ 180: <span class="ruby-identifier">start_synchronously</span>(<span class="ruby-ivar">@socket_filename</span>, <span class="ruby-ivar">@password</span>, <span class="ruby-identifier">server_socket</span>, <span class="ruby-identifier">b</span>)
387
+ 181: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Interrupt</span>
388
+ 182: <span class="ruby-comment cmt"># Do nothing.</span>
389
+ 183: <span class="ruby-identifier">has_exception</span> = <span class="ruby-keyword kw">true</span>
390
+ 184: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
391
+ 185: <span class="ruby-identifier">has_exception</span> = <span class="ruby-keyword kw">true</span>
392
+ 186: <span class="ruby-identifier">print_exception</span>(<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-identifier">e</span>)
393
+ 187: <span class="ruby-keyword kw">ensure</span>
394
+ 188: <span class="ruby-identifier">exit!</span>(<span class="ruby-identifier">has_exception</span> <span class="ruby-value">? </span><span class="ruby-value">1</span> <span class="ruby-operator">:</span> <span class="ruby-value">0</span>)
395
+ 189: <span class="ruby-keyword kw">end</span>
396
+ 190: <span class="ruby-keyword kw">end</span>
397
+ 191: <span class="ruby-identifier">server_socket</span>.<span class="ruby-identifier">close</span>
398
+ 192: <span class="ruby-identifier">b</span>.<span class="ruby-identifier">close</span>
399
+ 193: <span class="ruby-ivar">@owner_socket</span> = <span class="ruby-identifier">a</span>
400
+ 194: <span class="ruby-keyword kw">end</span>
401
+ </pre>
402
+ </div>
403
+ </div>
404
+ </div>
405
+ <div class="method">
406
+ <div class="title">
407
+ <a name="M000335"></a><b>start_synchronously</b>(socket_filename, password, server_socket, owner_socket)
408
+ </div>
409
+ <div class="description">
410
+ <p>
411
+ Start the server, but in the current process instead of in a child process.
412
+ This method blocks until the server&#8216;s main loop has ended.
413
+ </p>
414
+ <p>
415
+ All hooks will be called, except <a
416
+ href="AbstractServer.html#M000340">before_fork</a>().
417
+ </p>
418
+ </div>
419
+ <div class="sourcecode">
420
+ <p class="source-link">[ <a href="javascript:toggleSource('M000335_source')" id="l_M000335_source">show source</a> ]</p>
421
+ <div id="M000335_source" class="dyn-source">
422
+ <pre>
423
+ <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 200</span>
424
+ 200: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">start_synchronously</span>(<span class="ruby-identifier">socket_filename</span>, <span class="ruby-identifier">password</span>, <span class="ruby-identifier">server_socket</span>, <span class="ruby-identifier">owner_socket</span>)
425
+ 201: <span class="ruby-ivar">@owner_socket</span> = <span class="ruby-identifier">owner_socket</span>
426
+ 202: <span class="ruby-keyword kw">begin</span>
427
+ 203: <span class="ruby-identifier">reset_signal_handlers</span>
428
+ 204: <span class="ruby-identifier">initialize_server</span>
429
+ 205: <span class="ruby-keyword kw">begin</span>
430
+ 206: <span class="ruby-identifier">server_main_loop</span>(<span class="ruby-identifier">password</span>, <span class="ruby-identifier">server_socket</span>)
431
+ 207: <span class="ruby-keyword kw">ensure</span>
432
+ 208: <span class="ruby-identifier">finalize_server</span>
433
+ 209: <span class="ruby-keyword kw">end</span>
434
+ 210: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Interrupt</span>
435
+ 211: <span class="ruby-comment cmt"># Do nothing</span>
436
+ 212: <span class="ruby-keyword kw">ensure</span>
437
+ 213: <span class="ruby-ivar">@owner_socket</span> = <span class="ruby-keyword kw">nil</span>
438
+ 214: <span class="ruby-identifier">revert_signal_handlers</span>
439
+ 215: <span class="ruby-constant">File</span>.<span class="ruby-identifier">unlink</span>(<span class="ruby-identifier">socket_filename</span>) <span class="ruby-keyword kw">rescue</span> <span class="ruby-keyword kw">nil</span>
440
+ 216: <span class="ruby-identifier">server_socket</span>.<span class="ruby-identifier">close</span>
441
+ 217: <span class="ruby-keyword kw">end</span>
442
+ 218: <span class="ruby-keyword kw">end</span>
443
+ </pre>
444
+ </div>
445
+ </div>
446
+ </div>
447
+ <div class="method">
448
+ <div class="title">
449
+ <a name="M000337"></a><b>started?</b>()
450
+ </div>
451
+ <div class="description">
452
+ <p>
453
+ Return whether the server has been started.
454
+ </p>
455
+ </div>
456
+ <div class="sourcecode">
457
+ <p class="source-link">[ <a href="javascript:toggleSource('M000337_source')" id="l_M000337_source">show source</a> ]</p>
458
+ <div id="M000337_source" class="dyn-source">
459
+ <pre>
460
+ <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 247</span>
461
+ 247: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">started?</span>
462
+ 248: <span class="ruby-keyword kw">return</span> <span class="ruby-operator">!</span><span class="ruby-operator">!</span><span class="ruby-ivar">@owner_socket</span>
463
+ 249: <span class="ruby-keyword kw">end</span>
464
+ </pre>
465
+ </div>
466
+ </div>
467
+ </div>
468
+ <div class="method">
469
+ <div class="title">
470
+ <a name="M000336"></a><b>stop</b>()
471
+ </div>
472
+ <div class="description">
473
+ <p>
474
+ Stop the server. The server will quit as soon as possible. This method
475
+ waits until the server has been stopped.
476
+ </p>
477
+ <p>
478
+ When calling this method, the server must already be started. If not, a <a
479
+ href="AbstractServer/ServerNotStarted.html">ServerNotStarted</a> will be
480
+ raised.
481
+ </p>
482
+ </div>
483
+ <div class="sourcecode">
484
+ <p class="source-link">[ <a href="javascript:toggleSource('M000336_source')" id="l_M000336_source">show source</a> ]</p>
485
+ <div id="M000336_source" class="dyn-source">
486
+ <pre>
487
+ <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 225</span>
488
+ 225: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stop</span>
489
+ 226: <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">started?</span>
490
+ 227: <span class="ruby-identifier">raise</span> <span class="ruby-constant">ServerNotStarted</span>, <span class="ruby-value str">&quot;Server is not started&quot;</span>
491
+ 228: <span class="ruby-keyword kw">end</span>
492
+ 229:
493
+ 230: <span class="ruby-keyword kw">begin</span>
494
+ 231: <span class="ruby-ivar">@owner_socket</span>.<span class="ruby-identifier">write</span>(<span class="ruby-value str">&quot;x&quot;</span>)
495
+ 232: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EPIPE</span>
496
+ 233: <span class="ruby-keyword kw">end</span>
497
+ 234: <span class="ruby-ivar">@owner_socket</span>.<span class="ruby-identifier">close</span>
498
+ 235: <span class="ruby-ivar">@owner_socket</span> = <span class="ruby-keyword kw">nil</span>
499
+ 236: <span class="ruby-constant">File</span>.<span class="ruby-identifier">unlink</span>(<span class="ruby-ivar">@socket_filename</span>) <span class="ruby-keyword kw">rescue</span> <span class="ruby-keyword kw">nil</span>
500
+ 237:
501
+ 238: <span class="ruby-comment cmt"># Wait at most 4 seconds for server to exit. If it doesn't do that,</span>
502
+ 239: <span class="ruby-comment cmt"># we kill it forcefully with SIGKILL.</span>
503
+ 240: <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-constant">Process</span>.<span class="ruby-identifier">timed_waitpid</span>(<span class="ruby-ivar">@pid</span>, <span class="ruby-value">4</span>)
504
+ 241: <span class="ruby-constant">Process</span>.<span class="ruby-identifier">kill</span>(<span class="ruby-value str">'SIGKILL'</span>, <span class="ruby-ivar">@pid</span>) <span class="ruby-keyword kw">rescue</span> <span class="ruby-keyword kw">nil</span>
505
+ 242: <span class="ruby-constant">Process</span>.<span class="ruby-identifier">timed_waitpid</span>(<span class="ruby-ivar">@pid</span>, <span class="ruby-value">1</span>)
506
+ 243: <span class="ruby-keyword kw">end</span>
507
+ 244: <span class="ruby-keyword kw">end</span>
508
+ </pre>
509
+ </div>
510
+ </div>
511
+ </div>
512
+ <div class="sectiontitle">Protected Instance methods</div>
513
+ <div class="method">
514
+ <div class="title">
515
+ <a name="M000340"></a><b>before_fork</b>()
516
+ </div>
517
+ <div class="description">
518
+ <p>
519
+ A hook which is called when the server is being started, just before
520
+ forking a <a href="AbstractServer.html#M000333">new</a> process. The
521
+ default implementation does nothing, this method is supposed to be
522
+ overrided by child classes.
523
+ </p>
524
+ </div>
525
+ <div class="sourcecode">
526
+ <p class="source-link">[ <a href="javascript:toggleSource('M000340_source')" id="l_M000340_source">show source</a> ]</p>
527
+ <div id="M000340_source" class="dyn-source">
528
+ <pre>
529
+ <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 280</span>
530
+ 280: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">before_fork</span>
531
+ 281: <span class="ruby-keyword kw">end</span>
532
+ </pre>
533
+ </div>
534
+ </div>
535
+ </div>
536
+ <div class="method">
537
+ <div class="title">
538
+ <a name="M000343"></a><b>define_message_handler</b>(message_name, handler)
539
+ </div>
540
+ <div class="description">
541
+ <p>
542
+ Define a handler for a message. <em>message_name</em> is the name of the
543
+ message to handle, and <em>handler</em> is the name of a method to be
544
+ called (this may either be a String or a Symbol).
545
+ </p>
546
+ <p>
547
+ A message is just a list of strings, and so <em>handler</em> will be called
548
+ with the message as its arguments, excluding the first element. See also
549
+ the example in the class description.
550
+ </p>
551
+ </div>
552
+ <div class="sourcecode">
553
+ <p class="source-link">[ <a href="javascript:toggleSource('M000343_source')" id="l_M000343_source">show source</a> ]</p>
554
+ <div id="M000343_source" class="dyn-source">
555
+ <pre>
556
+ <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 300</span>
557
+ 300: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">define_message_handler</span>(<span class="ruby-identifier">message_name</span>, <span class="ruby-identifier">handler</span>)
558
+ 301: <span class="ruby-ivar">@message_handlers</span>[<span class="ruby-identifier">message_name</span>.<span class="ruby-identifier">to_s</span>] = <span class="ruby-identifier">handler</span>
559
+ 302: <span class="ruby-keyword kw">end</span>
560
+ </pre>
561
+ </div>
562
+ </div>
563
+ </div>
564
+ <div class="method">
565
+ <div class="title">
566
+ <a name="M000344"></a><b>define_signal_handler</b>(signal, handler)
567
+ </div>
568
+ <div class="description">
569
+ <p>
570
+ Define a handler for a signal.
571
+ </p>
572
+ </div>
573
+ <div class="sourcecode">
574
+ <p class="source-link">[ <a href="javascript:toggleSource('M000344_source')" id="l_M000344_source">show source</a> ]</p>
575
+ <div id="M000344_source" class="dyn-source">
576
+ <pre>
577
+ <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 305</span>
578
+ 305: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">define_signal_handler</span>(<span class="ruby-identifier">signal</span>, <span class="ruby-identifier">handler</span>)
579
+ 306: <span class="ruby-ivar">@signal_handlers</span>[<span class="ruby-identifier">signal</span>.<span class="ruby-identifier">to_s</span>] = <span class="ruby-identifier">handler</span>
580
+ 307: <span class="ruby-keyword kw">end</span>
581
+ </pre>
582
+ </div>
583
+ </div>
584
+ </div>
585
+ <div class="method">
586
+ <div class="title">
587
+ <a name="M000345"></a><b>fileno_of</b>(io)
588
+ </div>
589
+ <div class="sourcecode">
590
+ <p class="source-link">[ <a href="javascript:toggleSource('M000345_source')" id="l_M000345_source">show source</a> ]</p>
591
+ <div id="M000345_source" class="dyn-source">
592
+ <pre>
593
+ <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 309</span>
594
+ 309: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fileno_of</span>(<span class="ruby-identifier">io</span>)
595
+ 310: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">io</span>.<span class="ruby-identifier">fileno</span>
596
+ 311: <span class="ruby-keyword kw">rescue</span>
597
+ 312: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span>
598
+ 313: <span class="ruby-keyword kw">end</span>
599
+ </pre>
600
+ </div>
601
+ </div>
602
+ </div>
603
+ <div class="method">
604
+ <div class="title">
605
+ <a name="M000342"></a><b>finalize_server</b>()
606
+ </div>
607
+ <div class="description">
608
+ <p>
609
+ A hook which is called when the server is being stopped. This is called in
610
+ the child process, after the main loop has been left. The default
611
+ implementation does nothing, this method is supposed to be overrided by
612
+ child classes.
613
+ </p>
614
+ </div>
615
+ <div class="sourcecode">
616
+ <p class="source-link">[ <a href="javascript:toggleSource('M000342_source')" id="l_M000342_source">show source</a> ]</p>
617
+ <div id="M000342_source" class="dyn-source">
618
+ <pre>
619
+ <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 292</span>
620
+ 292: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">finalize_server</span>
621
+ 293: <span class="ruby-keyword kw">end</span>
622
+ </pre>
623
+ </div>
624
+ </div>
625
+ </div>
626
+ <div class="method">
627
+ <div class="title">
628
+ <a name="M000341"></a><b>initialize_server</b>()
629
+ </div>
630
+ <div class="description">
631
+ <p>
632
+ A hook which is called when the server is being started. This is called in
633
+ the child process, before the main loop is entered. The default
634
+ implementation does nothing, this method is supposed to be overrided by
635
+ child classes.
636
+ </p>
637
+ </div>
638
+ <div class="sourcecode">
639
+ <p class="source-link">[ <a href="javascript:toggleSource('M000341_source')" id="l_M000341_source">show source</a> ]</p>
640
+ <div id="M000341_source" class="dyn-source">
641
+ <pre>
642
+ <span class="ruby-comment cmt"># File lib/phusion_passenger/abstract_server.rb, line 286</span>
643
+ 286: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize_server</span>
644
+ 287: <span class="ruby-keyword kw">end</span>
645
+ </pre>
646
+ </div>
647
+ </div>
648
+ </div>
649
+ </div>
650
+
651
+ </div>
652
+
653
+ </body>
654
+ </html>