doc/cxxapi/classPassenger_1_1FileNotFoundException-members.html doc/cxxapi/classPassenger_1_1FileNotFoundException.html doc/cxxapi/classPassenger_1_1FileNotFoundException__inherit__graph.map doc/cxxapi/classPassenger_1_1FileNotFoundException__inherit__graph.md5 doc/cxxapi/classPassenger_1_1FileNotFoundException__inherit__graph.png doc/cxxapi/classPassenger_1_1IOException__inherit__graph.map doc/cxxapi/classPassenger_1_1IOException__inherit__graph.md5 doc/cxxapi/classPassenger_1_1IOException__inherit__graph.png doc/cxxapi/classPassenger_1_1SpawnException-members.html doc/cxxapi/classPassenger_1_1SpawnException.html doc/rdoc/classes/ConditionVariable.html doc/rdoc/classes/GC.html doc/rdoc/classes/ModRails/AbstractServer.html doc/rdoc/classes/ModRails/AbstractServer/ServerAlreadyStarted.html doc/rdoc/classes/ModRails/AbstractServer/ServerNotStarted.html doc/rdoc/classes/ModRails/AbstractServer/UnknownMessage.html doc/rdoc/classes/ModRails/Application.html doc/rdoc/classes/ModRails/ApplicationSpawner.html doc/rdoc/classes/ModRails/ApplicationSpawner/SpawnError.html doc/rdoc/classes/ModRails/ApplicationSpawner/UserChangeError.html doc/rdoc/classes/ModRails/CGIFixed.html doc/rdoc/classes/ModRails/FrameworkSpawner.html doc/rdoc/classes/ModRails/MessageChannel.html doc/rdoc/classes/ModRails/RequestHandler.html doc/rdoc/classes/ModRails/RequestHandler/ResponseSender.html doc/rdoc/classes/ModRails/SpawnManager.html doc/rdoc/classes/ModRails/Utils.html doc/rdoc/classes/RakeExtensions.html doc/rdoc/created.rid doc/rdoc/files/lib/mod_rails/abstract_server_rb.html doc/rdoc/files/lib/mod_rails/application_rb.html doc/rdoc/files/lib/mod_rails/application_spawner_rb.html doc/rdoc/files/lib/mod_rails/cgi_fixed_rb.html doc/rdoc/files/lib/mod_rails/framework_spawner_rb.html doc/rdoc/files/lib/mod_rails/message_channel_rb.html doc/rdoc/files/lib/mod_rails/request_handler_rb.html doc/rdoc/files/lib/mod_rails/simple_benchmarking_rb.html doc/rdoc/files/lib/mod_rails/spawn_manager_rb.html doc/rdoc/files/lib/mod_rails/utils_rb.html doc/rdoc/files/lib/rake/extensions_rb.html doc/rdoc/fr_class_index.html doc/rdoc/fr_file_index.html doc/rdoc/fr_method_index.html doc/rdoc/index.html doc/rdoc/rdoc-style.css @@ -14,6 +14,4 @@ test/Apache2ModuleTests test/stub/railsapp/log/* test/stub/railsapp2/log/* benchmark/DummyRequestHandler -doc/rdoc -doc/c++api pkg .gitignore @@ -77,368 +77,472 @@ <a name="l00062"></a>00062 * <a name="l00063"></a>00063 * @warning <a name="l00064"></a>00064 * ApplicationPoolServer uses threads internally. Threads will disappear after a fork(), -<a name="l00065"></a>00065 * so ApplicationPoolServer will become usable after a fork(). So in case of Apache with -<a name="l00066"></a>00066 * the prefork MPM, be sure to create an ApplicationPoolServer() after Apache -<a name="l00067"></a>00067 * has daemonized. -<a name="l00068"></a>00068 * -<a name="l00069"></a>00069 * <h2>Implementation notes</h2> -<a name="l00070"></a>00070 * Notice that ApplicationPoolServer does do not use TCP sockets at all, or even named Unix -<a name="l00071"></a>00071 * sockets, depite being a server that can handle multiple clients! So ApplicationPoolServer -<a name="l00072"></a>00072 * will expose no open ports or temporary Unix socket files. Only child processes are able -<a name="l00073"></a>00073 * to use the ApplicationPoolServer. -<a name="l00074"></a>00074 * -<a name="l00075"></a>00075 * This is implemented through anonymous Unix sockets (<tt>socketpair()</tt>) and file descriptor -<a name="l00076"></a>00076 * passing. It allows one to emulate <tt>accept()</tt>. During initialization, -<a name="l00077"></a>00077 * ApplicationPoolServer creates a pair of Unix sockets, one called <tt>serverSocket</tt> -<a name="l00078"></a>00078 * and the other called <tt>connectSocket</tt>. There is a thread which continuously -<a name="l00079"></a>00079 * listens on serverSocket for incoming data. The data itself is not important, because it -<a name="l00080"></a>00080 * only serves to wake up the thread. ApplicationPoolServer::connect() sends some data through -<a name="l00081"></a>00081 * connectSocket, which wakes up the server thread. The server thread will then create -<a name="l00082"></a>00082 * a pair of Unix sockets. One of them is passed through serverSocket. The other will be -<a name="l00083"></a>00083 * handled by a newly created client thread. So the socket that was passed through serverSocket -<a name="l00084"></a>00084 * is the client's connection to the server, while the other socket is the server's connection -<a name="l00085"></a>00085 * to the client. -<a name="l00086"></a>00086 * -<a name="l00087"></a>00087 * Note that serverSocket and connectSocket are solely used for setting up new connections -<a name="l00088"></a>00088 * ala accept(). They are not used for any actual data. In fact, they cannot be used in any -<a name="l00089"></a>00089 * other way without some sort of synchronization mechanism, because all child processes -<a name="l00090"></a>00090 * are connected to the same serverSocket. In contrast, ApplicationPool::connect() sets up -<a name="l00091"></a>00091 * a private communicate channel between the server and the current child process. -<a name="l00092"></a>00092 * -<a name="l00093"></a>00093 * Also note that each client is handled by a seperate thread. This is necessary because -<a name="l00094"></a>00094 * ApplicationPoolServer internally uses StandardApplicationPool, and the current algorithm -<a name="l00095"></a>00095 * for StandardApplicationPool::get() can block (in the case that the spawning limit has -<a name="l00096"></a>00096 * been exceeded). While it is possible to get around this problem without using threads, -<a name="l00097"></a>00097 * a thread-based implementation is easier to write. -<a name="l00098"></a>00098 * -<a name="l00099"></a>00099 * @ingroup Support -<a name="l00100"></a>00100 */ -<a name="l00101"></a><a class="code" href="classPassenger_1_1ApplicationPoolServer.html">00101</a> class <a class="code" href="classPassenger_1_1ApplicationPoolServer.html" title="Multi-process usage support for ApplicationPool.">ApplicationPoolServer</a> { -<a name="l00102"></a>00102 private: -<a name="l00103"></a>00103 /** -<a name="l00104"></a>00104 * Contains data shared between RemoteSession and Client. -<a name="l00105"></a>00105 * Since RemoteSession and Client have different life times, i.e. one may be -<a name="l00106"></a>00106 * destroyed before the other, they both use a smart pointer that points to -<a name="l00107"></a>00107 * a SharedData. This way, the SharedData object is only destroyed when -<a name="l00108"></a>00108 * both the RemoteSession and the Client object has been destroyed. -<a name="l00109"></a>00109 */ -<a name="l00110"></a>00110 struct SharedData { -<a name="l00111"></a>00111 /** -<a name="l00112"></a>00112 * The socket connection to the server, as was established by -<a name="l00113"></a>00113 * ApplicationPoolServer::connect(). -<a name="l00114"></a>00114 */ -<a name="l00115"></a>00115 int server; -<a name="l00116"></a>00116 -<a name="l00117"></a>00117 ~SharedData() { -<a name="l00118"></a>00118 close(server); -<a name="l00119"></a>00119 } -<a name="l00120"></a>00120 }; -<a name="l00121"></a>00121 -<a name="l00122"></a>00122 typedef shared_ptr<SharedData> SharedDataPtr; -<a name="l00123"></a>00123 -<a name="l00124"></a>00124 /** -<a name="l00125"></a>00125 * An Application::Session which works together with ApplicationPoolServer. -<a name="l00126"></a>00126 * -<a name="l00127"></a>00127 */ -<a name="l00128"></a>00128 class RemoteSession: public <a class="code" href="classPassenger_1_1Application.html" title="Represents a single Ruby on Rails application instance.">Application</a>::Session { -<a name="l00129"></a>00129 private: -<a name="l00130"></a>00130 SharedDataPtr data; -<a name="l00131"></a>00131 int id; -<a name="l00132"></a>00132 int reader; -<a name="l00133"></a>00133 int writer; -<a name="l00134"></a>00134 public: -<a name="l00135"></a>00135 RemoteSession(SharedDataPtr data, int id, int reader, int writer) { -<a name="l00136"></a>00136 this->data = data; -<a name="l00137"></a>00137 this->id = id; -<a name="l00138"></a>00138 this->reader = reader; -<a name="l00139"></a>00139 this->writer = writer; -<a name="l00140"></a>00140 } -<a name="l00141"></a>00141 -<a name="l00142"></a>00142 virtual ~RemoteSession() { -<a name="l00143"></a>00143 closeReader(); -<a name="l00144"></a>00144 closeWriter(); -<a name="l00145"></a>00145 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(data->server).write("close", toString(id).c_str(), NULL); -<a name="l00146"></a>00146 } -<a name="l00147"></a>00147 -<a name="l00148"></a>00148 virtual int getReader() { -<a name="l00149"></a>00149 return reader; +<a name="l00065"></a>00065 * so ApplicationPoolServer will become usable as a server after a fork(). After a fork(), +<a name="l00066"></a>00066 * you can still call connect() (and, of course, detach()), but the same +<a name="l00067"></a>00067 * ApplicationPoolServer better still be running in the parent process. So in case of +<a name="l00068"></a>00068 * Apache with the prefork MPM, be sure to create an ApplicationPoolServer +<a name="l00069"></a>00069 * after Apache has daemonized. +<a name="l00070"></a>00070 * +<a name="l00071"></a>00071 * <h2>Implementation notes</h2> +<a name="l00072"></a>00072 * Notice that ApplicationPoolServer does do not use TCP sockets at all, or even named Unix +<a name="l00073"></a>00073 * sockets, depite being a server that can handle multiple clients! So ApplicationPoolServer +<a name="l00074"></a>00074 * will expose no open ports or temporary Unix socket files. Only child processes are able +<a name="l00075"></a>00075 * to use the ApplicationPoolServer. +<a name="l00076"></a>00076 * +<a name="l00077"></a>00077 * This is implemented through anonymous Unix sockets (<tt>socketpair()</tt>) and file descriptor +<a name="l00078"></a>00078 * passing. It allows one to emulate <tt>accept()</tt>. During initialization, +<a name="l00079"></a>00079 * ApplicationPoolServer creates a pair of Unix sockets, one called <tt>serverSocket</tt> +<a name="l00080"></a>00080 * and the other called <tt>connectSocket</tt>. There is a thread which continuously +<a name="l00081"></a>00081 * listens on serverSocket for incoming data. The data itself is not important, because it +<a name="l00082"></a>00082 * only serves to wake up the thread. ApplicationPoolServer::connect() sends some data through +<a name="l00083"></a>00083 * connectSocket, which wakes up the server thread. The server thread will then create +<a name="l00084"></a>00084 * a pair of Unix sockets. One of them is passed through serverSocket. The other will be +<a name="l00085"></a>00085 * handled by a newly created client thread. So the socket that was passed through serverSocket +<a name="l00086"></a>00086 * is the client's connection to the server, while the other socket is the server's connection +<a name="l00087"></a>00087 * to the client. +<a name="l00088"></a>00088 * +<a name="l00089"></a>00089 * Note that serverSocket and connectSocket are solely used for setting up new connections +<a name="l00090"></a>00090 * ala accept(). They are not used for any actual data. In fact, they cannot be used in any +<a name="l00091"></a>00091 * other way without some sort of inter-process synchronization mechanism, because all +<a name="l00092"></a>00092 * child processes are connected to the same serverSocket. In contrast, +<a name="l00093"></a>00093 * ApplicationPoolServer::connect() allows one to setup a private communicate channel between +<a name="l00094"></a>00094 * the server and the current child process. +<a name="l00095"></a>00095 * +<a name="l00096"></a>00096 * Also note that each client is handled by a seperate thread. This is necessary because +<a name="l00097"></a>00097 * ApplicationPoolServer internally uses StandardApplicationPool, and the current algorithm +<a name="l00098"></a>00098 * for StandardApplicationPool::get() can block (in the case that the spawning limit has +<a name="l00099"></a>00099 * been exceeded). While it is possible to get around this problem without using threads, +<a name="l00100"></a>00100 * a thread-based implementation is easier to write. +<a name="l00101"></a>00101 * +<a name="l00102"></a>00102 * @ingroup Support +<a name="l00103"></a>00103 */ +<a name="l00104"></a><a class="code" href="classPassenger_1_1ApplicationPoolServer.html">00104</a> class <a class="code" href="classPassenger_1_1ApplicationPoolServer.html" title="Multi-process usage support for ApplicationPool.">ApplicationPoolServer</a> { +<a name="l00105"></a>00105 private: +<a name="l00106"></a>00106 /** +<a name="l00107"></a>00107 * Contains data shared between RemoteSession and Client. +<a name="l00108"></a>00108 * Since RemoteSession and Client have different life times, i.e. one may be +<a name="l00109"></a>00109 * destroyed before the other, they both use a smart pointer that points to +<a name="l00110"></a>00110 * a SharedData. This way, the SharedData object is only destroyed when +<a name="l00111"></a>00111 * both the RemoteSession and the Client object has been destroyed. +<a name="l00112"></a>00112 */ +<a name="l00113"></a>00113 struct SharedData { +<a name="l00114"></a>00114 /** +<a name="l00115"></a>00115 * The socket connection to the server, as was established by +<a name="l00116"></a>00116 * ApplicationPoolServer::connect(). +<a name="l00117"></a>00117 */ +<a name="l00118"></a>00118 int server; +<a name="l00119"></a>00119 +<a name="l00120"></a>00120 ~SharedData() { +<a name="l00121"></a>00121 close(server); +<a name="l00122"></a>00122 } +<a name="l00123"></a>00123 }; +<a name="l00124"></a>00124 +<a name="l00125"></a>00125 typedef shared_ptr<SharedData> SharedDataPtr; +<a name="l00126"></a>00126 +<a name="l00127"></a>00127 /** +<a name="l00128"></a>00128 * An Application::Session which works together with ApplicationPoolServer. +<a name="l00129"></a>00129 */ +<a name="l00130"></a>00130 class RemoteSession: public <a class="code" href="classPassenger_1_1Application.html" title="Represents a single Ruby on Rails application instance.">Application</a>::Session { +<a name="l00131"></a>00131 private: +<a name="l00132"></a>00132 SharedDataPtr data; +<a name="l00133"></a>00133 int id; +<a name="l00134"></a>00134 int reader; +<a name="l00135"></a>00135 int writer; +<a name="l00136"></a>00136 pid_t pid; +<a name="l00137"></a>00137 public: +<a name="l00138"></a>00138 RemoteSession(SharedDataPtr data, pid_t pid, int id, int reader, int writer) { +<a name="l00139"></a>00139 this->data = data; +<a name="l00140"></a>00140 this->pid = pid; +<a name="l00141"></a>00141 this->id = id; +<a name="l00142"></a>00142 this->reader = reader; +<a name="l00143"></a>00143 this->writer = writer; +<a name="l00144"></a>00144 } +<a name="l00145"></a>00145 +<a name="l00146"></a>00146 virtual ~RemoteSession() { +<a name="l00147"></a>00147 closeReader(); +<a name="l00148"></a>00148 closeWriter(); +<a name="l00149"></a>00149 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(data->server).write("close", <a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(id).c_str(), NULL); <a name="l00150"></a>00150 } <a name="l00151"></a>00151 -<a name="l00152"></a>00152 virtual void closeReader() { -<a name="l00153"></a>00153 if (reader != -1) { -<a name="l00154"></a>00154 close(reader); -<a name="l00155"></a>00155 reader = -1; -<a name="l00156"></a>00156 } -<a name="l00157"></a>00157 } -<a name="l00158"></a>00158 -<a name="l00159"></a>00159 virtual int getWriter() { -<a name="l00160"></a>00160 return writer; +<a name="l00152"></a>00152 virtual int getReader() { +<a name="l00153"></a>00153 return reader; +<a name="l00154"></a>00154 } +<a name="l00155"></a>00155 +<a name="l00156"></a>00156 virtual void closeReader() { +<a name="l00157"></a>00157 if (reader != -1) { +<a name="l00158"></a>00158 close(reader); +<a name="l00159"></a>00159 reader = -1; +<a name="l00160"></a>00160 } <a name="l00161"></a>00161 } <a name="l00162"></a>00162 -<a name="l00163"></a>00163 virtual void closeWriter() { -<a name="l00164"></a>00164 if (writer != -1) { -<a name="l00165"></a>00165 close(writer); -<a name="l00166"></a>00166 writer = -1; -<a name="l00167"></a>00167 } -<a name="l00168"></a>00168 } -<a name="l00169"></a>00169 }; -<a name="l00170"></a>00170 -<a name="l00171"></a>00171 /** -<a name="l00172"></a>00172 * An ApplicationPool implementation that works together with ApplicationPoolServer. -<a name="l00173"></a>00173 * It doesn't do much by itself, its job is mostly to forward queries/commands to -<a name="l00174"></a>00174 * the server and returning the result. Most of the logic is in the server. -<a name="l00175"></a>00175 */ -<a name="l00176"></a>00176 class Client: public <a class="code" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a> { -<a name="l00177"></a>00177 private: -<a name="l00178"></a>00178 SharedDataPtr data; -<a name="l00179"></a>00179 -<a name="l00180"></a>00180 public: -<a name="l00181"></a>00181 /** -<a name="l00182"></a>00182 * Create a new Client. -<a name="l00183"></a>00183 * -<a name="l00184"></a>00184 * @param sock The newly established socket connection with the ApplicationPoolServer. -<a name="l00185"></a>00185 */ -<a name="l00186"></a>00186 Client(int sock) { -<a name="l00187"></a>00187 data = ptr(new SharedData()); -<a name="l00188"></a>00188 data->server = sock; -<a name="l00189"></a>00189 } -<a name="l00190"></a>00190 -<a name="l00191"></a>00191 virtual void setMax(unsigned int max) { -<a name="l00192"></a>00192 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> channel(data->server); -<a name="l00193"></a>00193 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>("setMax", toString(max).c_str(), NULL); -<a name="l00194"></a>00194 } -<a name="l00195"></a>00195 -<a name="l00196"></a>00196 virtual unsigned int getActive() const { -<a name="l00197"></a>00197 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> channel(data->server); -<a name="l00198"></a>00198 vector<string> args; -<a name="l00199"></a>00199 -<a name="l00200"></a>00200 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>("getActive", NULL); -<a name="l00201"></a>00201 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor.">read</a>(args); -<a name="l00202"></a>00202 return atoi(args[0].c_str()); -<a name="l00203"></a>00203 } -<a name="l00204"></a>00204 -<a name="l00205"></a>00205 virtual unsigned int getCount() const { -<a name="l00206"></a>00206 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> channel(data->server); -<a name="l00207"></a>00207 vector<string> args; -<a name="l00208"></a>00208 -<a name="l00209"></a>00209 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>("getCount", NULL); -<a name="l00210"></a>00210 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor.">read</a>(args); -<a name="l00211"></a>00211 return atoi(args[0].c_str()); -<a name="l00212"></a>00212 } -<a name="l00213"></a>00213 -<a name="l00214"></a>00214 virtual <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">Application::SessionPtr</a> get(const string &appRoot, const string &user = "", const string &group = "") { -<a name="l00215"></a>00215 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> channel(data->server); -<a name="l00216"></a>00216 vector<string> args; -<a name="l00217"></a>00217 int reader, writer; -<a name="l00218"></a>00218 -<a name="l00219"></a>00219 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>("get", appRoot.c_str(), user.c_str(), group.c_str(), NULL); -<a name="l00220"></a>00220 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor.">read</a>(args); -<a name="l00221"></a>00221 reader = channel.<a class="code" href="classPassenger_1_1MessageChannel.html#1561b7e4a0f4d39ea431f456e5655488" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>(); -<a name="l00222"></a>00222 writer = channel.<a class="code" href="classPassenger_1_1MessageChannel.html#1561b7e4a0f4d39ea431f456e5655488" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>(); -<a name="l00223"></a>00223 return ptr(new RemoteSession(data, atoi(args[0].c_str()), reader, writer)); -<a name="l00224"></a>00224 } -<a name="l00225"></a>00225 }; -<a name="l00226"></a>00226 -<a name="l00227"></a>00227 /** -<a name="l00228"></a>00228 * Contains information about exactly one client. -<a name="l00229"></a>00229 */ -<a name="l00230"></a>00230 struct ClientInfo { -<a name="l00231"></a>00231 /** The connection to the client. */ -<a name="l00232"></a>00232 int fd; -<a name="l00233"></a>00233 /** The thread which handles the client. */ -<a name="l00234"></a>00234 thread *thr; -<a name="l00235"></a>00235 -<a name="l00236"></a>00236 ~ClientInfo() { -<a name="l00237"></a>00237 close(fd); -<a name="l00238"></a>00238 delete thr; -<a name="l00239"></a>00239 } -<a name="l00240"></a>00240 }; -<a name="l00241"></a>00241 -<a name="l00242"></a>00242 typedef shared_ptr<ClientInfo> ClientInfoPtr; -<a name="l00243"></a>00243 -<a name="l00244"></a>00244 <a class="code" href="classPassenger_1_1StandardApplicationPool.html" title="A standard implementation of ApplicationPool for single-process environments.">StandardApplicationPool</a> pool; -<a name="l00245"></a>00245 int serverSocket; -<a name="l00246"></a>00246 int connectSocket; -<a name="l00247"></a>00247 bool done, detached; -<a name="l00248"></a>00248 -<a name="l00249"></a>00249 mutex lock; -<a name="l00250"></a>00250 thread *serverThread; -<a name="l00251"></a>00251 set<ClientInfoPtr> clients; -<a name="l00252"></a>00252 -<a name="l00253"></a>00253 // TODO: check for exceptions in threads, possibly forwarding them -<a name="l00254"></a>00254 -<a name="l00255"></a>00255 /** -<a name="l00256"></a>00256 * The entry point of the server thread which sets up private connections. -<a name="l00257"></a>00257 * See the class overview's implementation notes for details. -<a name="l00258"></a>00258 */ -<a name="l00259"></a>00259 void serverThreadMainLoop() { -<a name="l00260"></a>00260 while (!done) { -<a name="l00261"></a>00261 int fds[2], ret; -<a name="l00262"></a>00262 char x; -<a name="l00263"></a>00263 -<a name="l00264"></a>00264 // The received data only serves to wake up the server socket, -<a name="l00265"></a>00265 // and is not important. -<a name="l00266"></a>00266 do { -<a name="l00267"></a>00267 ret = read(serverSocket, &x, 1); -<a name="l00268"></a>00268 } while (ret == -1 && errno == EINTR); -<a name="l00269"></a>00269 if (ret == 0) { -<a name="l00270"></a>00270 break; -<a name="l00271"></a>00271 } -<a name="l00272"></a>00272 -<a name="l00273"></a>00273 socketpair(AF_UNIX, SOCK_STREAM, 0, fds); -<a name="l00274"></a>00274 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(serverSocket).writeFileDescriptor(fds[1]); -<a name="l00275"></a>00275 close(fds[1]); -<a name="l00276"></a>00276 -<a name="l00277"></a>00277 ClientInfoPtr info(new ClientInfo()); -<a name="l00278"></a>00278 info->fd = fds[0]; -<a name="l00279"></a>00279 info->thr = new thread(bind(&ApplicationPoolServer::clientThreadMainLoop, this, info)); -<a name="l00280"></a>00280 mutex::scoped_lock l(lock); -<a name="l00281"></a>00281 clients.insert(info); -<a name="l00282"></a>00282 } -<a name="l00283"></a>00283 } -<a name="l00284"></a>00284 -<a name="l00285"></a>00285 /** -<a name="l00286"></a>00286 * The entry point of a thread which handles exactly one client. -<a name="l00287"></a>00287 */ -<a name="l00288"></a>00288 void clientThreadMainLoop(ClientInfoPtr client) { -<a name="l00289"></a>00289 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> channel(client->fd); -<a name="l00290"></a>00290 vector<string> args; -<a name="l00291"></a>00291 map<int, Application::SessionPtr> sessions; -<a name="l00292"></a>00292 int lastID = 0; -<a name="l00293"></a>00293 +<a name="l00163"></a>00163 virtual int getWriter() { +<a name="l00164"></a>00164 return writer; +<a name="l00165"></a>00165 } +<a name="l00166"></a>00166 +<a name="l00167"></a>00167 virtual void closeWriter() { +<a name="l00168"></a>00168 if (writer != -1) { +<a name="l00169"></a>00169 close(writer); +<a name="l00170"></a>00170 writer = -1; +<a name="l00171"></a>00171 } +<a name="l00172"></a>00172 } +<a name="l00173"></a>00173 +<a name="l00174"></a>00174 virtual pid_t getPid() { +<a name="l00175"></a>00175 return pid; +<a name="l00176"></a>00176 } +<a name="l00177"></a>00177 }; +<a name="l00178"></a>00178 +<a name="l00179"></a>00179 /** +<a name="l00180"></a>00180 * An ApplicationPool implementation that works together with ApplicationPoolServer. +<a name="l00181"></a>00181 * It doesn't do much by itself, its job is mostly to forward queries/commands to +<a name="l00182"></a>00182 * the server and returning the result. Most of the logic is in the server. +<a name="l00183"></a>00183 */ +<a name="l00184"></a>00184 class Client: public <a class="code" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a> { +<a name="l00185"></a>00185 private: +<a name="l00186"></a>00186 SharedDataPtr data; +<a name="l00187"></a>00187 +<a name="l00188"></a>00188 public: +<a name="l00189"></a>00189 /** +<a name="l00190"></a>00190 * Create a new Client. +<a name="l00191"></a>00191 * +<a name="l00192"></a>00192 * @param sock The newly established socket connection with the ApplicationPoolServer. +<a name="l00193"></a>00193 */ +<a name="l00194"></a>00194 Client(int sock) { +<a name="l00195"></a>00195 data = <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(new SharedData()); +<a name="l00196"></a>00196 data->server = sock; +<a name="l00197"></a>00197 } +<a name="l00198"></a>00198 +<a name="l00199"></a>00199 virtual void setMax(unsigned int max) { +<a name="l00200"></a>00200 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> channel(data->server); +<a name="l00201"></a>00201 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>("setMax", <a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(max).c_str(), NULL); +<a name="l00202"></a>00202 } +<a name="l00203"></a>00203 +<a name="l00204"></a>00204 virtual unsigned int getActive() const { +<a name="l00205"></a>00205 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> channel(data->server); +<a name="l00206"></a>00206 vector<string> args; +<a name="l00207"></a>00207 +<a name="l00208"></a>00208 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>("getActive", NULL); +<a name="l00209"></a>00209 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor.">read</a>(args); +<a name="l00210"></a>00210 return <a class="code" href="group__Support.html#g73b17b509ee44938a56bf16cbf82fb48" title="Converts the given string to an integer.">atoi</a>(args[0].c_str()); +<a name="l00211"></a>00211 } +<a name="l00212"></a>00212 +<a name="l00213"></a>00213 virtual unsigned int getCount() const { +<a name="l00214"></a>00214 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> channel(data->server); +<a name="l00215"></a>00215 vector<string> args; +<a name="l00216"></a>00216 +<a name="l00217"></a>00217 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>("getCount", NULL); +<a name="l00218"></a>00218 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor.">read</a>(args); +<a name="l00219"></a>00219 return <a class="code" href="group__Support.html#g73b17b509ee44938a56bf16cbf82fb48" title="Converts the given string to an integer.">atoi</a>(args[0].c_str()); +<a name="l00220"></a>00220 } +<a name="l00221"></a>00221 +<a name="l00222"></a>00222 virtual <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">Application::SessionPtr</a> get(const string &appRoot, const string &user = "", const string &group = "") { +<a name="l00223"></a>00223 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> channel(data->server); +<a name="l00224"></a>00224 vector<string> args; +<a name="l00225"></a>00225 int reader, writer; +<a name="l00226"></a>00226 +<a name="l00227"></a>00227 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>("get", appRoot.c_str(), user.c_str(), group.c_str(), NULL); +<a name="l00228"></a>00228 if (!channel.<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor.">read</a>(args)) { +<a name="l00229"></a>00229 throw <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>("The ApplicationPool server unexpectedly closed the connection."); +<a name="l00230"></a>00230 } +<a name="l00231"></a>00231 if (args[0] == "ok") { +<a name="l00232"></a>00232 reader = channel.<a class="code" href="classPassenger_1_1MessageChannel.html#1561b7e4a0f4d39ea431f456e5655488" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>(); +<a name="l00233"></a>00233 writer = channel.<a class="code" href="classPassenger_1_1MessageChannel.html#1561b7e4a0f4d39ea431f456e5655488" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>(); +<a name="l00234"></a>00234 return <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(new RemoteSession(data, <a class="code" href="group__Support.html#g73b17b509ee44938a56bf16cbf82fb48" title="Converts the given string to an integer.">atoi</a>(args[1]), <a class="code" href="group__Support.html#g73b17b509ee44938a56bf16cbf82fb48" title="Converts the given string to an integer.">atoi</a>(args[2]), reader, writer)); +<a name="l00235"></a>00235 } else if (args[0] == "SpawnException") { +<a name="l00236"></a>00236 throw <a class="code" href="classPassenger_1_1SpawnException.html" title="Thrown when SpawnManager or ApplicationPool fail to spawn an application instance...">SpawnException</a>(args[1]); +<a name="l00237"></a>00237 } else if (args[0] == "IOException") { +<a name="l00238"></a>00238 throw <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(args[1]); +<a name="l00239"></a>00239 } else { +<a name="l00240"></a>00240 throw <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>("The ApplicationPool server returned an unknown message."); +<a name="l00241"></a>00241 } +<a name="l00242"></a>00242 } +<a name="l00243"></a>00243 }; +<a name="l00244"></a>00244 +<a name="l00245"></a>00245 /** +<a name="l00246"></a>00246 * Contains information about exactly one client. +<a name="l00247"></a>00247 */ +<a name="l00248"></a>00248 struct ClientInfo { +<a name="l00249"></a>00249 /** The connection to the client. */ +<a name="l00250"></a>00250 int fd; +<a name="l00251"></a>00251 /** The thread which handles the client. */ +<a name="l00252"></a>00252 thread *thr; +<a name="l00253"></a>00253 bool detached; +<a name="l00254"></a>00254 +<a name="l00255"></a>00255 ClientInfo() { +<a name="l00256"></a>00256 detached = false; +<a name="l00257"></a>00257 } +<a name="l00258"></a>00258 +<a name="l00259"></a>00259 void <a class="code" href="classPassenger_1_1ApplicationPoolServer.html#b13957e32ae8ca36ba85f2e6ffefd5ce" title="Detach the server by freeing up some server resources such as file descriptors.">detach</a>() { +<a name="l00260"></a>00260 detached = true; +<a name="l00261"></a>00261 } +<a name="l00262"></a>00262 +<a name="l00263"></a>00263 ~ClientInfo() { +<a name="l00264"></a>00264 close(fd); +<a name="l00265"></a>00265 // For some reason, joining or deleting (detaching) +<a name="l00266"></a>00266 // the thread after fork() will cause a segfault. +<a name="l00267"></a>00267 // I haven't figured out why that happens, so for now +<a name="l00268"></a>00268 // I'll just ignore the thread (which isn't running +<a name="l00269"></a>00269 // anyway). +<a name="l00270"></a>00270 if (!detached) { +<a name="l00271"></a>00271 delete thr; +<a name="l00272"></a>00272 } +<a name="l00273"></a>00273 } +<a name="l00274"></a>00274 }; +<a name="l00275"></a>00275 +<a name="l00276"></a>00276 typedef shared_ptr<ClientInfo> ClientInfoPtr; +<a name="l00277"></a>00277 +<a name="l00278"></a>00278 <a class="code" href="classPassenger_1_1StandardApplicationPool.html" title="A standard implementation of ApplicationPool for single-process environments.">StandardApplicationPool</a> pool; +<a name="l00279"></a>00279 int serverSocket; +<a name="l00280"></a>00280 int connectSocket; +<a name="l00281"></a>00281 bool done, detached; +<a name="l00282"></a>00282 +<a name="l00283"></a>00283 mutex lock; +<a name="l00284"></a>00284 thread *serverThread; +<a name="l00285"></a>00285 set<ClientInfoPtr> clients; +<a name="l00286"></a>00286 +<a name="l00287"></a>00287 // TODO: check for exceptions in threads, possibly forwarding them +<a name="l00288"></a>00288 +<a name="l00289"></a>00289 /** +<a name="l00290"></a>00290 * The entry point of the server thread which sets up private connections. +<a name="l00291"></a>00291 * See the class overview's implementation notes for details. +<a name="l00292"></a>00292 */ +<a name="l00293"></a>00293 void serverThreadMainLoop() { <a name="l00294"></a>00294 while (!done) { -<a name="l00295"></a>00295 if (!channel.<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor.">read</a>(args)) { -<a name="l00296"></a>00296 break; -<a name="l00297"></a>00297 } -<a name="l00298"></a>00298 -<a name="l00299"></a>00299 if (args[0] == "get" && args.size() == 4) { -<a name="l00300"></a>00300 <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">Application::SessionPtr</a> session(pool.<a class="code" href="classPassenger_1_1StandardApplicationPool.html#cb338093c3368bf1cbcba02099c6c76e" title="Open a new session with the application specified by appRoot.">get</a>(args[1], args[2], args[3])); -<a name="l00301"></a>00301 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(toString(lastID).c_str(), NULL); -<a name="l00302"></a>00302 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#73e3f3cda384c085a2af0e820ccd3e98" title="Pass a file descriptor.">writeFileDescriptor</a>(session->getReader()); -<a name="l00303"></a>00303 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#73e3f3cda384c085a2af0e820ccd3e98" title="Pass a file descriptor.">writeFileDescriptor</a>(session->getWriter()); -<a name="l00304"></a>00304 session->closeReader(); -<a name="l00305"></a>00305 session->closeWriter(); -<a name="l00306"></a>00306 sessions[lastID] = session; -<a name="l00307"></a>00307 lastID++; -<a name="l00308"></a>00308 } else if (args[0] == "close" && args.size() == 2) { -<a name="l00309"></a>00309 sessions.erase(atoi(args[1].c_str())); -<a name="l00310"></a>00310 } else if (args[0] == "setMax") { -<a name="l00311"></a>00311 pool.<a class="code" href="classPassenger_1_1StandardApplicationPool.html#04ef8c92da189520ad2022f4f82e9553" title="Set a hard limit on the number of application instances that this ApplicationPool...">setMax</a>(atoi(args[1].c_str())); -<a name="l00312"></a>00312 } else if (args[0] == "getActive") { -<a name="l00313"></a>00313 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(toString(pool.<a class="code" href="classPassenger_1_1StandardApplicationPool.html#7773c4a3dfbd88eac72401d063831788" title="Get the number of active applications in the pool.">getActive</a>()).c_str(), NULL); -<a name="l00314"></a>00314 } else if (args[0] == "getCount") { -<a name="l00315"></a>00315 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(toString(pool.<a class="code" href="classPassenger_1_1StandardApplicationPool.html#cdbfe2b9ffacdab4438c879c2411bf02" title="Get the number of active applications in the pool.">getCount</a>()).c_str(), NULL); -<a name="l00316"></a>00316 } -<a name="l00317"></a>00317 } -<a name="l00318"></a>00318 -<a name="l00319"></a>00319 mutex::scoped_lock l(lock); -<a name="l00320"></a>00320 clients.erase(client); -<a name="l00321"></a>00321 } -<a name="l00322"></a>00322 -<a name="l00323"></a>00323 public: -<a name="l00324"></a>00324 /** -<a name="l00325"></a>00325 * Create a new ApplicationPoolServer object. -<a name="l00326"></a>00326 * -<a name="l00327"></a>00327 * @param spawnServerCommand The filename of the spawn server to use. -<a name="l00328"></a>00328 * @param logFile Specify a log file that the spawn server should use. -<a name="l00329"></a>00329 * Messages on its standard output and standard error channels -<a name="l00330"></a>00330 * will be written to this log file. If an empty string is -<a name="l00331"></a>00331 * specified, no log file will be used, and the spawn server -<a name="l00332"></a>00332 * will use the same standard output/error channels as the -<a name="l00333"></a>00333 * current process. -<a name="l00334"></a>00334 * @param environment The RAILS_ENV environment that all RoR applications -<a name="l00335"></a>00335 * should use. If an empty string is specified, the current value -<a name="l00336"></a>00336 * of the RAILS_ENV environment variable will be used. -<a name="l00337"></a>00337 * @param rubyCommand The Ruby interpreter's command. -<a name="l00338"></a>00338 * @throws SystemException An error occured while trying to setup the spawn server -<a name="l00339"></a>00339 * or the server socket. -<a name="l00340"></a>00340 * @throws IOException The specified log file could not be opened. -<a name="l00341"></a>00341 */ -<a name="l00342"></a><a class="code" href="classPassenger_1_1ApplicationPoolServer.html#0c6c9869ae4e1768f620bb03ee7a6b03">00342</a> <a class="code" href="classPassenger_1_1ApplicationPoolServer.html#0c6c9869ae4e1768f620bb03ee7a6b03" title="Create a new ApplicationPoolServer object.">ApplicationPoolServer</a>(const string &spawnServerCommand, -<a name="l00343"></a>00343 const string &logFile = "", -<a name="l00344"></a>00344 const string &environment = "production", -<a name="l00345"></a>00345 const string &rubyCommand = "ruby") -<a name="l00346"></a>00346 : pool(spawnServerCommand, logFile, environment, rubyCommand) { -<a name="l00347"></a>00347 int fds[2]; -<a name="l00348"></a>00348 -<a name="l00349"></a>00349 if (socketpair(AF_UNIX, SOCK_STREAM, 0, fds) == -1) { -<a name="l00350"></a>00350 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("Cannot create a Unix socket pair", errno); -<a name="l00351"></a>00351 } -<a name="l00352"></a>00352 serverSocket = fds[0]; -<a name="l00353"></a>00353 connectSocket = fds[1]; -<a name="l00354"></a>00354 done = false; -<a name="l00355"></a>00355 detached = false; -<a name="l00356"></a>00356 serverThread = new thread(bind(&ApplicationPoolServer::serverThreadMainLoop, this)); -<a name="l00357"></a>00357 } -<a name="l00358"></a>00358 -<a name="l00359"></a>00359 ~<a class="code" href="classPassenger_1_1ApplicationPoolServer.html" title="Multi-process usage support for ApplicationPool.">ApplicationPoolServer</a>() { -<a name="l00360"></a>00360 if (!detached) { -<a name="l00361"></a>00361 done = true; -<a name="l00362"></a>00362 close(connectSocket); -<a name="l00363"></a>00363 serverThread->join(); -<a name="l00364"></a>00364 delete serverThread; -<a name="l00365"></a>00365 close(serverSocket); -<a name="l00366"></a>00366 -<a name="l00367"></a>00367 set<ClientInfoPtr> clientsCopy; -<a name="l00368"></a>00368 { -<a name="l00369"></a>00369 mutex::scoped_lock l(lock); -<a name="l00370"></a>00370 clientsCopy = clients; -<a name="l00371"></a>00371 } -<a name="l00372"></a>00372 set<ClientInfoPtr>::iterator it; -<a name="l00373"></a>00373 for (it = clientsCopy.begin(); it != clientsCopy.end(); it++) { -<a name="l00374"></a>00374 (*it)->thr->join(); -<a name="l00375"></a>00375 } -<a name="l00376"></a>00376 } -<a name="l00377"></a>00377 } -<a name="l00378"></a>00378 -<a name="l00379"></a>00379 /** -<a name="l00380"></a>00380 * Connects to the server and returns a usable ApplicationPool object. -<a name="l00381"></a>00381 * All cache/pool data of this ApplicationPool is actually stored on the server -<a name="l00382"></a>00382 * and shared with other clients, but that is totally transparent. -<a name="l00383"></a>00383 * -<a name="l00384"></a>00384 * @throws SystemException Something went wrong. -<a name="l00385"></a>00385 * @throws IOException Something went wrong. -<a name="l00386"></a>00386 */ -<a name="l00387"></a><a class="code" href="classPassenger_1_1ApplicationPoolServer.html#18f77057cc28e7924a8f4d1397aa0468">00387</a> ApplicationPoolPtr <a class="code" href="classPassenger_1_1ApplicationPoolServer.html#18f77057cc28e7924a8f4d1397aa0468" title="Connects to the server and returns a usable ApplicationPool object.">connect</a>() { -<a name="l00388"></a>00388 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> channel(connectSocket); -<a name="l00389"></a>00389 int fd; -<a name="l00390"></a>00390 -<a name="l00391"></a>00391 // Write some random data to wake up the server. -<a name="l00392"></a>00392 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>("x", 1); -<a name="l00393"></a>00393 -<a name="l00394"></a>00394 fd = channel.<a class="code" href="classPassenger_1_1MessageChannel.html#1561b7e4a0f4d39ea431f456e5655488" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>(); -<a name="l00395"></a>00395 return ptr(new Client(fd)); -<a name="l00396"></a>00396 } -<a name="l00397"></a>00397 -<a name="l00398"></a>00398 /** -<a name="l00399"></a>00399 * Detach the server by freeing up some server resources such as file descriptors. -<a name="l00400"></a>00400 * This should be called by child processes that wish to use a server, but do -<a name="l00401"></a>00401 * not run the server itself. -<a name="l00402"></a>00402 * -<a name="l00403"></a>00403 * This method may only be called once. The ApplicationPoolServer object -<a name="l00404"></a>00404 * will become unusable once detach() has been called. -<a name="l00405"></a>00405 * -<a name="l00406"></a>00406 * @warning Never call this method in the process in which this -<a name="l00407"></a>00407 * ApplicationPoolServer was created! -<a name="l00408"></a>00408 */ -<a name="l00409"></a><a class="code" href="classPassenger_1_1ApplicationPoolServer.html#b13957e32ae8ca36ba85f2e6ffefd5ce">00409</a> void <a class="code" href="classPassenger_1_1ApplicationPoolServer.html#b13957e32ae8ca36ba85f2e6ffefd5ce" title="Detach the server by freeing up some server resources such as file descriptors.">detach</a>() { -<a name="l00410"></a>00410 detached = true; -<a name="l00411"></a>00411 close(connectSocket); -<a name="l00412"></a>00412 close(serverSocket); -<a name="l00413"></a>00413 #ifdef VALGRIND_FRIENDLY -<a name="l00414"></a>00414 delete serverThread; -<a name="l00415"></a>00415 #endif -<a name="l00416"></a>00416 clients.clear(); -<a name="l00417"></a>00417 pool.<a class="code" href="classPassenger_1_1StandardApplicationPool.html#047ba4c66c67d5913c8edc36524c5eac">detach</a>(); -<a name="l00418"></a>00418 } -<a name="l00419"></a>00419 }; -<a name="l00420"></a>00420 -<a name="l00421"></a>00421 typedef shared_ptr<ApplicationPoolServer> ApplicationPoolServerPtr; -<a name="l00422"></a>00422 -<a name="l00423"></a>00423 } // namespace Passenger -<a name="l00424"></a>00424 -<a name="l00425"></a>00425 #endif /* _PASSENGER_APPLICATION_POOL_CLIENT_SERVER_H_ */ -</pre></div><hr size="1"><address style="text-align: right;">Generated on Fri Feb 8 20:08:48 2008 for Passenger by  +<a name="l00295"></a>00295 int fds[2], ret; +<a name="l00296"></a>00296 char x; +<a name="l00297"></a>00297 +<a name="l00298"></a>00298 // The received data only serves to wake up the server socket, +<a name="l00299"></a>00299 // and is not important. +<a name="l00300"></a>00300 do { +<a name="l00301"></a>00301 ret = read(serverSocket, &x, 1); +<a name="l00302"></a>00302 } while (ret == -1 && errno == EINTR); +<a name="l00303"></a>00303 if (ret == 0) { +<a name="l00304"></a>00304 break; +<a name="l00305"></a>00305 } +<a name="l00306"></a>00306 +<a name="l00307"></a>00307 // Incoming connect request. +<a name="l00308"></a>00308 do { +<a name="l00309"></a>00309 ret = socketpair(AF_UNIX, SOCK_STREAM, 0, fds); +<a name="l00310"></a>00310 } while (ret == -1 && errno == EINTR); +<a name="l00311"></a>00311 if (ret == -1) { +<a name="l00312"></a>00312 int e = errno; +<a name="l00313"></a>00313 P_ERROR("Cannot create an anonymous Unix socket: " << +<a name="l00314"></a>00314 strerror(e) << " (" << e << ")"); +<a name="l00315"></a>00315 abort(); +<a name="l00316"></a>00316 +<a name="l00317"></a>00317 // Shut up compiler warning. +<a name="l00318"></a>00318 bool x = false; +<a name="l00319"></a>00319 if (x) { +<a name="l00320"></a>00320 printf("%d", e); +<a name="l00321"></a>00321 } +<a name="l00322"></a>00322 } +<a name="l00323"></a>00323 +<a name="l00324"></a>00324 try { +<a name="l00325"></a>00325 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a>(serverSocket).writeFileDescriptor(fds[1]); +<a name="l00326"></a>00326 do { +<a name="l00327"></a>00327 ret = close(fds[1]); +<a name="l00328"></a>00328 } while (ret == -1 && errno == EINTR); +<a name="l00329"></a>00329 } catch (const exception &e) { +<a name="l00330"></a>00330 P_ERROR("Cannot send a file descriptor: " << e.what()); +<a name="l00331"></a>00331 abort(); +<a name="l00332"></a>00332 } +<a name="l00333"></a>00333 +<a name="l00334"></a>00334 ClientInfoPtr info(new ClientInfo()); +<a name="l00335"></a>00335 info->fd = fds[0]; +<a name="l00336"></a>00336 info->thr = new thread(bind(&ApplicationPoolServer::clientThreadMainLoop, this, info)); +<a name="l00337"></a>00337 mutex::scoped_lock l(lock); +<a name="l00338"></a>00338 clients.insert(info); +<a name="l00339"></a>00339 } +<a name="l00340"></a>00340 } +<a name="l00341"></a>00341 +<a name="l00342"></a>00342 /** +<a name="l00343"></a>00343 * The entry point of a thread which handles exactly one client. +<a name="l00344"></a>00344 */ +<a name="l00345"></a>00345 void clientThreadMainLoop(ClientInfoPtr client) { +<a name="l00346"></a>00346 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> channel(client->fd); +<a name="l00347"></a>00347 vector<string> args; +<a name="l00348"></a>00348 map<int, Application::SessionPtr> sessions; +<a name="l00349"></a>00349 int lastID = 0; +<a name="l00350"></a>00350 +<a name="l00351"></a>00351 try { +<a name="l00352"></a>00352 while (!done) { +<a name="l00353"></a>00353 if (!channel.<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor.">read</a>(args)) { +<a name="l00354"></a>00354 break; +<a name="l00355"></a>00355 } +<a name="l00356"></a>00356 +<a name="l00357"></a>00357 if (args[0] == "get" && args.size() == 4) { +<a name="l00358"></a>00358 <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">Application::SessionPtr</a> session; +<a name="l00359"></a>00359 bool failed = false; +<a name="l00360"></a>00360 try { +<a name="l00361"></a>00361 session = pool.<a class="code" href="classPassenger_1_1StandardApplicationPool.html#cb338093c3368bf1cbcba02099c6c76e" title="Open a new session with the application specified by appRoot.">get</a>(args[1], args[2], args[3]); +<a name="l00362"></a>00362 } catch (const <a class="code" href="classPassenger_1_1SpawnException.html" title="Thrown when SpawnManager or ApplicationPool fail to spawn an application instance...">SpawnException</a> &e) { +<a name="l00363"></a>00363 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>("SpawnException", e.<a class="code" href="classPassenger_1_1SpawnException.html#d2da180f89a43423a4b37248249972ff">what</a>(), NULL); +<a name="l00364"></a>00364 failed = true; +<a name="l00365"></a>00365 } catch (const <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a> &e) { +<a name="l00366"></a>00366 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>("IOException", e.<a class="code" href="classPassenger_1_1IOException.html#1b65d0fdb9bc5136f5b7df759c14768a">what</a>(), NULL); +<a name="l00367"></a>00367 failed = true; +<a name="l00368"></a>00368 } +<a name="l00369"></a>00369 if (!failed) { +<a name="l00370"></a>00370 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>("ok", <a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(session->getPid()).c_str(), +<a name="l00371"></a>00371 <a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(lastID).c_str(), NULL); +<a name="l00372"></a>00372 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#73e3f3cda384c085a2af0e820ccd3e98" title="Pass a file descriptor.">writeFileDescriptor</a>(session->getReader()); +<a name="l00373"></a>00373 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#73e3f3cda384c085a2af0e820ccd3e98" title="Pass a file descriptor.">writeFileDescriptor</a>(session->getWriter()); +<a name="l00374"></a>00374 session->closeReader(); +<a name="l00375"></a>00375 session->closeWriter(); +<a name="l00376"></a>00376 sessions[lastID] = session; +<a name="l00377"></a>00377 lastID++; +<a name="l00378"></a>00378 } +<a name="l00379"></a>00379 +<a name="l00380"></a>00380 } else if (args[0] == "close" && args.size() == 2) { +<a name="l00381"></a>00381 sessions.erase(<a class="code" href="group__Support.html#g73b17b509ee44938a56bf16cbf82fb48" title="Converts the given string to an integer.">atoi</a>(args[1])); +<a name="l00382"></a>00382 +<a name="l00383"></a>00383 } else if (args[0] == "setMax" && args.size() == 2) { +<a name="l00384"></a>00384 pool.<a class="code" href="classPassenger_1_1StandardApplicationPool.html#04ef8c92da189520ad2022f4f82e9553" title="Set a hard limit on the number of application instances that this ApplicationPool...">setMax</a>(<a class="code" href="group__Support.html#g73b17b509ee44938a56bf16cbf82fb48" title="Converts the given string to an integer.">atoi</a>(args[1])); +<a name="l00385"></a>00385 +<a name="l00386"></a>00386 } else if (args[0] == "getActive" && args.size() == 1) { +<a name="l00387"></a>00387 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(pool.<a class="code" href="classPassenger_1_1StandardApplicationPool.html#7773c4a3dfbd88eac72401d063831788" title="Get the number of active applications in the pool.">getActive</a>()).c_str(), NULL); +<a name="l00388"></a>00388 +<a name="l00389"></a>00389 } else if (args[0] == "getCount" && args.size() == 1) { +<a name="l00390"></a>00390 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(<a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(pool.<a class="code" href="classPassenger_1_1StandardApplicationPool.html#cdbfe2b9ffacdab4438c879c2411bf02" title="Get the number of active applications in the pool.">getCount</a>()).c_str(), NULL); +<a name="l00391"></a>00391 +<a name="l00392"></a>00392 } else { +<a name="l00393"></a>00393 string name; +<a name="l00394"></a>00394 if (args.empty()) { +<a name="l00395"></a>00395 name = "(null)"; +<a name="l00396"></a>00396 } else { +<a name="l00397"></a>00397 name = args[0]; +<a name="l00398"></a>00398 } +<a name="l00399"></a>00399 P_WARN("An ApplicationPoolServer client sent an invalid command: " +<a name="l00400"></a>00400 << name << " (" << args.size() << " elements)"); +<a name="l00401"></a>00401 done = true; +<a name="l00402"></a>00402 } +<a name="l00403"></a>00403 } +<a name="l00404"></a>00404 } catch (const exception &e) { +<a name="l00405"></a>00405 P_WARN("Uncaught exception in ApplicationPoolServer client thread: " << +<a name="l00406"></a>00406 e.what()); +<a name="l00407"></a>00407 } +<a name="l00408"></a>00408 +<a name="l00409"></a>00409 mutex::scoped_lock l(lock); +<a name="l00410"></a>00410 clients.erase(client); +<a name="l00411"></a>00411 } +<a name="l00412"></a>00412 +<a name="l00413"></a>00413 public: +<a name="l00414"></a>00414 /** +<a name="l00415"></a>00415 * Create a new ApplicationPoolServer object. +<a name="l00416"></a>00416 * +<a name="l00417"></a>00417 * @param spawnServerCommand The filename of the spawn server to use. +<a name="l00418"></a>00418 * @param logFile Specify a log file that the spawn server should use. +<a name="l00419"></a>00419 * Messages on its standard output and standard error channels +<a name="l00420"></a>00420 * will be written to this log file. If an empty string is +<a name="l00421"></a>00421 * specified, no log file will be used, and the spawn server +<a name="l00422"></a>00422 * will use the same standard output/error channels as the +<a name="l00423"></a>00423 * current process. +<a name="l00424"></a>00424 * @param environment The RAILS_ENV environment that all RoR applications +<a name="l00425"></a>00425 * should use. If an empty string is specified, the current value +<a name="l00426"></a>00426 * of the RAILS_ENV environment variable will be used. +<a name="l00427"></a>00427 * @param rubyCommand The Ruby interpreter's command. +<a name="l00428"></a>00428 * @throws SystemException An error occured while trying to setup the spawn server +<a name="l00429"></a>00429 * or the server socket. +<a name="l00430"></a>00430 * @throws IOException The specified log file could not be opened. +<a name="l00431"></a>00431 */ +<a name="l00432"></a><a class="code" href="classPassenger_1_1ApplicationPoolServer.html#0c6c9869ae4e1768f620bb03ee7a6b03">00432</a> <a class="code" href="classPassenger_1_1ApplicationPoolServer.html#0c6c9869ae4e1768f620bb03ee7a6b03" title="Create a new ApplicationPoolServer object.">ApplicationPoolServer</a>(const string &spawnServerCommand, +<a name="l00433"></a>00433 const string &logFile = "", +<a name="l00434"></a>00434 const string &environment = "production", +<a name="l00435"></a>00435 const string &rubyCommand = "ruby") +<a name="l00436"></a>00436 : pool(spawnServerCommand, logFile, environment, rubyCommand) { +<a name="l00437"></a>00437 int fds[2]; +<a name="l00438"></a>00438 +<a name="l00439"></a>00439 if (socketpair(AF_UNIX, SOCK_STREAM, 0, fds) == -1) { +<a name="l00440"></a>00440 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("Cannot create a Unix socket pair", errno); +<a name="l00441"></a>00441 } +<a name="l00442"></a>00442 serverSocket = fds[0]; +<a name="l00443"></a>00443 connectSocket = fds[1]; +<a name="l00444"></a>00444 done = false; +<a name="l00445"></a>00445 detached = false; +<a name="l00446"></a>00446 serverThread = new thread(bind(&ApplicationPoolServer::serverThreadMainLoop, this)); +<a name="l00447"></a>00447 } +<a name="l00448"></a>00448 +<a name="l00449"></a>00449 ~<a class="code" href="classPassenger_1_1ApplicationPoolServer.html" title="Multi-process usage support for ApplicationPool.">ApplicationPoolServer</a>() { +<a name="l00450"></a>00450 if (!detached) { +<a name="l00451"></a>00451 done = true; +<a name="l00452"></a>00452 close(connectSocket); +<a name="l00453"></a>00453 serverThread->join(); +<a name="l00454"></a>00454 delete serverThread; +<a name="l00455"></a>00455 close(serverSocket); +<a name="l00456"></a>00456 +<a name="l00457"></a>00457 set<ClientInfoPtr> clientsCopy; +<a name="l00458"></a>00458 { +<a name="l00459"></a>00459 mutex::scoped_lock l(lock); +<a name="l00460"></a>00460 clientsCopy = clients; +<a name="l00461"></a>00461 } +<a name="l00462"></a>00462 set<ClientInfoPtr>::iterator it; +<a name="l00463"></a>00463 for (it = clientsCopy.begin(); it != clientsCopy.end(); it++) { +<a name="l00464"></a>00464 (*it)->thr->join(); +<a name="l00465"></a>00465 } +<a name="l00466"></a>00466 } +<a name="l00467"></a>00467 } +<a name="l00468"></a>00468 +<a name="l00469"></a>00469 /** +<a name="l00470"></a>00470 * Connects to the server and returns a usable ApplicationPool object. +<a name="l00471"></a>00471 * All cache/pool data of this ApplicationPool is actually stored on the server +<a name="l00472"></a>00472 * and shared with other clients, but that is totally transparent. +<a name="l00473"></a>00473 * +<a name="l00474"></a>00474 * @throws SystemException Something went wrong. +<a name="l00475"></a>00475 * @throws IOException Something went wrong. +<a name="l00476"></a>00476 */ +<a name="l00477"></a><a class="code" href="classPassenger_1_1ApplicationPoolServer.html#18f77057cc28e7924a8f4d1397aa0468">00477</a> ApplicationPoolPtr <a class="code" href="classPassenger_1_1ApplicationPoolServer.html#18f77057cc28e7924a8f4d1397aa0468" title="Connects to the server and returns a usable ApplicationPool object.">connect</a>() { +<a name="l00478"></a>00478 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> channel(connectSocket); +<a name="l00479"></a>00479 int fd; +<a name="l00480"></a>00480 +<a name="l00481"></a>00481 // Write some random data to wake up the server. +<a name="l00482"></a>00482 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>("x", 1); +<a name="l00483"></a>00483 +<a name="l00484"></a>00484 fd = channel.<a class="code" href="classPassenger_1_1MessageChannel.html#1561b7e4a0f4d39ea431f456e5655488" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>(); +<a name="l00485"></a>00485 return <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(new Client(fd)); +<a name="l00486"></a>00486 } +<a name="l00487"></a>00487 +<a name="l00488"></a>00488 /** +<a name="l00489"></a>00489 * Detach the server by freeing up some server resources such as file descriptors. +<a name="l00490"></a>00490 * This should be called by child processes that wish to use a server, but do +<a name="l00491"></a>00491 * not run the server itself. +<a name="l00492"></a>00492 * +<a name="l00493"></a>00493 * This method may only be called once. The ApplicationPoolServer object +<a name="l00494"></a>00494 * will become unusable once detach() has been called. +<a name="l00495"></a>00495 * +<a name="l00496"></a>00496 * @warning Never call this method in the process in which this +<a name="l00497"></a>00497 * ApplicationPoolServer was created! +<a name="l00498"></a>00498 */ +<a name="l00499"></a><a class="code" href="classPassenger_1_1ApplicationPoolServer.html#b13957e32ae8ca36ba85f2e6ffefd5ce">00499</a> void <a class="code" href="classPassenger_1_1ApplicationPoolServer.html#b13957e32ae8ca36ba85f2e6ffefd5ce" title="Detach the server by freeing up some server resources such as file descriptors.">detach</a>() { +<a name="l00500"></a>00500 detached = true; +<a name="l00501"></a>00501 close(connectSocket); +<a name="l00502"></a>00502 close(serverSocket); +<a name="l00503"></a>00503 serverThread->join(); +<a name="l00504"></a>00504 delete serverThread; +<a name="l00505"></a>00505 +<a name="l00506"></a>00506 // A client thread might have a reference to a ClientInfo +<a name="l00507"></a>00507 // object. And because that thread doesn't run anymore after a +<a name="l00508"></a>00508 // fork(), the reference never gets removed and the ClientInfo +<a name="l00509"></a>00509 // object never gets destroyed. So we forcefully delete +<a name="l00510"></a>00510 // ClientInfo objects in order to close the client file +<a name="l00511"></a>00511 // descriptors. +<a name="l00512"></a>00512 set<ClientInfoPtr>::iterator it; +<a name="l00513"></a>00513 for (it = clients.begin(); it != clients.end(); it++) { +<a name="l00514"></a>00514 if (!it->unique()) { +<a name="l00515"></a>00515 (*it)->detach(); +<a name="l00516"></a>00516 delete it->get(); +<a name="l00517"></a>00517 } +<a name="l00518"></a>00518 } +<a name="l00519"></a>00519 clients.clear(); +<a name="l00520"></a>00520 +<a name="l00521"></a>00521 pool.<a class="code" href="classPassenger_1_1StandardApplicationPool.html#047ba4c66c67d5913c8edc36524c5eac">detach</a>(); +<a name="l00522"></a>00522 } +<a name="l00523"></a>00523 }; +<a name="l00524"></a>00524 +<a name="l00525"></a>00525 typedef shared_ptr<ApplicationPoolServer> ApplicationPoolServerPtr; +<a name="l00526"></a>00526 +<a name="l00527"></a>00527 } // namespace Passenger +<a name="l00528"></a>00528 +<a name="l00529"></a>00529 #endif /* _PASSENGER_APPLICATION_POOL_CLIENT_SERVER_H_ */ +</pre></div><hr size="1"><address style="text-align: right;">Generated on Fri Feb 22 10:18:25 2008 for Passenger by  <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </address> </body> doc/cxxapi/ApplicationPoolClientServer_8h-source.html @@ -80,58 +80,58 @@ <a name="l00065"></a>00065 * session = app->connect("/home/webapps/bar") <a name="l00066"></a>00066 * @endcode <a name="l00067"></a>00067 * -<a name="l00068"></a>00068 * Internally, Application::get() will keep spawned applications instances in +<a name="l00068"></a>00068 * Internally, ApplicationPool::get() will keep spawned applications instances in <a name="l00069"></a>00069 * memory, and reuse them if possible. It will try to keep spawning to a minimum. <a name="l00070"></a>00070 * Furthermore, if an application instance hasn't been used for a while, it -<a name="l00071"></a>00071 * will be automatically shutdown in order to save memory. And finally, one can -<a name="l00072"></a>00072 * set a hard limit on the maximum number of applications instances that may be -<a name="l00073"></a>00073 * spawned (see ApplicationPool::setMax()). -<a name="l00074"></a>00074 * -<a name="l00075"></a>00075 * Note that ApplicationPool is just an interface (i.e. a pure virtual class). -<a name="l00076"></a>00076 * For concrete classes, see StandardApplicationPool and ApplicationPoolServer. +<a name="l00071"></a>00071 * will be automatically shutdown in order to save memory. Restart requests are +<a name="l00072"></a>00072 * honored: if an application has the file 'restart.txt' in its 'tmp' folder, +<a name="l00073"></a>00073 * then get() will shutdown existing instances of that application and spawn +<a name="l00074"></a>00074 * a new instance (this is useful when a new version of an application has been +<a name="l00075"></a>00075 * deployed). And finally, one can set a hard limit on the maximum number of +<a name="l00076"></a>00076 * applications instances that may be spawned (see ApplicationPool::setMax()). <a name="l00077"></a>00077 * -<a name="l00078"></a>00078 * @ingroup Support -<a name="l00079"></a>00079 */ -<a name="l00080"></a><a class="code" href="classPassenger_1_1ApplicationPool.html">00080</a> class <a class="code" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a> { -<a name="l00081"></a>00081 public: -<a name="l00082"></a>00082 virtual ~<a class="code" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a>() {}; -<a name="l00083"></a>00083 -<a name="l00084"></a>00084 /** -<a name="l00085"></a>00085 * Open a new session with the application specified by <tt>appRoot</tt>. -<a name="l00086"></a>00086 * See the class description for ApplicationPool, as well as Application::connect(), -<a name="l00087"></a>00087 * on how to use the returned session object. -<a name="l00088"></a>00088 * -<a name="l00089"></a>00089 * @param appRoot The application root of a RoR application, i.e. the folder that -<a name="l00090"></a>00090 * contains 'app/', 'public/', 'config/', etc. This must be a valid -<a name="l00091"></a>00091 * directory, but does not have to be an absolute path. -<a name="l00092"></a>00092 * @param user The user to run the application instance as. -<a name="l00093"></a>00093 * @param group The group to run the application instance as. -<a name="l00094"></a>00094 * @return A session object. -<a name="l00095"></a>00095 * @note Applications are uniquely identified with the application root -<a name="l00096"></a>00096 * string. So although <tt>appRoot</tt> does not have to be absolute, it -<a name="l00097"></a>00097 * should be. If one calls <tt>get("/home/foo")</tt> and -<a name="l00098"></a>00098 * <tt>get("/home/../home/foo")</tt>, then ApplicationPool will think -<a name="l00099"></a>00099 * they're 2 different applications, and thus will spawn 2 application instances. -<a name="l00100"></a>00100 */ -<a name="l00101"></a>00101 virtual <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">Application::SessionPtr</a> get(const string &appRoot, const string &user = "", const string &group = "") = 0; -<a name="l00102"></a>00102 -<a name="l00103"></a>00103 /** -<a name="l00104"></a>00104 * Set a hard limit on the number of application instances that this ApplicationPool -<a name="l00105"></a>00105 * may spawn. The exact behavior depends on the used algorithm, and is not specified by -<a name="l00106"></a>00106 * these API docs. -<a name="l00107"></a>00107 * -<a name="l00108"></a>00108 * It is allowed to set a limit lower than the current number of spawned applications. +<a name="l00078"></a>00078 * Note that ApplicationPool is just an interface (i.e. a pure virtual class). +<a name="l00079"></a>00079 * For concrete classes, see StandardApplicationPool and ApplicationPoolServer. +<a name="l00080"></a>00080 * The exact pooling algorithm depends on the implementation class. +<a name="l00081"></a>00081 * +<a name="l00082"></a>00082 * @ingroup Support +<a name="l00083"></a>00083 */ +<a name="l00084"></a><a class="code" href="classPassenger_1_1ApplicationPool.html">00084</a> class <a class="code" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a> { +<a name="l00085"></a>00085 public: +<a name="l00086"></a>00086 virtual ~<a class="code" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a>() {}; +<a name="l00087"></a>00087 +<a name="l00088"></a>00088 /** +<a name="l00089"></a>00089 * Open a new session with the application specified by <tt>appRoot</tt>. +<a name="l00090"></a>00090 * See the class description for ApplicationPool, as well as Application::connect(), +<a name="l00091"></a>00091 * on how to use the returned session object. +<a name="l00092"></a>00092 * +<a name="l00093"></a>00093 * Internally, this method may either spawn a new application instance, or use +<a name="l00094"></a>00094 * an existing one. +<a name="l00095"></a>00095 * +<a name="l00096"></a>00096 * @param appRoot The application root of a RoR application, i.e. the folder that +<a name="l00097"></a>00097 * contains 'app/', 'public/', 'config/', etc. This must be a valid +<a name="l00098"></a>00098 * directory, but does not have to be an absolute path. +<a name="l00099"></a>00099 * @param user The user to run the application instance as. +<a name="l00100"></a>00100 * @param group The group to run the application instance as. +<a name="l00101"></a>00101 * @return A session object. +<a name="l00102"></a>00102 * @throw SpawnException An attempt was made to spawn a new application instance, but that attempt failed. +<a name="l00103"></a>00103 * @throw IOException Something else went wrong. +<a name="l00104"></a>00104 * @note Applications are uniquely identified with the application root +<a name="l00105"></a>00105 * string. So although <tt>appRoot</tt> does not have to be absolute, it +<a name="l00106"></a>00106 * should be. If one calls <tt>get("/home/foo")</tt> and +<a name="l00107"></a>00107 * <tt>get("/home/../home/foo")</tt>, then ApplicationPool will think +<a name="l00108"></a>00108 * they're 2 different applications, and thus will spawn 2 application instances. <a name="l00109"></a>00109 */ -<a name="l00110"></a>00110 virtual void <a class="code" href="classPassenger_1_1ApplicationPool.html#0e0f21972ab130c9c0f90c2212328794" title="Set a hard limit on the number of application instances that this ApplicationPool...">setMax</a>(unsigned int max) = 0; +<a name="l00110"></a>00110 virtual <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">Application::SessionPtr</a> get(const string &appRoot, const string &user = "", const string &group = "") = 0; <a name="l00111"></a>00111 <a name="l00112"></a>00112 /** -<a name="l00113"></a>00113 * Get the number of active applications in the pool. -<a name="l00114"></a>00114 * -<a name="l00115"></a>00115 * This method exposes an implementation detail of the underlying pooling algorithm. -<a name="l00116"></a>00116 * It is used by unit tests to verify that the implementation is correct, -<a name="l00117"></a>00117 * and thus should not be called directly. +<a name="l00113"></a>00113 * Set a hard limit on the number of application instances that this ApplicationPool +<a name="l00114"></a>00114 * may spawn. The exact behavior depends on the used algorithm, and is not specified by +<a name="l00115"></a>00115 * these API docs. +<a name="l00116"></a>00116 * +<a name="l00117"></a>00117 * It is allowed to set a limit lower than the current number of spawned applications. <a name="l00118"></a>00118 */ -<a name="l00119"></a>00119 virtual unsigned int <a class="code" href="classPassenger_1_1ApplicationPool.html#06d1eae044d4d761ce77cf09049df8c8" title="Get the number of active applications in the pool.">getActive</a>() const = 0; +<a name="l00119"></a>00119 virtual void <a class="code" href="classPassenger_1_1ApplicationPool.html#0e0f21972ab130c9c0f90c2212328794" title="Set a hard limit on the number of application instances that this ApplicationPool...">setMax</a>(unsigned int max) = 0; <a name="l00120"></a>00120 <a name="l00121"></a>00121 /** <a name="l00122"></a>00122 * Get the number of active applications in the pool. @@ -140,271 +140,331 @@ <a name="l00125"></a>00125 * It is used by unit tests to verify that the implementation is correct, <a name="l00126"></a>00126 * and thus should not be called directly. <a name="l00127"></a>00127 */ -<a name="l00128"></a>00128 virtual unsigned int <a class="code" href="classPassenger_1_1ApplicationPool.html#93b0277beb510855f85fee5de5c369bb" title="Get the number of active applications in the pool.">getCount</a>() const = 0; -<a name="l00129"></a>00129 }; -<a name="l00130"></a>00130 -<a name="l00131"></a>00131 class <a class="code" href="classPassenger_1_1ApplicationPoolServer.html" title="Multi-process usage support for ApplicationPool.">ApplicationPoolServer</a>; -<a name="l00132"></a>00132 -<a name="l00133"></a>00133 /** -<a name="l00134"></a>00134 * A standard implementation of ApplicationPool for single-process environments. -<a name="l00135"></a>00135 * -<a name="l00136"></a>00136 * The environment may or may not be multithreaded - StandardApplicationPool is completely -<a name="l00137"></a>00137 * thread-safe. Apache with the threading MPM is an example of a multithreaded single-process -<a name="l00138"></a>00138 * environment. -<a name="l00139"></a>00139 * -<a name="l00140"></a>00140 * This class is unusable in multi-process environments such as Apache with the prefork MPM. -<a name="l00141"></a>00141 * The reasons as as follows: -<a name="l00142"></a>00142 * - StandardApplicationPool uses threads internally. Because threads disappear after a fork(), -<a name="l00143"></a>00143 * a StandardApplicationPool object will become unusable after a fork(). -<a name="l00144"></a>00144 * - StandardApplicationPool stores its internal cache on the heap. Different processes -<a name="l00145"></a>00145 * cannot share their heaps, so they will not be able to access each others' pool cache. -<a name="l00146"></a>00146 * - StandardApplicationPool has a connection to the spawn server. If there are multiple -<a name="l00147"></a>00147 * processes, and they all use the spawn servers's connection at the same time without -<a name="l00148"></a>00148 * some sort of synchronization, then bad things will happen. -<a name="l00149"></a>00149 * -<a name="l00150"></a>00150 * (Of course, StandardApplicationPool is usable if each process creates its own -<a name="l00151"></a>00151 * StandardApplicationPool object, but that would defeat the point of having a shared pool.) -<a name="l00152"></a>00152 * -<a name="l00153"></a>00153 * For multi-process environments, one should use ApplicationPoolServer instead. -<a name="l00154"></a>00154 * -<a name="l00155"></a>00155 * @ingroup Support -<a name="l00156"></a>00156 */ -<a name="l00157"></a><a class="code" href="classPassenger_1_1StandardApplicationPool.html">00157</a> class <a class="code" href="classPassenger_1_1StandardApplicationPool.html" title="A standard implementation of ApplicationPool for single-process environments.">StandardApplicationPool</a>: public <a class="code" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a> { -<a name="l00158"></a>00158 private: -<a name="l00159"></a>00159 static const int CLEAN_INTERVAL = 62; -<a name="l00160"></a>00160 static const int MAX_IDLE_TIME = 60; -<a name="l00161"></a>00161 -<a name="l00162"></a>00162 friend class <a class="code" href="classPassenger_1_1ApplicationPoolServer.html" title="Multi-process usage support for ApplicationPool.">ApplicationPoolServer</a>; -<a name="l00163"></a>00163 -<a name="l00164"></a>00164 typedef list<ApplicationPtr> ApplicationList; -<a name="l00165"></a>00165 typedef shared_ptr<ApplicationList> ApplicationListPtr; -<a name="l00166"></a>00166 typedef map<string, ApplicationListPtr> ApplicationMap; -<a name="l00167"></a>00167 -<a name="l00168"></a>00168 struct SharedData { -<a name="l00169"></a>00169 mutex lock; -<a name="l00170"></a>00170 condition countOrMaxChanged; -<a name="l00171"></a>00171 -<a name="l00172"></a>00172 ApplicationMap apps; -<a name="l00173"></a>00173 unsigned int max; -<a name="l00174"></a>00174 unsigned int count; -<a name="l00175"></a>00175 unsigned int active; -<a name="l00176"></a>00176 }; -<a name="l00177"></a>00177 -<a name="l00178"></a>00178 typedef shared_ptr<SharedData> SharedDataPtr; -<a name="l00179"></a>00179 -<a name="l00180"></a>00180 struct SessionCloseCallback { -<a name="l00181"></a>00181 SharedDataPtr data; -<a name="l00182"></a>00182 weak_ptr<Application> app; -<a name="l00183"></a>00183 -<a name="l00184"></a>00184 SessionCloseCallback(SharedDataPtr data, weak_ptr<Application> app) { -<a name="l00185"></a>00185 this->data = data; -<a name="l00186"></a>00186 this->app = app; -<a name="l00187"></a>00187 } -<a name="l00188"></a>00188 -<a name="l00189"></a>00189 void operator()(<a class="code" href="classPassenger_1_1Application_1_1Session.html" title="Represents the life time of a single request/response pair of a Ruby on Rails application...">Application::Session</a> &session) { -<a name="l00190"></a>00190 mutex::scoped_lock l(data->lock); -<a name="l00191"></a>00191 ApplicationPtr app(this->app.lock()); -<a name="l00192"></a>00192 -<a name="l00193"></a>00193 if (app != NULL) { -<a name="l00194"></a>00194 ApplicationMap::iterator it(data->apps.find(app->getAppRoot())); -<a name="l00195"></a>00195 if (it != data->apps.end()) { -<a name="l00196"></a>00196 if (app->getSessions() == 0) { -<a name="l00197"></a>00197 // TODO: make this operation constant time -<a name="l00198"></a>00198 it->second->remove(app); -<a name="l00199"></a>00199 it->second->push_front(app); -<a name="l00200"></a>00200 } -<a name="l00201"></a>00201 data->active--; -<a name="l00202"></a>00202 } -<a name="l00203"></a>00203 app->setLastUsed(time(NULL)); -<a name="l00204"></a>00204 } -<a name="l00205"></a>00205 } -<a name="l00206"></a>00206 }; -<a name="l00207"></a>00207 -<a name="l00208"></a>00208 #ifdef PASSENGER_USE_DUMMY_SPAWN_MANAGER -<a name="l00209"></a>00209 <a class="code" href="classPassenger_1_1DummySpawnManager.html" title="A dummy SpawnManager replacement for testing/debugging purposes.">DummySpawnManager</a> spawnManager; -<a name="l00210"></a>00210 #else -<a name="l00211"></a>00211 <a class="code" href="classPassenger_1_1SpawnManager.html">SpawnManager</a> spawnManager; -<a name="l00212"></a>00212 #endif -<a name="l00213"></a>00213 SharedDataPtr data; -<a name="l00214"></a>00214 thread *cleanerThread; -<a name="l00215"></a>00215 bool detached; -<a name="l00216"></a>00216 bool done; -<a name="l00217"></a>00217 condition cleanerThreadSleeper; -<a name="l00218"></a>00218 -<a name="l00219"></a>00219 mutex &lock; -<a name="l00220"></a>00220 condition &countOrMaxChanged; -<a name="l00221"></a>00221 ApplicationMap &apps; -<a name="l00222"></a>00222 unsigned int &max; -<a name="l00223"></a>00223 unsigned int &count; -<a name="l00224"></a>00224 unsigned int &active; -<a name="l00225"></a>00225 -<a name="l00226"></a>00226 bool needsRestart(const string &appRoot) const { -<a name="l00227"></a>00227 return false; -<a name="l00228"></a>00228 } -<a name="l00229"></a>00229 -<a name="l00230"></a>00230 void cleanerThreadMainLoop() { -<a name="l00231"></a>00231 mutex::scoped_lock l(lock); -<a name="l00232"></a>00232 while (!done) { -<a name="l00233"></a>00233 xtime xt; -<a name="l00234"></a>00234 xtime_get(&xt, TIME_UTC); -<a name="l00235"></a>00235 xt.sec += CLEAN_INTERVAL; -<a name="l00236"></a>00236 cleanerThreadSleeper.timed_wait(l, xt); -<a name="l00237"></a>00237 if (done) { -<a name="l00238"></a>00238 break; -<a name="l00239"></a>00239 } -<a name="l00240"></a>00240 -<a name="l00241"></a>00241 ApplicationMap::iterator appsIter; -<a name="l00242"></a>00242 time_t now = time(NULL); -<a name="l00243"></a>00243 for (appsIter = apps.begin(); appsIter != apps.end(); appsIter++) { -<a name="l00244"></a>00244 ApplicationList &appList(*appsIter->second); -<a name="l00245"></a>00245 ApplicationList::iterator listIter; -<a name="l00246"></a>00246 list<ApplicationList::iterator> elementsToRemove; -<a name="l00247"></a>00247 -<a name="l00248"></a>00248 for (listIter = appList.begin(); listIter != appList.end(); listIter++) { -<a name="l00249"></a>00249 <a class="code" href="classPassenger_1_1Application.html" title="Represents a single Ruby on Rails application instance.">Application</a> &app(**listIter); -<a name="l00250"></a>00250 if (now - app.<a class="code" href="classPassenger_1_1Application.html#58e74f6a598dbc16d87ce0a1bf8da1d6" title="Returns the last value set by setLastUsed().">getLastUsed</a>() > MAX_IDLE_TIME) { -<a name="l00251"></a>00251 P_TRACE("Cleaning idle app " << app.<a class="code" href="classPassenger_1_1Application.html#0a0665852e7ebc8fb8ab0772fa90bc56" title="Returns the application root for this RoR application.">getAppRoot</a>()); -<a name="l00252"></a>00252 elementsToRemove.push_back(listIter); -<a name="l00253"></a>00253 } -<a name="l00254"></a>00254 } -<a name="l00255"></a>00255 -<a name="l00256"></a>00256 list<ApplicationList::iterator>::iterator it; -<a name="l00257"></a>00257 for (it = elementsToRemove.begin(); it != elementsToRemove.end(); it++) { -<a name="l00258"></a>00258 appList.erase(*it); -<a name="l00259"></a>00259 } -<a name="l00260"></a>00260 } -<a name="l00261"></a>00261 } -<a name="l00262"></a>00262 } -<a name="l00263"></a>00263 -<a name="l00264"></a>00264 void detach() { -<a name="l00265"></a>00265 detached = true; -<a name="l00266"></a>00266 } -<a name="l00267"></a>00267 -<a name="l00268"></a>00268 public: -<a name="l00269"></a>00269 /** -<a name="l00270"></a>00270 * Create a new StandardApplicationPool object. -<a name="l00271"></a>00271 * -<a name="l00272"></a>00272 * @param spawnServerCommand The filename of the spawn server to use. -<a name="l00273"></a>00273 * @param logFile Specify a log file that the spawn server should use. -<a name="l00274"></a>00274 * Messages on its standard output and standard error channels -<a name="l00275"></a>00275 * will be written to this log file. If an empty string is -<a name="l00276"></a>00276 * specified, no log file will be used, and the spawn server -<a name="l00277"></a>00277 * will use the same standard output/error channels as the -<a name="l00278"></a>00278 * current process. -<a name="l00279"></a>00279 * @param environment The RAILS_ENV environment that all RoR applications -<a name="l00280"></a>00280 * should use. If an empty string is specified, the current value -<a name="l00281"></a>00281 * of the RAILS_ENV environment variable will be used. -<a name="l00282"></a>00282 * @param rubyCommand The Ruby interpreter's command. -<a name="l00283"></a>00283 * @throws SystemException An error occured while trying to setup the spawn server. -<a name="l00284"></a>00284 * @throws IOException The specified log file could not be opened. -<a name="l00285"></a>00285 */ -<a name="l00286"></a><a class="code" href="classPassenger_1_1StandardApplicationPool.html#de7c6e9dcaa37ac5640ed91fe0ac1bbc">00286</a> <a class="code" href="classPassenger_1_1StandardApplicationPool.html#de7c6e9dcaa37ac5640ed91fe0ac1bbc" title="Create a new StandardApplicationPool object.">StandardApplicationPool</a>(const string &spawnServerCommand, -<a name="l00287"></a>00287 const string &logFile = "", -<a name="l00288"></a>00288 const string &environment = "production", -<a name="l00289"></a>00289 const string &rubyCommand = "ruby") -<a name="l00290"></a>00290 : -<a name="l00291"></a>00291 #ifndef PASSENGER_USE_DUMMY_SPAWN_MANAGER -<a name="l00292"></a>00292 spawnManager(spawnServerCommand, logFile, environment, rubyCommand), -<a name="l00293"></a>00293 #endif -<a name="l00294"></a>00294 data(new SharedData()), -<a name="l00295"></a>00295 lock(data->lock), -<a name="l00296"></a>00296 countOrMaxChanged(data->countOrMaxChanged), -<a name="l00297"></a>00297 apps(data->apps), -<a name="l00298"></a>00298 max(data->max), -<a name="l00299"></a>00299 count(data->count), -<a name="l00300"></a>00300 active(data->active) -<a name="l00301"></a>00301 { -<a name="l00302"></a>00302 detached = false; -<a name="l00303"></a>00303 done = false; -<a name="l00304"></a>00304 max = 100; -<a name="l00305"></a>00305 count = 0; -<a name="l00306"></a>00306 active = 0; -<a name="l00307"></a>00307 cleanerThread = new thread(bind(&StandardApplicationPool::cleanerThreadMainLoop, this)); -<a name="l00308"></a>00308 } -<a name="l00309"></a>00309 -<a name="l00310"></a>00310 virtual ~<a class="code" href="classPassenger_1_1StandardApplicationPool.html" title="A standard implementation of ApplicationPool for single-process environments.">StandardApplicationPool</a>() { -<a name="l00311"></a>00311 if (!detached) { -<a name="l00312"></a>00312 { -<a name="l00313"></a>00313 mutex::scoped_lock l(lock); -<a name="l00314"></a>00314 done = true; -<a name="l00315"></a>00315 cleanerThreadSleeper.notify_one(); -<a name="l00316"></a>00316 } -<a name="l00317"></a>00317 cleanerThread->join(); -<a name="l00318"></a>00318 } -<a name="l00319"></a>00319 delete cleanerThread; -<a name="l00320"></a>00320 } -<a name="l00321"></a>00321 -<a name="l00322"></a>00322 virtual <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">Application::SessionPtr</a> -<a name="l00323"></a><a class="code" href="classPassenger_1_1StandardApplicationPool.html#cb338093c3368bf1cbcba02099c6c76e">00323</a> get(const string &appRoot, const string &user = "", const string &group = "") { -<a name="l00324"></a>00324 /* -<a name="l00325"></a>00325 * See "doc/ApplicationPool Algorithm.txt" for a more readable description -<a name="l00326"></a>00326 * of the algorithm. -<a name="l00327"></a>00327 */ -<a name="l00328"></a>00328 ApplicationPtr app; -<a name="l00329"></a>00329 mutex::scoped_lock l(lock); -<a name="l00330"></a>00330 -<a name="l00331"></a>00331 if (needsRestart(appRoot)) { -<a name="l00332"></a>00332 apps.erase(appRoot); -<a name="l00333"></a>00333 } -<a name="l00334"></a>00334 -<a name="l00335"></a>00335 ApplicationMap::iterator it(apps.find(appRoot)); -<a name="l00336"></a>00336 if (it != apps.end()) { -<a name="l00337"></a>00337 ApplicationList &appList(*it->second); -<a name="l00338"></a>00338 -<a name="l00339"></a>00339 if (appList.front()->getSessions() == 0) { -<a name="l00340"></a>00340 app = appList.front(); -<a name="l00341"></a>00341 appList.pop_front(); -<a name="l00342"></a>00342 appList.push_back(app); -<a name="l00343"></a>00343 active++; -<a name="l00344"></a>00344 } else if (count < max) { -<a name="l00345"></a>00345 app = spawnManager.<a class="code" href="classPassenger_1_1SpawnManager.html#5949f7eea4a6b4ef88d5f4ba5031cf1a" title="Spawn a new instance of a Ruby on Rails application.">spawn</a>(appRoot, user, group); -<a name="l00346"></a>00346 appList.push_back(app); -<a name="l00347"></a>00347 count++; -<a name="l00348"></a>00348 countOrMaxChanged.notify_all(); -<a name="l00349"></a>00349 active++; -<a name="l00350"></a>00350 } else { -<a name="l00351"></a>00351 app = appList.front(); -<a name="l00352"></a>00352 appList.pop_front(); -<a name="l00353"></a>00353 appList.push_back(app); -<a name="l00354"></a>00354 active++; -<a name="l00355"></a>00355 } -<a name="l00356"></a>00356 } else { -<a name="l00357"></a>00357 while (count >= max) { -<a name="l00358"></a>00358 countOrMaxChanged.wait(l); -<a name="l00359"></a>00359 } -<a name="l00360"></a>00360 app = spawnManager.<a class="code" href="classPassenger_1_1SpawnManager.html#5949f7eea4a6b4ef88d5f4ba5031cf1a" title="Spawn a new instance of a Ruby on Rails application.">spawn</a>(appRoot, user, group); -<a name="l00361"></a>00361 ApplicationListPtr appList(new ApplicationList()); -<a name="l00362"></a>00362 appList->push_back(app); -<a name="l00363"></a>00363 apps[appRoot] = appList; -<a name="l00364"></a>00364 count++; -<a name="l00365"></a>00365 countOrMaxChanged.notify_all(); -<a name="l00366"></a>00366 active++; -<a name="l00367"></a>00367 } -<a name="l00368"></a>00368 app->setLastUsed(time(NULL)); -<a name="l00369"></a>00369 return app->connect(SessionCloseCallback(data, app)); -<a name="l00370"></a>00370 } -<a name="l00371"></a>00371 -<a name="l00372"></a><a class="code" href="classPassenger_1_1StandardApplicationPool.html#04ef8c92da189520ad2022f4f82e9553">00372</a> virtual void <a class="code" href="classPassenger_1_1StandardApplicationPool.html#04ef8c92da189520ad2022f4f82e9553" title="Set a hard limit on the number of application instances that this ApplicationPool...">setMax</a>(unsigned int max) { -<a name="l00373"></a>00373 mutex::scoped_lock l(lock); -<a name="l00374"></a>00374 this->max = max; -<a name="l00375"></a>00375 countOrMaxChanged.notify_all(); -<a name="l00376"></a>00376 } -<a name="l00377"></a>00377 -<a name="l00378"></a><a class="code" href="classPassenger_1_1StandardApplicationPool.html#7773c4a3dfbd88eac72401d063831788">00378</a> virtual unsigned int <a class="code" href="classPassenger_1_1StandardApplicationPool.html#7773c4a3dfbd88eac72401d063831788" title="Get the number of active applications in the pool.">getActive</a>() const { -<a name="l00379"></a>00379 return active; -<a name="l00380"></a>00380 } -<a name="l00381"></a>00381 -<a name="l00382"></a><a class="code" href="classPassenger_1_1StandardApplicationPool.html#cdbfe2b9ffacdab4438c879c2411bf02">00382</a> virtual unsigned int <a class="code" href="classPassenger_1_1StandardApplicationPool.html#cdbfe2b9ffacdab4438c879c2411bf02" title="Get the number of active applications in the pool.">getCount</a>() const { -<a name="l00383"></a>00383 return count; -<a name="l00384"></a>00384 } -<a name="l00385"></a>00385 }; -<a name="l00386"></a>00386 -<a name="l00387"></a>00387 typedef shared_ptr<ApplicationPool> ApplicationPoolPtr; -<a name="l00388"></a>00388 -<a name="l00389"></a>00389 }; // namespace Passenger -<a name="l00390"></a>00390 -<a name="l00391"></a>00391 #endif /* _PASSENGER_APPLICATION_POOL_H_ */ -</pre></div><hr size="1"><address style="text-align: right;">Generated on Fri Feb 8 20:08:48 2008 for Passenger by  +<a name="l00128"></a>00128 virtual unsigned int <a class="code" href="classPassenger_1_1ApplicationPool.html#06d1eae044d4d761ce77cf09049df8c8" title="Get the number of active applications in the pool.">getActive</a>() const = 0; +<a name="l00129"></a>00129 +<a name="l00130"></a>00130 /** +<a name="l00131"></a>00131 * Get the number of active applications in the pool. +<a name="l00132"></a>00132 * +<a name="l00133"></a>00133 * This method exposes an implementation detail of the underlying pooling algorithm. +<a name="l00134"></a>00134 * It is used by unit tests to verify that the implementation is correct, +<a name="l00135"></a>00135 * and thus should not be called directly. +<a name="l00136"></a>00136 */ +<a name="l00137"></a>00137 virtual unsigned int <a class="code" href="classPassenger_1_1ApplicationPool.html#93b0277beb510855f85fee5de5c369bb" title="Get the number of active applications in the pool.">getCount</a>() const = 0; +<a name="l00138"></a>00138 }; +<a name="l00139"></a>00139 +<a name="l00140"></a>00140 class <a class="code" href="classPassenger_1_1ApplicationPoolServer.html" title="Multi-process usage support for ApplicationPool.">ApplicationPoolServer</a>; +<a name="l00141"></a>00141 +<a name="l00142"></a>00142 /** +<a name="l00143"></a>00143 * A standard implementation of ApplicationPool for single-process environments. +<a name="l00144"></a>00144 * +<a name="l00145"></a>00145 * The environment may or may not be multithreaded - StandardApplicationPool is completely +<a name="l00146"></a>00146 * thread-safe. Apache with the threading MPM is an example of a multithreaded single-process +<a name="l00147"></a>00147 * environment. +<a name="l00148"></a>00148 * +<a name="l00149"></a>00149 * This class is unusable in multi-process environments such as Apache with the prefork MPM. +<a name="l00150"></a>00150 * The reasons are as follows: +<a name="l00151"></a>00151 * - StandardApplicationPool uses threads internally. Because threads disappear after a fork(), +<a name="l00152"></a>00152 * a StandardApplicationPool object will become unusable after a fork(). +<a name="l00153"></a>00153 * - StandardApplicationPool stores its internal cache on the heap. Different processes +<a name="l00154"></a>00154 * cannot share their heaps, so they will not be able to access each others' pool cache. +<a name="l00155"></a>00155 * - StandardApplicationPool has a connection to the spawn server. If there are multiple +<a name="l00156"></a>00156 * processes, and they all use the spawn servers's connection at the same time without +<a name="l00157"></a>00157 * some sort of synchronization, then bad things will happen. +<a name="l00158"></a>00158 * +<a name="l00159"></a>00159 * (Of course, StandardApplicationPool is usable if each process creates its own +<a name="l00160"></a>00160 * StandardApplicationPool object, but that would defeat the point of having a shared pool.) +<a name="l00161"></a>00161 * +<a name="l00162"></a>00162 * For multi-process environments, one should use ApplicationPoolServer instead. +<a name="l00163"></a>00163 * +<a name="l00164"></a>00164 * @ingroup Support +<a name="l00165"></a>00165 */ +<a name="l00166"></a><a class="code" href="classPassenger_1_1StandardApplicationPool.html">00166</a> class <a class="code" href="classPassenger_1_1StandardApplicationPool.html" title="A standard implementation of ApplicationPool for single-process environments.">StandardApplicationPool</a>: public <a class="code" href="classPassenger_1_1ApplicationPool.html" title="A persistent pool of Applications.">ApplicationPool</a> { +<a name="l00167"></a>00167 private: +<a name="l00168"></a>00168 static const int CLEAN_INTERVAL = 62; +<a name="l00169"></a>00169 static const int MAX_IDLE_TIME = 60; +<a name="l00170"></a>00170 +<a name="l00171"></a>00171 friend class <a class="code" href="classPassenger_1_1ApplicationPoolServer.html" title="Multi-process usage support for ApplicationPool.">ApplicationPoolServer</a>; +<a name="l00172"></a>00172 +<a name="l00173"></a>00173 typedef list<ApplicationPtr> ApplicationList; +<a name="l00174"></a>00174 typedef shared_ptr<ApplicationList> ApplicationListPtr; +<a name="l00175"></a>00175 typedef map<string, ApplicationListPtr> ApplicationMap; +<a name="l00176"></a>00176 +<a name="l00177"></a>00177 struct SharedData { +<a name="l00178"></a>00178 mutex lock; +<a name="l00179"></a>00179 condition countOrMaxChanged; +<a name="l00180"></a>00180 +<a name="l00181"></a>00181 ApplicationMap apps; +<a name="l00182"></a>00182 unsigned int max; +<a name="l00183"></a>00183 unsigned int count; +<a name="l00184"></a>00184 unsigned int active; +<a name="l00185"></a>00185 }; +<a name="l00186"></a>00186 +<a name="l00187"></a>00187 typedef shared_ptr<SharedData> SharedDataPtr; +<a name="l00188"></a>00188 +<a name="l00189"></a>00189 struct SessionCloseCallback { +<a name="l00190"></a>00190 SharedDataPtr data; +<a name="l00191"></a>00191 weak_ptr<Application> app; +<a name="l00192"></a>00192 +<a name="l00193"></a>00193 SessionCloseCallback(SharedDataPtr data, weak_ptr<Application> app) { +<a name="l00194"></a>00194 this->data = data; +<a name="l00195"></a>00195 this->app = app; +<a name="l00196"></a>00196 } +<a name="l00197"></a>00197 +<a name="l00198"></a>00198 void operator()(<a class="code" href="classPassenger_1_1Application_1_1Session.html" title="Represents the life time of a single request/response pair of a Ruby on Rails application...">Application::Session</a> &session) { +<a name="l00199"></a>00199 mutex::scoped_lock l(data->lock); +<a name="l00200"></a>00200 ApplicationPtr app(this->app.lock()); +<a name="l00201"></a>00201 +<a name="l00202"></a>00202 if (app != NULL) { +<a name="l00203"></a>00203 ApplicationMap::iterator it(data->apps.find(app->getAppRoot())); +<a name="l00204"></a>00204 if (it != data->apps.end()) { +<a name="l00205"></a>00205 if (app->getSessions() == 0) { +<a name="l00206"></a>00206 // TODO: make this operation constant time +<a name="l00207"></a>00207 it->second->remove(app); +<a name="l00208"></a>00208 it->second->push_front(app); +<a name="l00209"></a>00209 } +<a name="l00210"></a>00210 data->active--; +<a name="l00211"></a>00211 } +<a name="l00212"></a>00212 app->setLastUsed(time(NULL)); +<a name="l00213"></a>00213 } +<a name="l00214"></a>00214 } +<a name="l00215"></a>00215 }; +<a name="l00216"></a>00216 +<a name="l00217"></a>00217 #ifdef PASSENGER_USE_DUMMY_SPAWN_MANAGER +<a name="l00218"></a>00218 <a class="code" href="classPassenger_1_1DummySpawnManager.html" title="A dummy SpawnManager replacement for testing/debugging purposes.">DummySpawnManager</a> spawnManager; +<a name="l00219"></a>00219 #else +<a name="l00220"></a>00220 <a class="code" href="classPassenger_1_1SpawnManager.html">SpawnManager</a> spawnManager; +<a name="l00221"></a>00221 #endif +<a name="l00222"></a>00222 SharedDataPtr data; +<a name="l00223"></a>00223 thread *cleanerThread; +<a name="l00224"></a>00224 bool detached; +<a name="l00225"></a>00225 bool done; +<a name="l00226"></a>00226 condition cleanerThreadSleeper; +<a name="l00227"></a>00227 +<a name="l00228"></a>00228 mutex &lock; +<a name="l00229"></a>00229 condition &countOrMaxChanged; +<a name="l00230"></a>00230 ApplicationMap &apps; +<a name="l00231"></a>00231 unsigned int &max; +<a name="l00232"></a>00232 unsigned int &count; +<a name="l00233"></a>00233 unsigned int &active; +<a name="l00234"></a>00234 +<a name="l00235"></a>00235 bool needsRestart(const string &appRoot) const { +<a name="l00236"></a>00236 return false; +<a name="l00237"></a>00237 } +<a name="l00238"></a>00238 +<a name="l00239"></a>00239 void cleanerThreadMainLoop() { +<a name="l00240"></a>00240 mutex::scoped_lock l(lock); +<a name="l00241"></a>00241 while (!done) { +<a name="l00242"></a>00242 xtime xt; +<a name="l00243"></a>00243 xtime_get(&xt, TIME_UTC); +<a name="l00244"></a>00244 xt.sec += CLEAN_INTERVAL; +<a name="l00245"></a>00245 cleanerThreadSleeper.timed_wait(l, xt); +<a name="l00246"></a>00246 if (done) { +<a name="l00247"></a>00247 break; +<a name="l00248"></a>00248 } +<a name="l00249"></a>00249 +<a name="l00250"></a>00250 ApplicationMap::iterator appsIter; +<a name="l00251"></a>00251 time_t now = time(NULL); +<a name="l00252"></a>00252 list<string> appRootsToRemove; +<a name="l00253"></a>00253 +<a name="l00254"></a>00254 for (appsIter = apps.begin(); appsIter != apps.end(); appsIter++) { +<a name="l00255"></a>00255 ApplicationList &appList(*appsIter->second); +<a name="l00256"></a>00256 ApplicationList::iterator listIter; +<a name="l00257"></a>00257 list<ApplicationList::iterator> elementsToRemove; +<a name="l00258"></a>00258 +<a name="l00259"></a>00259 for (listIter = appList.begin(); listIter != appList.end(); listIter++) { +<a name="l00260"></a>00260 <a class="code" href="classPassenger_1_1Application.html" title="Represents a single Ruby on Rails application instance.">Application</a> &app(**listIter); +<a name="l00261"></a>00261 if (now - app.<a class="code" href="classPassenger_1_1Application.html#58e74f6a598dbc16d87ce0a1bf8da1d6" title="Returns the last value set by setLastUsed().">getLastUsed</a>() > MAX_IDLE_TIME) { +<a name="l00262"></a>00262 P_TRACE("Cleaning idle app " << app.<a class="code" href="classPassenger_1_1Application.html#0a0665852e7ebc8fb8ab0772fa90bc56" title="Returns the application root for this RoR application.">getAppRoot</a>()); +<a name="l00263"></a>00263 elementsToRemove.push_back(listIter); +<a name="l00264"></a>00264 } +<a name="l00265"></a>00265 } +<a name="l00266"></a>00266 +<a name="l00267"></a>00267 list<ApplicationList::iterator>::iterator it; +<a name="l00268"></a>00268 for (it = elementsToRemove.begin(); it != elementsToRemove.end(); it++) { +<a name="l00269"></a>00269 appList.erase(*it); +<a name="l00270"></a>00270 } +<a name="l00271"></a>00271 if (appList.empty()) { +<a name="l00272"></a>00272 appRootsToRemove.push_back(appsIter->first); +<a name="l00273"></a>00273 } +<a name="l00274"></a>00274 } +<a name="l00275"></a>00275 +<a name="l00276"></a>00276 list<string>::const_iterator it; +<a name="l00277"></a>00277 for (it = appRootsToRemove.begin(); it != appRootsToRemove.end(); it++) { +<a name="l00278"></a>00278 apps.erase(*it); +<a name="l00279"></a>00279 } +<a name="l00280"></a>00280 } +<a name="l00281"></a>00281 } +<a name="l00282"></a>00282 +<a name="l00283"></a>00283 void detach() { +<a name="l00284"></a>00284 detached = true; +<a name="l00285"></a>00285 } +<a name="l00286"></a>00286 +<a name="l00287"></a>00287 void handleConnectException(const exception &e, const ApplicationPtr &app, +<a name="l00288"></a>00288 ApplicationList &appList) { +<a name="l00289"></a>00289 string message("Cannot connect to an existing application instance for '"); +<a name="l00290"></a>00290 message.append(app->getAppRoot()); +<a name="l00291"></a>00291 message.append("': "); +<a name="l00292"></a>00292 message.append(e.what()); +<a name="l00293"></a>00293 appList.remove(app); +<a name="l00294"></a>00294 if (appList.empty()) { +<a name="l00295"></a>00295 apps.erase(app->getAppRoot()); +<a name="l00296"></a>00296 } +<a name="l00297"></a>00297 count--; +<a name="l00298"></a>00298 active--; +<a name="l00299"></a>00299 throw <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(message); +<a name="l00300"></a>00300 } +<a name="l00301"></a>00301 +<a name="l00302"></a>00302 public: +<a name="l00303"></a>00303 /** +<a name="l00304"></a>00304 * Create a new StandardApplicationPool object. +<a name="l00305"></a>00305 * +<a name="l00306"></a>00306 * @param spawnServerCommand The filename of the spawn server to use. +<a name="l00307"></a>00307 * @param logFile Specify a log file that the spawn server should use. +<a name="l00308"></a>00308 * Messages on its standard output and standard error channels +<a name="l00309"></a>00309 * will be written to this log file. If an empty string is +<a name="l00310"></a>00310 * specified, no log file will be used, and the spawn server +<a name="l00311"></a>00311 * will use the same standard output/error channels as the +<a name="l00312"></a>00312 * current process. +<a name="l00313"></a>00313 * @param environment The RAILS_ENV environment that all RoR applications +<a name="l00314"></a>00314 * should use. If an empty string is specified, the current value +<a name="l00315"></a>00315 * of the RAILS_ENV environment variable will be used. +<a name="l00316"></a>00316 * @param rubyCommand The Ruby interpreter's command. +<a name="l00317"></a>00317 * @throws SystemException An error occured while trying to setup the spawn server. +<a name="l00318"></a>00318 * @throws IOException The specified log file could not be opened. +<a name="l00319"></a>00319 */ +<a name="l00320"></a><a class="code" href="classPassenger_1_1StandardApplicationPool.html#de7c6e9dcaa37ac5640ed91fe0ac1bbc">00320</a> <a class="code" href="classPassenger_1_1StandardApplicationPool.html#de7c6e9dcaa37ac5640ed91fe0ac1bbc" title="Create a new StandardApplicationPool object.">StandardApplicationPool</a>(const string &spawnServerCommand, +<a name="l00321"></a>00321 const string &logFile = "", +<a name="l00322"></a>00322 const string &environment = "production", +<a name="l00323"></a>00323 const string &rubyCommand = "ruby") +<a name="l00324"></a>00324 : +<a name="l00325"></a>00325 #ifndef PASSENGER_USE_DUMMY_SPAWN_MANAGER +<a name="l00326"></a>00326 spawnManager(spawnServerCommand, logFile, environment, rubyCommand), +<a name="l00327"></a>00327 #endif +<a name="l00328"></a>00328 data(new SharedData()), +<a name="l00329"></a>00329 lock(data->lock), +<a name="l00330"></a>00330 countOrMaxChanged(data->countOrMaxChanged), +<a name="l00331"></a>00331 apps(data->apps), +<a name="l00332"></a>00332 max(data->max), +<a name="l00333"></a>00333 count(data->count), +<a name="l00334"></a>00334 active(data->active) +<a name="l00335"></a>00335 { +<a name="l00336"></a>00336 detached = false; +<a name="l00337"></a>00337 done = false; +<a name="l00338"></a>00338 max = 100; +<a name="l00339"></a>00339 count = 0; +<a name="l00340"></a>00340 active = 0; +<a name="l00341"></a>00341 cleanerThread = new thread(bind(&StandardApplicationPool::cleanerThreadMainLoop, this)); +<a name="l00342"></a>00342 } +<a name="l00343"></a>00343 +<a name="l00344"></a>00344 virtual ~<a class="code" href="classPassenger_1_1StandardApplicationPool.html" title="A standard implementation of ApplicationPool for single-process environments.">StandardApplicationPool</a>() { +<a name="l00345"></a>00345 if (!detached) { +<a name="l00346"></a>00346 { +<a name="l00347"></a>00347 mutex::scoped_lock l(lock); +<a name="l00348"></a>00348 done = true; +<a name="l00349"></a>00349 cleanerThreadSleeper.notify_one(); +<a name="l00350"></a>00350 } +<a name="l00351"></a>00351 cleanerThread->join(); +<a name="l00352"></a>00352 } +<a name="l00353"></a>00353 delete cleanerThread; +<a name="l00354"></a>00354 } +<a name="l00355"></a>00355 +<a name="l00356"></a>00356 virtual <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">Application::SessionPtr</a> +<a name="l00357"></a><a class="code" href="classPassenger_1_1StandardApplicationPool.html#cb338093c3368bf1cbcba02099c6c76e">00357</a> get(const string &appRoot, const string &user = "", const string &group = "") { +<a name="l00358"></a>00358 /* +<a name="l00359"></a>00359 * See "doc/ApplicationPool Algorithm.txt" for a more readable description +<a name="l00360"></a>00360 * of the algorithm. +<a name="l00361"></a>00361 */ +<a name="l00362"></a>00362 ApplicationPtr app; +<a name="l00363"></a>00363 ApplicationList *appList; +<a name="l00364"></a>00364 mutex::scoped_lock l(lock); +<a name="l00365"></a>00365 +<a name="l00366"></a>00366 if (needsRestart(appRoot)) { +<a name="l00367"></a>00367 apps.erase(appRoot); +<a name="l00368"></a>00368 } +<a name="l00369"></a>00369 +<a name="l00370"></a>00370 try { +<a name="l00371"></a>00371 ApplicationMap::iterator it(apps.find(appRoot)); +<a name="l00372"></a>00372 if (it != apps.end()) { +<a name="l00373"></a>00373 appList = it->second.get(); +<a name="l00374"></a>00374 +<a name="l00375"></a>00375 if (appList->front()->getSessions() == 0) { +<a name="l00376"></a>00376 app = appList->front(); +<a name="l00377"></a>00377 appList->pop_front(); +<a name="l00378"></a>00378 appList->push_back(app); +<a name="l00379"></a>00379 active++; +<a name="l00380"></a>00380 } else if (count < max) { +<a name="l00381"></a>00381 app = spawnManager.<a class="code" href="classPassenger_1_1SpawnManager.html#5949f7eea4a6b4ef88d5f4ba5031cf1a" title="Spawn a new instance of a Ruby on Rails application.">spawn</a>(appRoot, user, group); +<a name="l00382"></a>00382 appList->push_back(app); +<a name="l00383"></a>00383 count++; +<a name="l00384"></a>00384 countOrMaxChanged.notify_all(); +<a name="l00385"></a>00385 active++; +<a name="l00386"></a>00386 } else { +<a name="l00387"></a>00387 app = appList->front(); +<a name="l00388"></a>00388 appList->pop_front(); +<a name="l00389"></a>00389 appList->push_back(app); +<a name="l00390"></a>00390 active++; +<a name="l00391"></a>00391 } +<a name="l00392"></a>00392 } else { +<a name="l00393"></a>00393 while (count >= max) { +<a name="l00394"></a>00394 countOrMaxChanged.wait(l); +<a name="l00395"></a>00395 } +<a name="l00396"></a>00396 app = spawnManager.<a class="code" href="classPassenger_1_1SpawnManager.html#5949f7eea4a6b4ef88d5f4ba5031cf1a" title="Spawn a new instance of a Ruby on Rails application.">spawn</a>(appRoot, user, group); +<a name="l00397"></a>00397 appList = new ApplicationList(); +<a name="l00398"></a>00398 appList->push_back(app); +<a name="l00399"></a>00399 apps[appRoot] = <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(appList); +<a name="l00400"></a>00400 count++; +<a name="l00401"></a>00401 countOrMaxChanged.notify_all(); +<a name="l00402"></a>00402 active++; +<a name="l00403"></a>00403 } +<a name="l00404"></a>00404 } catch (const <a class="code" href="classPassenger_1_1SpawnException.html" title="Thrown when SpawnManager or ApplicationPool fail to spawn an application instance...">SpawnException</a> &e) { +<a name="l00405"></a>00405 string message("Cannot spawn application '"); +<a name="l00406"></a>00406 message.append(appRoot); +<a name="l00407"></a>00407 message.append("': "); +<a name="l00408"></a>00408 message.append(e.<a class="code" href="classPassenger_1_1SpawnException.html#d2da180f89a43423a4b37248249972ff">what</a>()); +<a name="l00409"></a>00409 throw <a class="code" href="classPassenger_1_1SpawnException.html" title="Thrown when SpawnManager or ApplicationPool fail to spawn an application instance...">SpawnException</a>(message); +<a name="l00410"></a>00410 } +<a name="l00411"></a>00411 +<a name="l00412"></a>00412 app->setLastUsed(time(NULL)); +<a name="l00413"></a>00413 +<a name="l00414"></a>00414 // TODO: This should not just throw an exception. +<a name="l00415"></a>00415 // If we fail to connect to one application we should just use another, or +<a name="l00416"></a>00416 // spawn a new application. Of course, this must not be done too often +<a name="l00417"></a>00417 // because every app might crash at startup. There should be a limit +<a name="l00418"></a>00418 // to the number of retries. +<a name="l00419"></a>00419 try { +<a name="l00420"></a>00420 return app->connect(SessionCloseCallback(data, app)); +<a name="l00421"></a>00421 } catch (const <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a> &e) { +<a name="l00422"></a>00422 handleConnectException(e, app, *appList); +<a name="l00423"></a>00423 // Never reached; shut up compiler warning +<a name="l00424"></a>00424 return <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">Application::SessionPtr</a>(); +<a name="l00425"></a>00425 } catch (const <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &e) { +<a name="l00426"></a>00426 handleConnectException(e, app, *appList); +<a name="l00427"></a>00427 // Never reached; shut up compiler warning +<a name="l00428"></a>00428 return <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">Application::SessionPtr</a>(); +<a name="l00429"></a>00429 } +<a name="l00430"></a>00430 } +<a name="l00431"></a>00431 +<a name="l00432"></a><a class="code" href="classPassenger_1_1StandardApplicationPool.html#04ef8c92da189520ad2022f4f82e9553">00432</a> virtual void <a class="code" href="classPassenger_1_1StandardApplicationPool.html#04ef8c92da189520ad2022f4f82e9553" title="Set a hard limit on the number of application instances that this ApplicationPool...">setMax</a>(unsigned int max) { +<a name="l00433"></a>00433 mutex::scoped_lock l(lock); +<a name="l00434"></a>00434 this->max = max; +<a name="l00435"></a>00435 countOrMaxChanged.notify_all(); +<a name="l00436"></a>00436 } +<a name="l00437"></a>00437 +<a name="l00438"></a><a class="code" href="classPassenger_1_1StandardApplicationPool.html#7773c4a3dfbd88eac72401d063831788">00438</a> virtual unsigned int <a class="code" href="classPassenger_1_1StandardApplicationPool.html#7773c4a3dfbd88eac72401d063831788" title="Get the number of active applications in the pool.">getActive</a>() const { +<a name="l00439"></a>00439 return active; +<a name="l00440"></a>00440 } +<a name="l00441"></a>00441 +<a name="l00442"></a><a class="code" href="classPassenger_1_1StandardApplicationPool.html#cdbfe2b9ffacdab4438c879c2411bf02">00442</a> virtual unsigned int <a class="code" href="classPassenger_1_1StandardApplicationPool.html#cdbfe2b9ffacdab4438c879c2411bf02" title="Get the number of active applications in the pool.">getCount</a>() const { +<a name="l00443"></a>00443 return count; +<a name="l00444"></a>00444 } +<a name="l00445"></a>00445 }; +<a name="l00446"></a>00446 +<a name="l00447"></a>00447 typedef shared_ptr<ApplicationPool> ApplicationPoolPtr; +<a name="l00448"></a>00448 +<a name="l00449"></a>00449 }; // namespace Passenger +<a name="l00450"></a>00450 +<a name="l00451"></a>00451 #endif /* _PASSENGER_APPLICATION_POOL_H_ */ +</pre></div><hr size="1"><address style="text-align: right;">Generated on Fri Feb 22 10:18:25 2008 for Passenger by  <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </address> </body> doc/cxxapi/ApplicationPool_8h-source.html @@ -169,227 +169,240 @@ <a name="l00154"></a>00154 * Close the writer channel. This method may be safely called multiple times. <a name="l00155"></a>00155 */ <a name="l00156"></a>00156 virtual void <a class="code" href="classPassenger_1_1Application_1_1Session.html#ecaa3575efd70130a4adfec203120d74" title="Close the writer channel.">closeWriter</a>() = 0; -<a name="l00157"></a>00157 }; -<a name="l00158"></a>00158 -<a name="l00159"></a>00159 private: -<a name="l00160"></a>00160 /** -<a name="l00161"></a>00161 * A structure containing data that both StandardSession and Application -<a name="l00162"></a>00162 * may access. Since Application and StandardSession may have different -<a name="l00163"></a>00163 * life times (i.e. one can be destroyed before the other), they both -<a name="l00164"></a>00164 * have a smart pointer referencing a SharedData structure. Only -<a name="l00165"></a>00165 * when both the StandardSession and the Application object have been -<a name="l00166"></a>00166 * destroyed, will the SharedData object be destroyed as well. -<a name="l00167"></a>00167 */ -<a name="l00168"></a>00168 struct SharedData { -<a name="l00169"></a>00169 unsigned int sessions; -<a name="l00170"></a>00170 }; -<a name="l00171"></a>00171 -<a name="l00172"></a>00172 typedef shared_ptr<SharedData> SharedDataPtr; -<a name="l00173"></a>00173 -<a name="l00174"></a>00174 /** -<a name="l00175"></a>00175 * A "standard" implementation of Session. -<a name="l00176"></a>00176 */ -<a name="l00177"></a>00177 class StandardSession: public Session { -<a name="l00178"></a>00178 protected: -<a name="l00179"></a>00179 SharedDataPtr data; -<a name="l00180"></a>00180 <a class="code" href="classPassenger_1_1Application.html#a904ba56a6b0413f8da245a762cd681e" title="A type for callback functions that are called when a session is closed.">CloseCallback</a> closeCallback; -<a name="l00181"></a>00181 int reader; -<a name="l00182"></a>00182 int writer; -<a name="l00183"></a>00183 -<a name="l00184"></a>00184 public: -<a name="l00185"></a>00185 StandardSession(SharedDataPtr data, const <a class="code" href="classPassenger_1_1Application.html#a904ba56a6b0413f8da245a762cd681e" title="A type for callback functions that are called when a session is closed.">CloseCallback</a> &closeCallback, int reader, int writer) { -<a name="l00186"></a>00186 this->data = data; -<a name="l00187"></a>00187 this->closeCallback = closeCallback; -<a name="l00188"></a>00188 data->sessions++; -<a name="l00189"></a>00189 this->reader = reader; -<a name="l00190"></a>00190 this->writer = writer; -<a name="l00191"></a>00191 } -<a name="l00192"></a>00192 -<a name="l00193"></a>00193 virtual ~StandardSession() { -<a name="l00194"></a>00194 data->sessions--; -<a name="l00195"></a>00195 closeReader(); -<a name="l00196"></a>00196 closeWriter(); -<a name="l00197"></a>00197 closeCallback(*this); -<a name="l00198"></a>00198 } -<a name="l00199"></a>00199 -<a name="l00200"></a>00200 virtual int getReader() { -<a name="l00201"></a>00201 return reader; -<a name="l00202"></a>00202 } -<a name="l00203"></a>00203 -<a name="l00204"></a>00204 virtual void closeReader() { -<a name="l00205"></a>00205 if (reader != -1) { -<a name="l00206"></a>00206 close(reader); -<a name="l00207"></a>00207 reader = -1; -<a name="l00208"></a>00208 } -<a name="l00209"></a>00209 } -<a name="l00210"></a>00210 -<a name="l00211"></a>00211 virtual int getWriter() { -<a name="l00212"></a>00212 return writer; -<a name="l00213"></a>00213 } -<a name="l00214"></a>00214 -<a name="l00215"></a>00215 virtual void closeWriter() { -<a name="l00216"></a>00216 if (writer != -1) { -<a name="l00217"></a>00217 close(writer); -<a name="l00218"></a>00218 writer = -1; -<a name="l00219"></a>00219 } -<a name="l00220"></a>00220 } -<a name="l00221"></a>00221 }; -<a name="l00222"></a>00222 -<a name="l00223"></a>00223 string appRoot; -<a name="l00224"></a>00224 pid_t pid; -<a name="l00225"></a>00225 int listenSocket; -<a name="l00226"></a>00226 time_t lastUsed; -<a name="l00227"></a>00227 SharedDataPtr data; -<a name="l00228"></a>00228 -<a name="l00229"></a>00229 public: -<a name="l00230"></a>00230 /** -<a name="l00231"></a>00231 * Construct a new Application object. -<a name="l00232"></a>00232 * -<a name="l00233"></a>00233 * @param theAppRoot The application root of a RoR application, i.e. the folder that -<a name="l00234"></a>00234 * contains 'app/', 'public/', 'config/', etc. This must be a valid directory, -<a name="l00235"></a>00235 * but the path does not have to be absolute. -<a name="l00236"></a>00236 * @param pid The process ID of this application instance. -<a name="l00237"></a>00237 * @param listenSocket The listener socket of this application instance. -<a name="l00238"></a>00238 * @post getAppRoot() == theAppRoot && getPid() == pid -<a name="l00239"></a>00239 */ -<a name="l00240"></a><a class="code" href="classPassenger_1_1Application.html#2504cb46b625c1b4c5344cae944b633d">00240</a> <a class="code" href="classPassenger_1_1Application.html#2504cb46b625c1b4c5344cae944b633d" title="Construct a new Application object.">Application</a>(const string &theAppRoot, pid_t pid, int listenSocket) { -<a name="l00241"></a>00241 appRoot = theAppRoot; -<a name="l00242"></a>00242 this->pid = pid; -<a name="l00243"></a>00243 this->listenSocket = listenSocket; -<a name="l00244"></a>00244 lastUsed = time(NULL); -<a name="l00245"></a>00245 this->data = ptr(new SharedData()); -<a name="l00246"></a>00246 this->data->sessions = 0; -<a name="l00247"></a>00247 P_TRACE("Application " << this << ": created."); -<a name="l00248"></a>00248 } -<a name="l00249"></a>00249 -<a name="l00250"></a>00250 virtual ~<a class="code" href="classPassenger_1_1Application.html" title="Represents a single Ruby on Rails application instance.">Application</a>() { -<a name="l00251"></a>00251 close(listenSocket); -<a name="l00252"></a>00252 P_TRACE("Application " << this << ": destroyed."); -<a name="l00253"></a>00253 } -<a name="l00254"></a>00254 -<a name="l00255"></a>00255 /** -<a name="l00256"></a>00256 * Returns the application root for this RoR application. See the constructor -<a name="l00257"></a>00257 * for information about the application root. -<a name="l00258"></a>00258 */ -<a name="l00259"></a><a class="code" href="classPassenger_1_1Application.html#0a0665852e7ebc8fb8ab0772fa90bc56">00259</a> string <a class="code" href="classPassenger_1_1Application.html#0a0665852e7ebc8fb8ab0772fa90bc56" title="Returns the application root for this RoR application.">getAppRoot</a>() const { -<a name="l00260"></a>00260 return appRoot; -<a name="l00261"></a>00261 } -<a name="l00262"></a>00262 -<a name="l00263"></a>00263 /** -<a name="l00264"></a>00264 * Returns the process ID of this application instance. -<a name="l00265"></a>00265 */ -<a name="l00266"></a><a class="code" href="classPassenger_1_1Application.html#94d2cce1c2c1d3441325f1498a22bf02">00266</a> pid_t <a class="code" href="classPassenger_1_1Application.html#94d2cce1c2c1d3441325f1498a22bf02" title="Returns the process ID of this application instance.">getPid</a>() const { -<a name="l00267"></a>00267 return pid; -<a name="l00268"></a>00268 } -<a name="l00269"></a>00269 -<a name="l00270"></a>00270 /** -<a name="l00271"></a>00271 * Connect to this application instance with the purpose of sending -<a name="l00272"></a>00272 * a request to the application. Once connected, a new session will -<a name="l00273"></a>00273 * be opened. This session represents the life time of a single -<a name="l00274"></a>00274 * request/response pair, and can be used to send the request -<a name="l00275"></a>00275 * data to the application instance, as well as receiving the response -<a name="l00276"></a>00276 * data. -<a name="l00277"></a>00277 * -<a name="l00278"></a>00278 * The use of connect() is demonstrated in the following example. -<a name="l00279"></a>00279 * @code -<a name="l00280"></a>00280 * // Connect to the application and get the newly opened session. -<a name="l00281"></a>00281 * Application::SessionPtr session(app->connect("/home/webapps/foo")); -<a name="l00282"></a>00282 * -<a name="l00283"></a>00283 * // Send the request headers and request body data. -<a name="l00284"></a>00284 * session->sendHeaders(...); -<a name="l00285"></a>00285 * session->sendBodyBlock(...); -<a name="l00286"></a>00286 * // Done sending data, so we close the writer channel. -<a name="l00287"></a>00287 * session->closeWriter(); -<a name="l00288"></a>00288 * -<a name="l00289"></a>00289 * // Now read the HTTP response. -<a name="l00290"></a>00290 * string responseData = readAllDataFromSocket(session->getReader()); -<a name="l00291"></a>00291 * // Done reading data, so we close the reader channel. -<a name="l00292"></a>00292 * session->closeReader(); -<a name="l00293"></a>00293 * -<a name="l00294"></a>00294 * // This session has now finished, so we close the session by resetting -<a name="l00295"></a>00295 * // the smart pointer to NULL (thereby destroying the Session object). -<a name="l00296"></a>00296 * session.reset(); -<a name="l00297"></a>00297 * -<a name="l00298"></a>00298 * // We can connect to an Application multiple times. Just make sure -<a name="l00299"></a>00299 * // the previous session is closed. -<a name="l00300"></a>00300 * session = app->connect("/home/webapps/bar") -<a name="l00301"></a>00301 * @endcode -<a name="l00302"></a>00302 * -<a name="l00303"></a>00303 * Note that a RoR application instance can only process one -<a name="l00304"></a>00304 * request at the same time, and thus only one session at the same time. -<a name="l00305"></a>00305 * You must close a session when you no longer need if. You you -<a name="l00306"></a>00306 * call connect() without having properly closed a previous session, -<a name="l00307"></a>00307 * you might cause a deadlock because the application instance may be -<a name="l00308"></a>00308 * waiting for you to close the previous session. +<a name="l00157"></a>00157 +<a name="l00158"></a>00158 /** +<a name="l00159"></a>00159 * Get the process ID of the application instance that belongs to this session. +<a name="l00160"></a>00160 */ +<a name="l00161"></a>00161 virtual pid_t <a class="code" href="classPassenger_1_1Application_1_1Session.html#329fd8a1def4fda5a1497c3a488060b0" title="Get the process ID of the application instance that belongs to this session.">getPid</a>() = 0; +<a name="l00162"></a>00162 }; +<a name="l00163"></a>00163 +<a name="l00164"></a>00164 private: +<a name="l00165"></a>00165 /** +<a name="l00166"></a>00166 * A structure containing data that both StandardSession and Application +<a name="l00167"></a>00167 * may access. Since Application and StandardSession may have different +<a name="l00168"></a>00168 * life times (i.e. one can be destroyed before the other), they both +<a name="l00169"></a>00169 * have a smart pointer referencing a SharedData structure. Only +<a name="l00170"></a>00170 * when both the StandardSession and the Application object have been +<a name="l00171"></a>00171 * destroyed, will the SharedData object be destroyed as well. +<a name="l00172"></a>00172 */ +<a name="l00173"></a>00173 struct SharedData { +<a name="l00174"></a>00174 unsigned int sessions; +<a name="l00175"></a>00175 }; +<a name="l00176"></a>00176 +<a name="l00177"></a>00177 typedef shared_ptr<SharedData> SharedDataPtr; +<a name="l00178"></a>00178 +<a name="l00179"></a>00179 /** +<a name="l00180"></a>00180 * A "standard" implementation of Session. +<a name="l00181"></a>00181 */ +<a name="l00182"></a>00182 class StandardSession: public Session { +<a name="l00183"></a>00183 protected: +<a name="l00184"></a>00184 SharedDataPtr data; +<a name="l00185"></a>00185 <a class="code" href="classPassenger_1_1Application.html#a904ba56a6b0413f8da245a762cd681e" title="A type for callback functions that are called when a session is closed.">CloseCallback</a> closeCallback; +<a name="l00186"></a>00186 int reader; +<a name="l00187"></a>00187 int writer; +<a name="l00188"></a>00188 pid_t pid; +<a name="l00189"></a>00189 +<a name="l00190"></a>00190 public: +<a name="l00191"></a>00191 StandardSession(SharedDataPtr data, pid_t pid, const <a class="code" href="classPassenger_1_1Application.html#a904ba56a6b0413f8da245a762cd681e" title="A type for callback functions that are called when a session is closed.">CloseCallback</a> &closeCallback, +<a name="l00192"></a>00192 int reader, int writer) { +<a name="l00193"></a>00193 this->data = data; +<a name="l00194"></a>00194 this->pid = pid; +<a name="l00195"></a>00195 this->closeCallback = closeCallback; +<a name="l00196"></a>00196 data->sessions++; +<a name="l00197"></a>00197 this->reader = reader; +<a name="l00198"></a>00198 this->writer = writer; +<a name="l00199"></a>00199 } +<a name="l00200"></a>00200 +<a name="l00201"></a>00201 virtual ~StandardSession() { +<a name="l00202"></a>00202 data->sessions--; +<a name="l00203"></a>00203 closeReader(); +<a name="l00204"></a>00204 closeWriter(); +<a name="l00205"></a>00205 closeCallback(*this); +<a name="l00206"></a>00206 } +<a name="l00207"></a>00207 +<a name="l00208"></a>00208 virtual int getReader() { +<a name="l00209"></a>00209 return reader; +<a name="l00210"></a>00210 } +<a name="l00211"></a>00211 +<a name="l00212"></a>00212 virtual void closeReader() { +<a name="l00213"></a>00213 if (reader != -1) { +<a name="l00214"></a>00214 close(reader); +<a name="l00215"></a>00215 reader = -1; +<a name="l00216"></a>00216 } +<a name="l00217"></a>00217 } +<a name="l00218"></a>00218 +<a name="l00219"></a>00219 virtual int getWriter() { +<a name="l00220"></a>00220 return writer; +<a name="l00221"></a>00221 } +<a name="l00222"></a>00222 +<a name="l00223"></a>00223 virtual void closeWriter() { +<a name="l00224"></a>00224 if (writer != -1) { +<a name="l00225"></a>00225 close(writer); +<a name="l00226"></a>00226 writer = -1; +<a name="l00227"></a>00227 } +<a name="l00228"></a>00228 } +<a name="l00229"></a>00229 +<a name="l00230"></a>00230 virtual pid_t <a class="code" href="classPassenger_1_1Application.html#94d2cce1c2c1d3441325f1498a22bf02" title="Returns the process ID of this application instance.">getPid</a>() { +<a name="l00231"></a>00231 return pid; +<a name="l00232"></a>00232 } +<a name="l00233"></a>00233 }; +<a name="l00234"></a>00234 +<a name="l00235"></a>00235 string appRoot; +<a name="l00236"></a>00236 pid_t pid; +<a name="l00237"></a>00237 int listenSocket; +<a name="l00238"></a>00238 time_t lastUsed; +<a name="l00239"></a>00239 SharedDataPtr data; +<a name="l00240"></a>00240 +<a name="l00241"></a>00241 public: +<a name="l00242"></a>00242 /** +<a name="l00243"></a>00243 * Construct a new Application object. +<a name="l00244"></a>00244 * +<a name="l00245"></a>00245 * @param theAppRoot The application root of a RoR application, i.e. the folder that +<a name="l00246"></a>00246 * contains 'app/', 'public/', 'config/', etc. This must be a valid directory, +<a name="l00247"></a>00247 * but the path does not have to be absolute. +<a name="l00248"></a>00248 * @param pid The process ID of this application instance. +<a name="l00249"></a>00249 * @param listenSocket The listener socket of this application instance. +<a name="l00250"></a>00250 * @post getAppRoot() == theAppRoot && getPid() == pid +<a name="l00251"></a>00251 */ +<a name="l00252"></a><a class="code" href="classPassenger_1_1Application.html#2504cb46b625c1b4c5344cae944b633d">00252</a> <a class="code" href="classPassenger_1_1Application.html#2504cb46b625c1b4c5344cae944b633d" title="Construct a new Application object.">Application</a>(const string &theAppRoot, pid_t pid, int listenSocket) { +<a name="l00253"></a>00253 appRoot = theAppRoot; +<a name="l00254"></a>00254 this->pid = pid; +<a name="l00255"></a>00255 this->listenSocket = listenSocket; +<a name="l00256"></a>00256 lastUsed = time(NULL); +<a name="l00257"></a>00257 this->data = <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(new SharedData()); +<a name="l00258"></a>00258 this->data->sessions = 0; +<a name="l00259"></a>00259 P_TRACE("Application " << this << ": created."); +<a name="l00260"></a>00260 } +<a name="l00261"></a>00261 +<a name="l00262"></a>00262 virtual ~<a class="code" href="classPassenger_1_1Application.html" title="Represents a single Ruby on Rails application instance.">Application</a>() { +<a name="l00263"></a>00263 close(listenSocket); +<a name="l00264"></a>00264 P_TRACE("Application " << this << ": destroyed."); +<a name="l00265"></a>00265 } +<a name="l00266"></a>00266 +<a name="l00267"></a>00267 /** +<a name="l00268"></a>00268 * Returns the application root for this RoR application. See the constructor +<a name="l00269"></a>00269 * for information about the application root. +<a name="l00270"></a>00270 */ +<a name="l00271"></a><a class="code" href="classPassenger_1_1Application.html#0a0665852e7ebc8fb8ab0772fa90bc56">00271</a> string <a class="code" href="classPassenger_1_1Application.html#0a0665852e7ebc8fb8ab0772fa90bc56" title="Returns the application root for this RoR application.">getAppRoot</a>() const { +<a name="l00272"></a>00272 return appRoot; +<a name="l00273"></a>00273 } +<a name="l00274"></a>00274 +<a name="l00275"></a>00275 /** +<a name="l00276"></a>00276 * Returns the process ID of this application instance. +<a name="l00277"></a>00277 */ +<a name="l00278"></a><a class="code" href="classPassenger_1_1Application.html#94d2cce1c2c1d3441325f1498a22bf02">00278</a> pid_t <a class="code" href="classPassenger_1_1Application.html#94d2cce1c2c1d3441325f1498a22bf02" title="Returns the process ID of this application instance.">getPid</a>() const { +<a name="l00279"></a>00279 return pid; +<a name="l00280"></a>00280 } +<a name="l00281"></a>00281 +<a name="l00282"></a>00282 /** +<a name="l00283"></a>00283 * Connect to this application instance with the purpose of sending +<a name="l00284"></a>00284 * a request to the application. Once connected, a new session will +<a name="l00285"></a>00285 * be opened. This session represents the life time of a single +<a name="l00286"></a>00286 * request/response pair, and can be used to send the request +<a name="l00287"></a>00287 * data to the application instance, as well as receiving the response +<a name="l00288"></a>00288 * data. +<a name="l00289"></a>00289 * +<a name="l00290"></a>00290 * The use of connect() is demonstrated in the following example. +<a name="l00291"></a>00291 * @code +<a name="l00292"></a>00292 * // Connect to the application and get the newly opened session. +<a name="l00293"></a>00293 * Application::SessionPtr session(app->connect("/home/webapps/foo")); +<a name="l00294"></a>00294 * +<a name="l00295"></a>00295 * // Send the request headers and request body data. +<a name="l00296"></a>00296 * session->sendHeaders(...); +<a name="l00297"></a>00297 * session->sendBodyBlock(...); +<a name="l00298"></a>00298 * // Done sending data, so we close the writer channel. +<a name="l00299"></a>00299 * session->closeWriter(); +<a name="l00300"></a>00300 * +<a name="l00301"></a>00301 * // Now read the HTTP response. +<a name="l00302"></a>00302 * string responseData = readAllDataFromSocket(session->getReader()); +<a name="l00303"></a>00303 * // Done reading data, so we close the reader channel. +<a name="l00304"></a>00304 * session->closeReader(); +<a name="l00305"></a>00305 * +<a name="l00306"></a>00306 * // This session has now finished, so we close the session by resetting +<a name="l00307"></a>00307 * // the smart pointer to NULL (thereby destroying the Session object). +<a name="l00308"></a>00308 * session.reset(); <a name="l00309"></a>00309 * -<a name="l00310"></a>00310 * @return A smart pointer to a Session object, which represents the created session. -<a name="l00311"></a>00311 * @param closeCallback A function which will be called when the session has been closed. -<a name="l00312"></a>00312 * @post this->getSessions() == old->getSessions() + 1 -<a name="l00313"></a>00313 * @throws SystemException Something went wrong during the connection process. -<a name="l00314"></a>00314 * @throws IOException Something went wrong during the connection process. -<a name="l00315"></a>00315 */ -<a name="l00316"></a><a class="code" href="classPassenger_1_1Application.html#2db08b6559ead2586f5c68f7bff0c188">00316</a> <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">SessionPtr</a> <a class="code" href="classPassenger_1_1Application.html#2db08b6559ead2586f5c68f7bff0c188" title="Connect to this application instance with the purpose of sending a request to the...">connect</a>(const <a class="code" href="classPassenger_1_1Application.html#a904ba56a6b0413f8da245a762cd681e" title="A type for callback functions that are called when a session is closed.">CloseCallback</a> &closeCallback) const { -<a name="l00317"></a>00317 int ret; -<a name="l00318"></a>00318 do { -<a name="l00319"></a>00319 ret = write(listenSocket, "", 1); -<a name="l00320"></a>00320 } while ((ret == -1 && errno == EINTR) || ret == 0); -<a name="l00321"></a>00321 if (ret == -1) { -<a name="l00322"></a>00322 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("Cannot request a new session from the request handler", errno); -<a name="l00323"></a>00323 } -<a name="l00324"></a>00324 -<a name="l00325"></a>00325 try { -<a name="l00326"></a>00326 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> channel(listenSocket); -<a name="l00327"></a>00327 int reader = channel.<a class="code" href="classPassenger_1_1MessageChannel.html#1561b7e4a0f4d39ea431f456e5655488" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>(); -<a name="l00328"></a>00328 int writer = channel.<a class="code" href="classPassenger_1_1MessageChannel.html#1561b7e4a0f4d39ea431f456e5655488" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>(); -<a name="l00329"></a>00329 return ptr(new StandardSession(data, closeCallback, reader, writer)); -<a name="l00330"></a>00330 } catch (const <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &e) { -<a name="l00331"></a>00331 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("Cannot receive one of the session file descriptors from the request handler", e.<a class="code" href="classPassenger_1_1SystemException.html#ee7a6672bf79b72a4c3ee70c57d6a47c" title="The value of errno at the time the error occured.">code</a>()); -<a name="l00332"></a>00332 } catch (const <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a> &e) { -<a name="l00333"></a>00333 string message("Cannot receive one of the session file descriptors from the request handler"); -<a name="l00334"></a>00334 message.append(e.<a class="code" href="classPassenger_1_1IOException.html#1b65d0fdb9bc5136f5b7df759c14768a">what</a>()); -<a name="l00335"></a>00335 throw <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(message); -<a name="l00336"></a>00336 } -<a name="l00337"></a>00337 } -<a name="l00338"></a>00338 -<a name="l00339"></a>00339 /** -<a name="l00340"></a>00340 * Get the number of currently opened sessions. -<a name="l00341"></a>00341 */ -<a name="l00342"></a><a class="code" href="classPassenger_1_1Application.html#6ddf2dcd2dd9993a8262c207d4154f2c">00342</a> unsigned int <a class="code" href="classPassenger_1_1Application.html#6ddf2dcd2dd9993a8262c207d4154f2c" title="Get the number of currently opened sessions.">getSessions</a>() const { -<a name="l00343"></a>00343 return data->sessions; -<a name="l00344"></a>00344 } -<a name="l00345"></a>00345 -<a name="l00346"></a>00346 /** -<a name="l00347"></a>00347 * Returns the last value set by setLastUsed(). This represents the time -<a name="l00348"></a>00348 * at which this application object was last used. -<a name="l00349"></a>00349 * -<a name="l00350"></a>00350 * This is used by StandardApplicationPool's cleaner thread to determine which -<a name="l00351"></a>00351 * Application objects have been idle for too long and need to be cleaned -<a name="l00352"></a>00352 * up. Thus, outside StandardApplicationPool, one should never have to call this -<a name="l00353"></a>00353 * method directly. +<a name="l00310"></a>00310 * // We can connect to an Application multiple times. Just make sure +<a name="l00311"></a>00311 * // the previous session is closed. +<a name="l00312"></a>00312 * session = app->connect("/home/webapps/bar") +<a name="l00313"></a>00313 * @endcode +<a name="l00314"></a>00314 * +<a name="l00315"></a>00315 * Note that a RoR application instance can only process one +<a name="l00316"></a>00316 * request at the same time, and thus only one session at the same time. +<a name="l00317"></a>00317 * You must close a session when you no longer need if. You you +<a name="l00318"></a>00318 * call connect() without having properly closed a previous session, +<a name="l00319"></a>00319 * you might cause a deadlock because the application instance may be +<a name="l00320"></a>00320 * waiting for you to close the previous session. +<a name="l00321"></a>00321 * +<a name="l00322"></a>00322 * @return A smart pointer to a Session object, which represents the created session. +<a name="l00323"></a>00323 * @param closeCallback A function which will be called when the session has been closed. +<a name="l00324"></a>00324 * @post this->getSessions() == old->getSessions() + 1 +<a name="l00325"></a>00325 * @throws SystemException Something went wrong during the connection process. +<a name="l00326"></a>00326 * @throws IOException Something went wrong during the connection process. +<a name="l00327"></a>00327 */ +<a name="l00328"></a><a class="code" href="classPassenger_1_1Application.html#2db08b6559ead2586f5c68f7bff0c188">00328</a> <a class="code" href="classPassenger_1_1Application.html#d14f673494991460b16246a527ad8ad9" title="Convenient alias for Session smart pointer.">SessionPtr</a> <a class="code" href="classPassenger_1_1Application.html#2db08b6559ead2586f5c68f7bff0c188" title="Connect to this application instance with the purpose of sending a request to the...">connect</a>(const <a class="code" href="classPassenger_1_1Application.html#a904ba56a6b0413f8da245a762cd681e" title="A type for callback functions that are called when a session is closed.">CloseCallback</a> &closeCallback) const { +<a name="l00329"></a>00329 int ret; +<a name="l00330"></a>00330 do { +<a name="l00331"></a>00331 ret = write(listenSocket, "", 1); +<a name="l00332"></a>00332 } while ((ret == -1 && errno == EINTR) || ret == 0); +<a name="l00333"></a>00333 if (ret == -1) { +<a name="l00334"></a>00334 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("Cannot request a new session from the request handler", errno); +<a name="l00335"></a>00335 } +<a name="l00336"></a>00336 +<a name="l00337"></a>00337 try { +<a name="l00338"></a>00338 <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> channel(listenSocket); +<a name="l00339"></a>00339 int reader = channel.<a class="code" href="classPassenger_1_1MessageChannel.html#1561b7e4a0f4d39ea431f456e5655488" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>(); +<a name="l00340"></a>00340 int writer = channel.<a class="code" href="classPassenger_1_1MessageChannel.html#1561b7e4a0f4d39ea431f456e5655488" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>(); +<a name="l00341"></a>00341 return <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(new StandardSession(data, pid, closeCallback, reader, writer)); +<a name="l00342"></a>00342 } catch (const <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &e) { +<a name="l00343"></a>00343 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("Cannot receive one of the session file " +<a name="l00344"></a>00344 "descriptors from the request handler", e.<a class="code" href="classPassenger_1_1SystemException.html#ee7a6672bf79b72a4c3ee70c57d6a47c" title="The value of errno at the time the error occured.">code</a>()); +<a name="l00345"></a>00345 } catch (const <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a> &e) { +<a name="l00346"></a>00346 string message("Cannot receive one of the session file descriptors from the request handler"); +<a name="l00347"></a>00347 message.append(e.<a class="code" href="classPassenger_1_1IOException.html#1b65d0fdb9bc5136f5b7df759c14768a">what</a>()); +<a name="l00348"></a>00348 throw <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(message); +<a name="l00349"></a>00349 } +<a name="l00350"></a>00350 } +<a name="l00351"></a>00351 +<a name="l00352"></a>00352 /** +<a name="l00353"></a>00353 * Get the number of currently opened sessions. <a name="l00354"></a>00354 */ -<a name="l00355"></a><a class="code" href="classPassenger_1_1Application.html#58e74f6a598dbc16d87ce0a1bf8da1d6">00355</a> time_t <a class="code" href="classPassenger_1_1Application.html#58e74f6a598dbc16d87ce0a1bf8da1d6" title="Returns the last value set by setLastUsed().">getLastUsed</a>() const { -<a name="l00356"></a>00356 return lastUsed; +<a name="l00355"></a><a class="code" href="classPassenger_1_1Application.html#6ddf2dcd2dd9993a8262c207d4154f2c">00355</a> unsigned int <a class="code" href="classPassenger_1_1Application.html#6ddf2dcd2dd9993a8262c207d4154f2c" title="Get the number of currently opened sessions.">getSessions</a>() const { +<a name="l00356"></a>00356 return data->sessions; <a name="l00357"></a>00357 } <a name="l00358"></a>00358 <a name="l00359"></a>00359 /** -<a name="l00360"></a>00360 * Set the time at which this Application object was last used. See getLastUsed() -<a name="l00361"></a>00361 * for information. +<a name="l00360"></a>00360 * Returns the last value set by setLastUsed(). This represents the time +<a name="l00361"></a>00361 * at which this application object was last used. <a name="l00362"></a>00362 * -<a name="l00363"></a>00363 * @param time The time. -<a name="l00364"></a>00364 * @post getLastUsed() == time -<a name="l00365"></a>00365 */ -<a name="l00366"></a><a class="code" href="classPassenger_1_1Application.html#f0cf4bbf3dd5f45a573c061bda643d86">00366</a> void <a class="code" href="classPassenger_1_1Application.html#f0cf4bbf3dd5f45a573c061bda643d86" title="Set the time at which this Application object was last used.">setLastUsed</a>(time_t time) { -<a name="l00367"></a>00367 lastUsed = time; -<a name="l00368"></a>00368 } -<a name="l00369"></a>00369 }; -<a name="l00370"></a>00370 -<a name="l00371"></a>00371 /** Convenient alias for Application smart pointer. */ -<a name="l00372"></a>00372 typedef shared_ptr<Application> ApplicationPtr; -<a name="l00373"></a>00373 -<a name="l00374"></a>00374 } // namespace Passenger -<a name="l00375"></a>00375 -<a name="l00376"></a>00376 #endif /* _PASSENGER_APPLICATION_H_ */ -</pre></div><hr size="1"><address style="text-align: right;">Generated on Fri Feb 8 20:08:48 2008 for Passenger by  +<a name="l00363"></a>00363 * This is used by StandardApplicationPool's cleaner thread to determine which +<a name="l00364"></a>00364 * Application objects have been idle for too long and need to be cleaned +<a name="l00365"></a>00365 * up. Thus, outside StandardApplicationPool, one should never have to call this +<a name="l00366"></a>00366 * method directly. +<a name="l00367"></a>00367 */ +<a name="l00368"></a><a class="code" href="classPassenger_1_1Application.html#58e74f6a598dbc16d87ce0a1bf8da1d6">00368</a> time_t <a class="code" href="classPassenger_1_1Application.html#58e74f6a598dbc16d87ce0a1bf8da1d6" title="Returns the last value set by setLastUsed().">getLastUsed</a>() const { +<a name="l00369"></a>00369 return lastUsed; +<a name="l00370"></a>00370 } +<a name="l00371"></a>00371 +<a name="l00372"></a>00372 /** +<a name="l00373"></a>00373 * Set the time at which this Application object was last used. See getLastUsed() +<a name="l00374"></a>00374 * for information. +<a name="l00375"></a>00375 * +<a name="l00376"></a>00376 * @param time The time. +<a name="l00377"></a>00377 * @post getLastUsed() == time +<a name="l00378"></a>00378 */ +<a name="l00379"></a><a class="code" href="classPassenger_1_1Application.html#f0cf4bbf3dd5f45a573c061bda643d86">00379</a> void <a class="code" href="classPassenger_1_1Application.html#f0cf4bbf3dd5f45a573c061bda643d86" title="Set the time at which this Application object was last used.">setLastUsed</a>(time_t time) { +<a name="l00380"></a>00380 lastUsed = time; +<a name="l00381"></a>00381 } +<a name="l00382"></a>00382 }; +<a name="l00383"></a>00383 +<a name="l00384"></a>00384 /** Convenient alias for Application smart pointer. */ +<a name="l00385"></a>00385 typedef shared_ptr<Application> ApplicationPtr; +<a name="l00386"></a>00386 +<a name="l00387"></a>00387 } // namespace Passenger +<a name="l00388"></a>00388 +<a name="l00389"></a>00389 #endif /* _PASSENGER_APPLICATION_H_ */ +</pre></div><hr size="1"><address style="text-align: right;">Generated on Fri Feb 22 10:18:25 2008 for Passenger by  <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </address> </body> doc/cxxapi/Application_8h-source.html @@ -42,48 +42,49 @@ <a name="l00027"></a>00027 */ <a name="l00028"></a>00028 struct DirConfig { <a name="l00029"></a>00029 std::set<std::string> base_uris; -<a name="l00030"></a>00030 }; -<a name="l00031"></a>00031 -<a name="l00032"></a>00032 struct ServerConfig { -<a name="l00033"></a>00033 const char *ruby; -<a name="l00034"></a>00034 -<a name="l00035"></a>00035 /** The environment (i.e. value for RAILS_ENV) under which the Rails application should operate. */ -<a name="l00036"></a>00036 const char *env; -<a name="l00037"></a>00037 -<a name="l00038"></a>00038 const char *spawnServer; -<a name="l00039"></a>00039 }; -<a name="l00040"></a>00040 } -<a name="l00041"></a>00041 -<a name="l00042"></a>00042 extern "C" { -<a name="l00043"></a>00043 #endif -<a name="l00044"></a>00044 -<a name="l00045"></a>00045 /** Configuration hook for per-directory configuration structure creation. */ -<a name="l00046"></a>00046 void *<a class="code" href="group__Configuration.html#g92dc583c1fa5f8025149799e356a6c78" title="Configuration hook for per-directory configuration structure creation.">passenger_config_create_dir</a>(apr_pool_t *p, char *dirspec); -<a name="l00047"></a>00047 -<a name="l00048"></a>00048 /** Configuration hook for per-directory configuration structure merging. */ -<a name="l00049"></a>00049 void *<a class="code" href="group__Configuration.html#g17787a036ef3f4dc46ae0acc9da2c7b0" title="Configuration hook for per-directory configuration structure merging.">passenger_config_merge_dir</a>(apr_pool_t *p, void *basev, void *addv); -<a name="l00050"></a>00050 -<a name="l00051"></a>00051 /** Configuration hook for per-server configuration structure creation. */ -<a name="l00052"></a>00052 void *<a class="code" href="group__Configuration.html#ga93bd8d426649b4e86da38eb67a49178" title="Configuration hook for per-server configuration structure creation.">passenger_config_create_server</a>(apr_pool_t *p, server_rec *s); -<a name="l00053"></a>00053 -<a name="l00054"></a>00054 /** Configuration hook for per-server configuration structure merging. */ -<a name="l00055"></a>00055 void *<a class="code" href="group__Configuration.html#g95c963a61867190928d912779952b15e" title="Configuration hook for per-server configuration structure merging.">passenger_config_merge_server</a>(apr_pool_t *p, void *basev, void *overridesv); -<a name="l00056"></a>00056 -<a name="l00057"></a>00057 void passenger_config_merge_all_servers(apr_pool_t *pool, server_rec *main_server); -<a name="l00058"></a>00058 -<a name="l00059"></a>00059 /** Apache module commands array. */ -<a name="l00060"></a>00060 extern const command_rec <a class="code" href="group__Configuration.html#g21954abbf4018583acb9d8daef3dfd95" title="Apache module commands array.">passenger_commands</a>[]; -<a name="l00061"></a>00061 -<a name="l00062"></a>00062 #ifdef __cplusplus -<a name="l00063"></a>00063 } -<a name="l00064"></a>00064 #endif -<a name="l00065"></a>00065 -<a name="l00066"></a>00066 /** -<a name="l00067"></a>00067 * @} -<a name="l00068"></a>00068 */ -<a name="l00069"></a>00069 -<a name="l00070"></a>00070 #endif /* _PASSENGER_CONFIGURATION_H_ */ -</pre></div><hr size="1"><address style="text-align: right;">Generated on Fri Feb 8 20:08:48 2008 for Passenger by  +<a name="l00030"></a>00030 enum { ENABLED, DISABLED, UNSET } autoDetect; +<a name="l00031"></a>00031 }; +<a name="l00032"></a>00032 +<a name="l00033"></a>00033 struct ServerConfig { +<a name="l00034"></a>00034 const char *ruby; +<a name="l00035"></a>00035 +<a name="l00036"></a>00036 /** The environment (i.e. value for RAILS_ENV) under which the Rails application should operate. */ +<a name="l00037"></a>00037 const char *env; +<a name="l00038"></a>00038 +<a name="l00039"></a>00039 const char *spawnServer; +<a name="l00040"></a>00040 }; +<a name="l00041"></a>00041 } +<a name="l00042"></a>00042 +<a name="l00043"></a>00043 extern "C" { +<a name="l00044"></a>00044 #endif +<a name="l00045"></a>00045 +<a name="l00046"></a>00046 /** Configuration hook for per-directory configuration structure creation. */ +<a name="l00047"></a>00047 void *<a class="code" href="group__Configuration.html#g92dc583c1fa5f8025149799e356a6c78" title="Configuration hook for per-directory configuration structure creation.">passenger_config_create_dir</a>(apr_pool_t *p, char *dirspec); +<a name="l00048"></a>00048 +<a name="l00049"></a>00049 /** Configuration hook for per-directory configuration structure merging. */ +<a name="l00050"></a>00050 void *<a class="code" href="group__Configuration.html#g17787a036ef3f4dc46ae0acc9da2c7b0" title="Configuration hook for per-directory configuration structure merging.">passenger_config_merge_dir</a>(apr_pool_t *p, void *basev, void *addv); +<a name="l00051"></a>00051 +<a name="l00052"></a>00052 /** Configuration hook for per-server configuration structure creation. */ +<a name="l00053"></a>00053 void *<a class="code" href="group__Configuration.html#ga93bd8d426649b4e86da38eb67a49178" title="Configuration hook for per-server configuration structure creation.">passenger_config_create_server</a>(apr_pool_t *p, server_rec *s); +<a name="l00054"></a>00054 +<a name="l00055"></a>00055 /** Configuration hook for per-server configuration structure merging. */ +<a name="l00056"></a>00056 void *<a class="code" href="group__Configuration.html#g95c963a61867190928d912779952b15e" title="Configuration hook for per-server configuration structure merging.">passenger_config_merge_server</a>(apr_pool_t *p, void *basev, void *overridesv); +<a name="l00057"></a>00057 +<a name="l00058"></a>00058 void passenger_config_merge_all_servers(apr_pool_t *pool, server_rec *main_server); +<a name="l00059"></a>00059 +<a name="l00060"></a>00060 /** Apache module commands array. */ +<a name="l00061"></a>00061 extern const command_rec <a class="code" href="group__Configuration.html#g21954abbf4018583acb9d8daef3dfd95" title="Apache module commands array.">passenger_commands</a>[]; +<a name="l00062"></a>00062 +<a name="l00063"></a>00063 #ifdef __cplusplus +<a name="l00064"></a>00064 } +<a name="l00065"></a>00065 #endif +<a name="l00066"></a>00066 +<a name="l00067"></a>00067 /** +<a name="l00068"></a>00068 * @} +<a name="l00069"></a>00069 */ +<a name="l00070"></a>00070 +<a name="l00071"></a>00071 #endif /* _PASSENGER_CONFIGURATION_H_ */ +</pre></div><hr size="1"><address style="text-align: right;">Generated on Fri Feb 22 10:18:25 2008 for Passenger by  <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </address> </body> doc/cxxapi/Configuration_8h-source.html @@ -93,7 +93,7 @@ <a name="l00078"></a>00078 } // namespace Passenger <a name="l00079"></a>00079 <a name="l00080"></a>00080 #endif /* _PASSENGER_DUMMY_SPAWN_MANAGER_H_ */ -</pre></div><hr size="1"><address style="text-align: right;">Generated on Fri Feb 8 20:08:48 2008 for Passenger by  +</pre></div><hr size="1"><address style="text-align: right;">Generated on Fri Feb 22 10:18:25 2008 for Passenger by  <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </address> </body> doc/cxxapi/DummySpawnManager_8h-source.html @@ -98,11 +98,32 @@ <a name="l00083"></a>00083 virtual ~<a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>() throw() {} <a name="l00084"></a>00084 virtual const char *what() const throw() { return msg.c_str(); } <a name="l00085"></a>00085 }; -<a name="l00086"></a>00086 -<a name="l00087"></a>00087 } // namespace Passenger -<a name="l00088"></a>00088 -<a name="l00089"></a>00089 #endif /* _PASSENGER_EXCEPTIONS_H_ */ -</pre></div><hr size="1"><address style="text-align: right;">Generated on Fri Feb 8 20:08:48 2008 for Passenger by  +<a name="l00086"></a>00086 +<a name="l00087"></a>00087 /** +<a name="l00088"></a>00088 * Thrown when a certain file cannot be found. +<a name="l00089"></a>00089 */ +<a name="l00090"></a><a class="code" href="classPassenger_1_1FileNotFoundException.html">00090</a> class <a class="code" href="classPassenger_1_1FileNotFoundException.html" title="Thrown when a certain file cannot be found.">FileNotFoundException</a>: public <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a> { +<a name="l00091"></a>00091 public: +<a name="l00092"></a>00092 <a class="code" href="classPassenger_1_1FileNotFoundException.html" title="Thrown when a certain file cannot be found.">FileNotFoundException</a>(const string &message): <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(message) {} +<a name="l00093"></a>00093 virtual ~<a class="code" href="classPassenger_1_1FileNotFoundException.html" title="Thrown when a certain file cannot be found.">FileNotFoundException</a>() throw() {} +<a name="l00094"></a>00094 }; +<a name="l00095"></a>00095 +<a name="l00096"></a>00096 /** +<a name="l00097"></a>00097 * Thrown when SpawnManager or ApplicationPool fail to spawn an application instance. +<a name="l00098"></a>00098 */ +<a name="l00099"></a><a class="code" href="classPassenger_1_1SpawnException.html">00099</a> class <a class="code" href="classPassenger_1_1SpawnException.html" title="Thrown when SpawnManager or ApplicationPool fail to spawn an application instance...">SpawnException</a>: public exception { +<a name="l00100"></a>00100 private: +<a name="l00101"></a>00101 string msg; +<a name="l00102"></a>00102 public: +<a name="l00103"></a>00103 <a class="code" href="classPassenger_1_1SpawnException.html" title="Thrown when SpawnManager or ApplicationPool fail to spawn an application instance...">SpawnException</a>(const string &message): msg(message) {} +<a name="l00104"></a>00104 virtual ~<a class="code" href="classPassenger_1_1SpawnException.html" title="Thrown when SpawnManager or ApplicationPool fail to spawn an application instance...">SpawnException</a>() throw() {} +<a name="l00105"></a>00105 virtual const char *what() const throw() { return msg.c_str(); } +<a name="l00106"></a>00106 }; +<a name="l00107"></a>00107 +<a name="l00108"></a>00108 } // namespace Passenger +<a name="l00109"></a>00109 +<a name="l00110"></a>00110 #endif /* _PASSENGER_EXCEPTIONS_H_ */ +</pre></div><hr size="1"><address style="text-align: right;">Generated on Fri Feb 22 10:18:25 2008 for Passenger by  <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </address> </body> doc/cxxapi/Exceptions_8h-source.html @@ -34,7 +34,7 @@ <a name="l00019"></a>00019 #endif <a name="l00020"></a>00020 <a name="l00021"></a>00021 #endif /* _PASSENGER_HOOKS_H_ */ -</pre></div><hr size="1"><address style="text-align: right;">Generated on Fri Feb 8 20:08:48 2008 for Passenger by  +</pre></div><hr size="1"><address style="text-align: right;">Generated on Fri Feb 22 10:18:25 2008 for Passenger by  <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </address> </body> doc/cxxapi/Hooks_8h-source.html @@ -47,418 +47,419 @@ <a name="l00032"></a>00032 * There are two kinds of messages: <a name="l00033"></a>00033 * - Array messages. These are just a list of strings, and the message <a name="l00034"></a>00034 * itself has a specific length. The contained strings may not -<a name="l00035"></a>00035 * contain NUL characters (<tt>'\\0'</tt>). -<a name="l00036"></a>00036 * - Scalar messages. These are byte strings which may contain arbitrary -<a name="l00037"></a>00037 * binary data. Scalar messages also have a specific length. -<a name="l00038"></a>00038 * The protocol is designed to be low overhead, easy to implement and -<a name="l00039"></a>00039 * easy to parse. -<a name="l00040"></a>00040 * -<a name="l00041"></a>00041 * MessageChannel is to be wrapped around a file descriptor. For example: -<a name="l00042"></a>00042 * @code -<a name="l00043"></a>00043 * int p[2]; -<a name="l00044"></a>00044 * pipe(p); -<a name="l00045"></a>00045 * MessageChannel channel1(p[0]); -<a name="l00046"></a>00046 * MessageChannel channel2(p[1]); -<a name="l00047"></a>00047 * -<a name="l00048"></a>00048 * // Send an array message. -<a name="l00049"></a>00049 * channel2.write("hello", "world !!", NULL); -<a name="l00050"></a>00050 * list<string> args; -<a name="l00051"></a>00051 * channel1.read(args); // args now contains { "hello", "world !!" } -<a name="l00052"></a>00052 * -<a name="l00053"></a>00053 * // Send a scalar message. -<a name="l00054"></a>00054 * channel2.writeScalar("some long string which can contain arbitrary binary data"); -<a name="l00055"></a>00055 * string str; -<a name="l00056"></a>00056 * channel1.readScalar(str); -<a name="l00057"></a>00057 * @endcode -<a name="l00058"></a>00058 * -<a name="l00059"></a>00059 * The life time of a MessageChannel is independent from that of the -<a name="l00060"></a>00060 * wrapped file descriptor. If a MessageChannel object is destroyed, -<a name="l00061"></a>00061 * the file descriptor is not automatically closed. Call close() -<a name="l00062"></a>00062 * if you want to close the file descriptor. -<a name="l00063"></a>00063 * -<a name="l00064"></a>00064 * @note I/O operations are not buffered. -<a name="l00065"></a>00065 * @note Be careful with mixing the sending/receiving of array messages, -<a name="l00066"></a>00066 * scalar messages and file descriptors. If you send a collection of any -<a name="l00067"></a>00067 * of these in a specific order, then the receiving side must receive them -<a name="l00068"></a>00068 * in the exact some order. So suppose you first send a message, then a -<a name="l00069"></a>00069 * file descriptor, then a scalar, then the receiving side must first -<a name="l00070"></a>00070 * receive a message, then a file descriptor, then a scalar. If the -<a name="l00071"></a>00071 * receiving side does things in the wrong order then bad things will -<a name="l00072"></a>00072 * happen. -<a name="l00073"></a>00073 * @note MessageChannel is thread-safe. -<a name="l00074"></a>00074 * -<a name="l00075"></a>00075 * @ingroup Support -<a name="l00076"></a>00076 */ -<a name="l00077"></a><a class="code" href="classPassenger_1_1MessageChannel.html">00077</a> class <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> { -<a name="l00078"></a>00078 private: -<a name="l00079"></a>00079 const static char DELIMITER = '\0'; -<a name="l00080"></a>00080 int fd; -<a name="l00081"></a>00081 -<a name="l00082"></a>00082 public: -<a name="l00083"></a>00083 /** -<a name="l00084"></a>00084 * Construct a new MessageChannel with no underlying file descriptor. -<a name="l00085"></a>00085 * Thus the resulting MessageChannel object will not be usable. -<a name="l00086"></a>00086 * This constructor exists to allow one to declare an "empty" -<a name="l00087"></a>00087 * MessageChannel variable which is to be initialized later. -<a name="l00088"></a>00088 */ -<a name="l00089"></a><a class="code" href="classPassenger_1_1MessageChannel.html#73e7c9a8e421d29558838176aff02ca4">00089</a> <a class="code" href="classPassenger_1_1MessageChannel.html#73e7c9a8e421d29558838176aff02ca4" title="Construct a new MessageChannel with no underlying file descriptor.">MessageChannel</a>() { -<a name="l00090"></a>00090 this->fd = -1; -<a name="l00091"></a>00091 } -<a name="l00092"></a>00092 -<a name="l00093"></a>00093 /** -<a name="l00094"></a>00094 * Construct a new MessageChannel with the given file descriptor. -<a name="l00095"></a>00095 */ -<a name="l00096"></a><a class="code" href="classPassenger_1_1MessageChannel.html#486b6e74c4d0973eefbcfde65f898ca7">00096</a> <a class="code" href="classPassenger_1_1MessageChannel.html#73e7c9a8e421d29558838176aff02ca4" title="Construct a new MessageChannel with no underlying file descriptor.">MessageChannel</a>(int fd) { -<a name="l00097"></a>00097 this->fd = fd; -<a name="l00098"></a>00098 } -<a name="l00099"></a>00099 -<a name="l00100"></a>00100 /** -<a name="l00101"></a>00101 * Close the underlying file descriptor. If this method is called multiple -<a name="l00102"></a>00102 * times, the file descriptor will only be closed the first time. -<a name="l00103"></a>00103 */ -<a name="l00104"></a><a class="code" href="classPassenger_1_1MessageChannel.html#06309e208fc5e10642a2e9bbe0f351eb">00104</a> void <a class="code" href="classPassenger_1_1MessageChannel.html#06309e208fc5e10642a2e9bbe0f351eb" title="Close the underlying file descriptor.">close</a>() { -<a name="l00105"></a>00105 if (fd != -1) {<a class="code" href="classPassenger_1_1MessageChannel.html#06309e208fc5e10642a2e9bbe0f351eb" title="Close the underlying file descriptor."></a> -<a name="l00106"></a>00106 <a class="code" href="classPassenger_1_1MessageChannel.html#06309e208fc5e10642a2e9bbe0f351eb" title="Close the underlying file descriptor."> ::close</a>(fd); -<a name="l00107"></a>00107 fd = -1; -<a name="l00108"></a>00108 } -<a name="l00109"></a>00109 } -<a name="l00110"></a>00110 -<a name="l00111"></a>00111 /** -<a name="l00112"></a>00112 * Send an array message, which consists of the given elements, over the underlying -<a name="l00113"></a>00113 * file descriptor. -<a name="l00114"></a>00114 * -<a name="l00115"></a>00115 * @param args The message elements. -<a name="l00116"></a>00116 * @throws SystemException An error occured while writing the data to the file descriptor. -<a name="l00117"></a>00117 * @pre None of the message elements may contain a NUL character (<tt>'\\0'</tt>). -<a name="l00118"></a>00118 * @see read(), write(const char *, ...) -<a name="l00119"></a>00119 */ -<a name="l00120"></a><a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a">00120</a> void <a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(const list<string> &args) { -<a name="l00121"></a>00121 list<string>::const_iterator it; -<a name="l00122"></a>00122 string data; -<a name="l00123"></a>00123 uint16_t dataSize = 0; -<a name="l00124"></a>00124 -<a name="l00125"></a>00125 for (it = args.begin(); it != args.end(); it++) { -<a name="l00126"></a>00126 dataSize += it->size() + 1; -<a name="l00127"></a>00127 } -<a name="l00128"></a>00128 data.reserve(dataSize + sizeof(dataSize)); -<a name="l00129"></a>00129 dataSize = htons(dataSize); -<a name="l00130"></a>00130 data.append((const char *) &dataSize, sizeof(dataSize)); -<a name="l00131"></a>00131 for (it = args.begin(); it != args.end(); it++) { -<a name="l00132"></a>00132 data.append(*it); -<a name="l00133"></a>00133 data.append(1, DELIMITER); -<a name="l00134"></a>00134 } -<a name="l00135"></a>00135 -<a name="l00136"></a>00136 <a class="code" href="classPassenger_1_1MessageChannel.html#069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>(data); -<a name="l00137"></a>00137 } -<a name="l00138"></a>00138 -<a name="l00139"></a>00139 /** -<a name="l00140"></a>00140 * Send an array message, which consists of the given strings, over the underlying -<a name="l00141"></a>00141 * file descriptor. -<a name="l00142"></a>00142 * -<a name="l00143"></a>00143 * @param name The first element of the message to send. -<a name="l00144"></a>00144 * @param ... Other elements of the message. These *must* be strings, i.e. of type char*. -<a name="l00145"></a>00145 * It is also required to terminate this list with a NULL. -<a name="l00146"></a>00146 * @throws SystemException An error occured while writing the data to the file descriptor. -<a name="l00147"></a>00147 * @pre None of the message elements may contain a NUL character (<tt>'\\0'</tt>). -<a name="l00148"></a>00148 * @see read(), write(const list<string> &) -<a name="l00149"></a>00149 */ -<a name="l00150"></a><a class="code" href="classPassenger_1_1MessageChannel.html#12cce3364023eacbe4fe09006cf3d38d">00150</a> void <a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(const char *name, ...) { -<a name="l00151"></a>00151 list<string> args; -<a name="l00152"></a>00152 args.push_back(name); -<a name="l00153"></a>00153 -<a name="l00154"></a>00154 va_list ap; -<a name="l00155"></a>00155 va_start(ap, name); -<a name="l00156"></a>00156 while (true) { -<a name="l00157"></a>00157 const char *arg = va_arg(ap, const char *); -<a name="l00158"></a>00158 if (arg == NULL) { -<a name="l00159"></a>00159 break; -<a name="l00160"></a>00160 } else { -<a name="l00161"></a>00161 args.push_back(arg); -<a name="l00162"></a>00162 } -<a name="l00163"></a>00163 } -<a name="l00164"></a>00164 va_end(ap); -<a name="l00165"></a>00165 <a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(args); -<a name="l00166"></a>00166 } -<a name="l00167"></a>00167 -<a name="l00168"></a>00168 /** -<a name="l00169"></a>00169 * Send a scalar message over the underlying file descriptor. -<a name="l00170"></a>00170 * -<a name="l00171"></a>00171 * @param str The scalar message's content. -<a name="l00172"></a>00172 * @throws SystemException An error occured while writing the data to the file descriptor. -<a name="l00173"></a>00173 * @see readScalar(), writeScalar(const char *, unsigned int) -<a name="l00174"></a>00174 */ -<a name="l00175"></a><a class="code" href="classPassenger_1_1MessageChannel.html#44e01a783c48abadeea0d915b9893bfb">00175</a> void <a class="code" href="classPassenger_1_1MessageChannel.html#44e01a783c48abadeea0d915b9893bfb" title="Send a scalar message over the underlying file descriptor.">writeScalar</a>(const string &str) { -<a name="l00176"></a>00176 <a class="code" href="classPassenger_1_1MessageChannel.html#44e01a783c48abadeea0d915b9893bfb" title="Send a scalar message over the underlying file descriptor.">writeScalar</a>(str.c_str(), str.size()); -<a name="l00177"></a>00177 } -<a name="l00178"></a>00178 -<a name="l00179"></a>00179 /** -<a name="l00180"></a>00180 * Send a scalar message over the underlying file descriptor. -<a name="l00181"></a>00181 * -<a name="l00182"></a>00182 * @param data The scalar message's content. -<a name="l00183"></a>00183 * @param size The number of bytes in <tt>data</tt>. -<a name="l00184"></a>00184 * @pre <tt>data != NULL</tt> -<a name="l00185"></a>00185 * @throws SystemException An error occured while writing the data to the file descriptor. -<a name="l00186"></a>00186 * @see readScalar(), writeScalar(const string &) -<a name="l00187"></a>00187 */ -<a name="l00188"></a><a class="code" href="classPassenger_1_1MessageChannel.html#80977020ef895f3ea790c5d28a333dda">00188</a> void <a class="code" href="classPassenger_1_1MessageChannel.html#44e01a783c48abadeea0d915b9893bfb" title="Send a scalar message over the underlying file descriptor.">writeScalar</a>(const char *data, unsigned int size) { -<a name="l00189"></a>00189 uint32_t l = htonl(size); -<a name="l00190"></a>00190 <a class="code" href="classPassenger_1_1MessageChannel.html#069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>((const char *) &l, sizeof(uint32_t)); -<a name="l00191"></a>00191 <a class="code" href="classPassenger_1_1MessageChannel.html#069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>(data, size); -<a name="l00192"></a>00192 } -<a name="l00193"></a>00193 -<a name="l00194"></a>00194 /** -<a name="l00195"></a>00195 * Send a block of data over the underlying file descriptor. -<a name="l00196"></a>00196 * This method blocks until everything is sent. -<a name="l00197"></a>00197 * -<a name="l00198"></a>00198 * @param data The data to send. -<a name="l00199"></a>00199 * @param size The number of bytes in <tt>data</tt>. -<a name="l00200"></a>00200 * @pre <tt>data != NULL</tt> -<a name="l00201"></a>00201 * @throws SystemException An error occured while writing the data to the file descriptor. -<a name="l00202"></a>00202 * @see readRaw() -<a name="l00203"></a>00203 */ -<a name="l00204"></a><a class="code" href="classPassenger_1_1MessageChannel.html#069314e4c7e1fe8c8ab36e16d2cc5fef">00204</a> void <a class="code" href="classPassenger_1_1MessageChannel.html#069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>(const char *data, unsigned int size) { -<a name="l00205"></a>00205 ssize_t ret; -<a name="l00206"></a>00206 unsigned int written = 0; -<a name="l00207"></a>00207 do { -<a name="l00208"></a>00208 do { -<a name="l00209"></a>00209 ret =<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying..."> ::write</a>(fd, data + written, size - written); -<a name="l00210"></a>00210 } while (ret == -1 && errno == EINTR); -<a name="l00211"></a>00211 if (ret == -1) { -<a name="l00212"></a>00212 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("write() failed", errno); -<a name="l00213"></a>00213 } else { -<a name="l00214"></a>00214 written += ret; -<a name="l00215"></a>00215 } -<a name="l00216"></a>00216 } while (written < size); -<a name="l00217"></a>00217 } -<a name="l00218"></a>00218 -<a name="l00219"></a>00219 /** -<a name="l00220"></a>00220 * Send a block of data over the underlying file descriptor. -<a name="l00221"></a>00221 * This method blocks until everything is sent. -<a name="l00222"></a>00222 * -<a name="l00223"></a>00223 * @param data The data to send. -<a name="l00224"></a>00224 * @pre <tt>data != NULL</tt> -<a name="l00225"></a>00225 * @throws SystemException An error occured while writing the data to the file descriptor. -<a name="l00226"></a>00226 */ -<a name="l00227"></a><a class="code" href="classPassenger_1_1MessageChannel.html#cfa38f4f0e22ec16350b8cc159e8e364">00227</a> void <a class="code" href="classPassenger_1_1MessageChannel.html#069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>(const string &data) { -<a name="l00228"></a>00228 <a class="code" href="classPassenger_1_1MessageChannel.html#069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>(data.c_str(), data.size()); -<a name="l00229"></a>00229 } -<a name="l00230"></a>00230 -<a name="l00231"></a>00231 /** -<a name="l00232"></a>00232 * Pass a file descriptor. This only works if the underlying file -<a name="l00233"></a>00233 * descriptor is a Unix socket. -<a name="l00234"></a>00234 * -<a name="l00235"></a>00235 * @param fileDescriptor The file descriptor to pass. -<a name="l00236"></a>00236 * @throws SystemException Something went wrong during file descriptor passing. -<a name="l00237"></a>00237 * @pre <tt>fileDescriptor >= 0</tt> -<a name="l00238"></a>00238 * @see readFileDescriptor() -<a name="l00239"></a>00239 */ -<a name="l00240"></a><a class="code" href="classPassenger_1_1MessageChannel.html#73e3f3cda384c085a2af0e820ccd3e98">00240</a> void <a class="code" href="classPassenger_1_1MessageChannel.html#73e3f3cda384c085a2af0e820ccd3e98" title="Pass a file descriptor.">writeFileDescriptor</a>(int fileDescriptor) { -<a name="l00241"></a>00241 struct msghdr msg; -<a name="l00242"></a>00242 struct iovec vec[1]; -<a name="l00243"></a>00243 char buf[1]; -<a name="l00244"></a>00244 struct { -<a name="l00245"></a>00245 struct cmsghdr hdr; -<a name="l00246"></a>00246 int fd; -<a name="l00247"></a>00247 } cmsg; -<a name="l00248"></a>00248 -<a name="l00249"></a>00249 msg.msg_name = NULL; -<a name="l00250"></a>00250 msg.msg_namelen = 0; -<a name="l00251"></a>00251 -<a name="l00252"></a>00252 /* Linux and Solaris doesn't work if msg_iov is NULL. */ -<a name="l00253"></a>00253 buf[0] = '\0'; -<a name="l00254"></a>00254 vec[0].iov_base = buf; -<a name="l00255"></a>00255 vec[0].iov_len = 1; -<a name="l00256"></a>00256 msg.msg_iov = vec; -<a name="l00257"></a>00257 msg.msg_iovlen = 1; -<a name="l00258"></a>00258 -<a name="l00259"></a>00259 msg.msg_control = (caddr_t)&cmsg; -<a name="l00260"></a>00260 msg.msg_controllen = CMSG_SPACE(sizeof(int)); -<a name="l00261"></a>00261 msg.msg_flags = 0; -<a name="l00262"></a>00262 cmsg.hdr.cmsg_len = CMSG_LEN(sizeof(int)); -<a name="l00263"></a>00263 cmsg.hdr.cmsg_level = SOL_SOCKET; -<a name="l00264"></a>00264 cmsg.hdr.cmsg_type = SCM_RIGHTS; -<a name="l00265"></a>00265 cmsg.fd = fileDescriptor; -<a name="l00266"></a>00266 -<a name="l00267"></a>00267 if (sendmsg(fd, &msg, 0) == -1) { -<a name="l00268"></a>00268 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("Cannot send file descriptor with sendmsg()", errno); -<a name="l00269"></a>00269 } -<a name="l00270"></a>00270 } -<a name="l00271"></a>00271 -<a name="l00272"></a>00272 /** -<a name="l00273"></a>00273 * Receive a message from the underlying file descriptor. -<a name="l00274"></a>00274 * -<a name="l00275"></a>00275 * @param args The message will be put in this variable. -<a name="l00276"></a>00276 * @return Whether end-of-file has been reached. If so, then the contents -<a name="l00277"></a>00277 * of <tt>args</tt> will be undefined. -<a name="l00278"></a>00278 * @throws SystemException If an error occured while receiving the message. -<a name="l00279"></a>00279 * @see write() -<a name="l00280"></a>00280 */ -<a name="l00281"></a><a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e">00281</a> bool <a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor.">read</a>(vector<string> &args) { -<a name="l00282"></a>00282 uint16_t size; -<a name="l00283"></a>00283 int ret; -<a name="l00284"></a>00284 unsigned int alreadyRead = 0; -<a name="l00285"></a>00285 -<a name="l00286"></a>00286 do { -<a name="l00287"></a>00287 do { -<a name="l00288"></a>00288 ret =<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor."> ::read</a>(fd, (char *) &size + alreadyRead, sizeof(size) - alreadyRead); -<a name="l00289"></a>00289 } while (ret == -1 && errno == EINTR); -<a name="l00290"></a>00290 if (ret == -1) { -<a name="l00291"></a>00291 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("read() failed", errno); -<a name="l00292"></a>00292 } else if (ret == 0) { -<a name="l00293"></a>00293 return false; -<a name="l00294"></a>00294 } -<a name="l00295"></a>00295 alreadyRead += ret; -<a name="l00296"></a>00296 } while (alreadyRead < sizeof(size)); -<a name="l00297"></a>00297 size = ntohs(size); -<a name="l00298"></a>00298 -<a name="l00299"></a>00299 string buffer; -<a name="l00300"></a>00300 args.clear(); -<a name="l00301"></a>00301 buffer.reserve(size); -<a name="l00302"></a>00302 while (buffer.size() < size) { -<a name="l00303"></a>00303 char tmp[1024 * 8]; -<a name="l00304"></a>00304 do { -<a name="l00305"></a>00305 ret =<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor."> ::read</a>(fd, tmp, min(size - buffer.size(), sizeof(tmp))); -<a name="l00306"></a>00306 } while (ret == -1 && errno == EINTR); -<a name="l00307"></a>00307 if (ret == -1) { -<a name="l00308"></a>00308 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("read() failed", errno); -<a name="l00309"></a>00309 } else if (ret == 0) { -<a name="l00310"></a>00310 return false; -<a name="l00311"></a>00311 } -<a name="l00312"></a>00312 buffer.append(tmp, ret); -<a name="l00313"></a>00313 } -<a name="l00314"></a>00314 -<a name="l00315"></a>00315 if (!buffer.empty()) { -<a name="l00316"></a>00316 string::size_type start = 0, pos; -<a name="l00317"></a>00317 const string &const_buffer(buffer); -<a name="l00318"></a>00318 while ((pos = const_buffer.find('\0', start)) != string::npos) { -<a name="l00319"></a>00319 args.push_back(const_buffer.substr(start, pos - start)); -<a name="l00320"></a>00320 start = pos + 1; -<a name="l00321"></a>00321 } -<a name="l00322"></a>00322 } -<a name="l00323"></a>00323 return true; -<a name="l00324"></a>00324 } -<a name="l00325"></a>00325 -<a name="l00326"></a>00326 /** -<a name="l00327"></a>00327 * Read a scalar message from the underlying file descriptor. -<a name="l00328"></a>00328 * -<a name="l00329"></a>00329 * @param output The message will be put in here. -<a name="l00330"></a>00330 * @returns Whether end-of-file was reached during reading. -<a name="l00331"></a>00331 * @throws SystemException An error occured while writing the data to the file descriptor. -<a name="l00332"></a>00332 * @see writeScalar() -<a name="l00333"></a>00333 */ -<a name="l00334"></a><a class="code" href="classPassenger_1_1MessageChannel.html#4ce6a0e751b5e3563bee583c231569bc">00334</a> bool <a class="code" href="classPassenger_1_1MessageChannel.html#4ce6a0e751b5e3563bee583c231569bc" title="Read a scalar message from the underlying file descriptor.">readScalar</a>(string &output) { -<a name="l00335"></a>00335 uint32_t size; -<a name="l00336"></a>00336 unsigned int remaining; -<a name="l00337"></a>00337 -<a name="l00338"></a>00338 if (!<a class="code" href="classPassenger_1_1MessageChannel.html#cd1d1bd1cc787784c8b54f5471fff479" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(&size, sizeof(uint32_t))) { -<a name="l00339"></a>00339 return false; -<a name="l00340"></a>00340 } -<a name="l00341"></a>00341 size = ntohl(size); -<a name="l00342"></a>00342 -<a name="l00343"></a>00343 output.clear(); -<a name="l00344"></a>00344 output.reserve(size); -<a name="l00345"></a>00345 remaining = size; -<a name="l00346"></a>00346 while (remaining > 0) { -<a name="l00347"></a>00347 char buf[1024 * 32]; -<a name="l00348"></a>00348 unsigned int blockSize = min(sizeof(buf), remaining); -<a name="l00349"></a>00349 -<a name="l00350"></a>00350 if (!<a class="code" href="classPassenger_1_1MessageChannel.html#cd1d1bd1cc787784c8b54f5471fff479" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(buf, blockSize)) { -<a name="l00351"></a>00351 return false; -<a name="l00352"></a>00352 } -<a name="l00353"></a>00353 output.append(buf, blockSize); -<a name="l00354"></a>00354 remaining -= blockSize; -<a name="l00355"></a>00355 } -<a name="l00356"></a>00356 return true; -<a name="l00357"></a>00357 } -<a name="l00358"></a>00358 -<a name="l00359"></a>00359 /** -<a name="l00360"></a>00360 * Read exactly <tt>size</tt> bytes of data from the underlying file descriptor, -<a name="l00361"></a>00361 * and put the result in <tt>buf</tt>. If end-of-file has been reached, or if -<a name="l00362"></a>00362 * end-of-file was encountered before <tt>size</tt> bytes have been read, then -<a name="l00363"></a>00363 * <tt>false</tt> will be returned. Otherwise (i.e. if the read was successful), -<a name="l00364"></a>00364 * <tt>true</tt> will be returned. -<a name="l00365"></a>00365 * -<a name="l00366"></a>00366 * @param buf The buffer to place the read data in. This buffer must be at least -<a name="l00367"></a>00367 * <tt>size</tt> bytes long. -<a name="l00368"></a>00368 * @param size The number of bytes to read. -<a name="l00369"></a>00369 * @return Whether reading was successful or whether EOF was reached. -<a name="l00370"></a>00370 * @pre buf != NULL -<a name="l00371"></a>00371 * @throws SystemException Something went wrong during reading. -<a name="l00372"></a>00372 * @see writeRaw() -<a name="l00373"></a>00373 */ -<a name="l00374"></a><a class="code" href="classPassenger_1_1MessageChannel.html#cd1d1bd1cc787784c8b54f5471fff479">00374</a> bool <a class="code" href="classPassenger_1_1MessageChannel.html#cd1d1bd1cc787784c8b54f5471fff479" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(void *buf, unsigned int size) { -<a name="l00375"></a>00375 ssize_t ret; -<a name="l00376"></a>00376 unsigned int alreadyRead = 0; -<a name="l00377"></a>00377 -<a name="l00378"></a>00378 while (alreadyRead < size) { -<a name="l00379"></a>00379 do { -<a name="l00380"></a>00380 ret =<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor."> ::read</a>(fd, (char *) buf + alreadyRead, size - alreadyRead); -<a name="l00381"></a>00381 } while (ret == -1 && errno == EINTR); -<a name="l00382"></a>00382 if (ret == -1) { -<a name="l00383"></a>00383 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("read() failed", errno); -<a name="l00384"></a>00384 } else if (ret == 0) { -<a name="l00385"></a>00385 return false; -<a name="l00386"></a>00386 } else { -<a name="l00387"></a>00387 alreadyRead += ret; -<a name="l00388"></a>00388 } -<a name="l00389"></a>00389 } -<a name="l00390"></a>00390 return true; -<a name="l00391"></a>00391 } -<a name="l00392"></a>00392 -<a name="l00393"></a>00393 /** -<a name="l00394"></a>00394 * Receive a file descriptor, which had been passed over the underlying -<a name="l00395"></a>00395 * file descriptor. -<a name="l00396"></a>00396 * -<a name="l00397"></a>00397 * @return The passed file descriptor. -<a name="l00398"></a>00398 * @throws SystemException If something went wrong during the -<a name="l00399"></a>00399 * receiving of a file descriptor. Perhaps the underlying -<a name="l00400"></a>00400 * file descriptor isn't a Unix socket. -<a name="l00401"></a>00401 * @throws IOException Whatever was received doesn't seem to be a -<a name="l00402"></a>00402 * file descriptor. -<a name="l00403"></a>00403 */ -<a name="l00404"></a><a class="code" href="classPassenger_1_1MessageChannel.html#1561b7e4a0f4d39ea431f456e5655488">00404</a> int <a class="code" href="classPassenger_1_1MessageChannel.html#1561b7e4a0f4d39ea431f456e5655488" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>() { -<a name="l00405"></a>00405 struct msghdr msg; -<a name="l00406"></a>00406 struct iovec vec[2]; -<a name="l00407"></a>00407 char buf[1]; -<a name="l00408"></a>00408 struct { -<a name="l00409"></a>00409 struct cmsghdr hdr; -<a name="l00410"></a>00410 int fd; -<a name="l00411"></a>00411 } cmsg; -<a name="l00412"></a>00412 -<a name="l00413"></a>00413 msg.msg_name = NULL; -<a name="l00414"></a>00414 msg.msg_namelen = 0; -<a name="l00415"></a>00415 -<a name="l00416"></a>00416 vec[0].iov_base = buf; -<a name="l00417"></a>00417 vec[0].iov_len = sizeof(buf); -<a name="l00418"></a>00418 msg.msg_iov = vec; -<a name="l00419"></a>00419 msg.msg_iovlen = 1; -<a name="l00420"></a>00420 -<a name="l00421"></a>00421 msg.msg_control = (caddr_t)&cmsg; -<a name="l00422"></a>00422 msg.msg_controllen = CMSG_SPACE(sizeof(int)); -<a name="l00423"></a>00423 msg.msg_flags = 0; -<a name="l00424"></a>00424 cmsg.hdr.cmsg_len = CMSG_LEN(sizeof(int)); -<a name="l00425"></a>00425 cmsg.hdr.cmsg_level = SOL_SOCKET; -<a name="l00426"></a>00426 cmsg.hdr.cmsg_type = SCM_RIGHTS; -<a name="l00427"></a>00427 cmsg.fd = -1; -<a name="l00428"></a>00428 -<a name="l00429"></a>00429 if (recvmsg(fd, &msg, 0) == -1) { -<a name="l00430"></a>00430 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("Cannot read file descriptor with recvmsg()", errno); -<a name="l00431"></a>00431 } -<a name="l00432"></a>00432 -<a name="l00433"></a>00433 if (msg.msg_controllen != CMSG_SPACE(sizeof(int)) -<a name="l00434"></a>00434 || cmsg.hdr.cmsg_len != CMSG_SPACE(0) + sizeof(int) -<a name="l00435"></a>00435 || cmsg.hdr.cmsg_level != SOL_SOCKET -<a name="l00436"></a>00436 || cmsg.hdr.cmsg_type != SCM_RIGHTS) { -<a name="l00437"></a>00437 throw <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>("No valid file descriptor received."); -<a name="l00438"></a>00438 } -<a name="l00439"></a>00439 return cmsg.fd; -<a name="l00440"></a>00440 } -<a name="l00441"></a>00441 }; -<a name="l00442"></a>00442 -<a name="l00443"></a>00443 } // namespace Passenger -<a name="l00444"></a>00444 -<a name="l00445"></a>00445 #endif /* _PASSENGER_MESSAGE_CHANNEL_H_ */ -</pre></div><hr size="1"><address style="text-align: right;">Generated on Fri Feb 8 20:08:48 2008 for Passenger by  +<a name="l00035"></a>00035 * contain NUL characters (<tt>'\\0'</tt>). Note that an array message +<a name="l00036"></a>00036 * must have at least one element. +<a name="l00037"></a>00037 * - Scalar messages. These are byte strings which may contain arbitrary +<a name="l00038"></a>00038 * binary data. Scalar messages also have a specific length. +<a name="l00039"></a>00039 * The protocol is designed to be low overhead, easy to implement and +<a name="l00040"></a>00040 * easy to parse. +<a name="l00041"></a>00041 * +<a name="l00042"></a>00042 * MessageChannel is to be wrapped around a file descriptor. For example: +<a name="l00043"></a>00043 * @code +<a name="l00044"></a>00044 * int p[2]; +<a name="l00045"></a>00045 * pipe(p); +<a name="l00046"></a>00046 * MessageChannel channel1(p[0]); +<a name="l00047"></a>00047 * MessageChannel channel2(p[1]); +<a name="l00048"></a>00048 * +<a name="l00049"></a>00049 * // Send an array message. +<a name="l00050"></a>00050 * channel2.write("hello", "world !!", NULL); +<a name="l00051"></a>00051 * list<string> args; +<a name="l00052"></a>00052 * channel1.read(args); // args now contains { "hello", "world !!" } +<a name="l00053"></a>00053 * +<a name="l00054"></a>00054 * // Send a scalar message. +<a name="l00055"></a>00055 * channel2.writeScalar("some long string which can contain arbitrary binary data"); +<a name="l00056"></a>00056 * string str; +<a name="l00057"></a>00057 * channel1.readScalar(str); +<a name="l00058"></a>00058 * @endcode +<a name="l00059"></a>00059 * +<a name="l00060"></a>00060 * The life time of a MessageChannel is independent from that of the +<a name="l00061"></a>00061 * wrapped file descriptor. If a MessageChannel object is destroyed, +<a name="l00062"></a>00062 * the file descriptor is not automatically closed. Call close() +<a name="l00063"></a>00063 * if you want to close the file descriptor. +<a name="l00064"></a>00064 * +<a name="l00065"></a>00065 * @note I/O operations are not buffered. +<a name="l00066"></a>00066 * @note Be careful with mixing the sending/receiving of array messages, +<a name="l00067"></a>00067 * scalar messages and file descriptors. If you send a collection of any +<a name="l00068"></a>00068 * of these in a specific order, then the receiving side must receive them +<a name="l00069"></a>00069 * in the exact some order. So suppose you first send a message, then a +<a name="l00070"></a>00070 * file descriptor, then a scalar, then the receiving side must first +<a name="l00071"></a>00071 * receive a message, then a file descriptor, then a scalar. If the +<a name="l00072"></a>00072 * receiving side does things in the wrong order then bad things will +<a name="l00073"></a>00073 * happen. +<a name="l00074"></a>00074 * @note MessageChannel is thread-safe. +<a name="l00075"></a>00075 * +<a name="l00076"></a>00076 * @ingroup Support +<a name="l00077"></a>00077 */ +<a name="l00078"></a><a class="code" href="classPassenger_1_1MessageChannel.html">00078</a> class <a class="code" href="classPassenger_1_1MessageChannel.html" title="Convenience class for I/O operations on file descriptors.">MessageChannel</a> { +<a name="l00079"></a>00079 private: +<a name="l00080"></a>00080 const static char DELIMITER = '\0'; +<a name="l00081"></a>00081 int fd; +<a name="l00082"></a>00082 +<a name="l00083"></a>00083 public: +<a name="l00084"></a>00084 /** +<a name="l00085"></a>00085 * Construct a new MessageChannel with no underlying file descriptor. +<a name="l00086"></a>00086 * Thus the resulting MessageChannel object will not be usable. +<a name="l00087"></a>00087 * This constructor exists to allow one to declare an "empty" +<a name="l00088"></a>00088 * MessageChannel variable which is to be initialized later. +<a name="l00089"></a>00089 */ +<a name="l00090"></a><a class="code" href="classPassenger_1_1MessageChannel.html#73e7c9a8e421d29558838176aff02ca4">00090</a> <a class="code" href="classPassenger_1_1MessageChannel.html#73e7c9a8e421d29558838176aff02ca4" title="Construct a new MessageChannel with no underlying file descriptor.">MessageChannel</a>() { +<a name="l00091"></a>00091 this->fd = -1; +<a name="l00092"></a>00092 } +<a name="l00093"></a>00093 +<a name="l00094"></a>00094 /** +<a name="l00095"></a>00095 * Construct a new MessageChannel with the given file descriptor. +<a name="l00096"></a>00096 */ +<a name="l00097"></a><a class="code" href="classPassenger_1_1MessageChannel.html#486b6e74c4d0973eefbcfde65f898ca7">00097</a> <a class="code" href="classPassenger_1_1MessageChannel.html#73e7c9a8e421d29558838176aff02ca4" title="Construct a new MessageChannel with no underlying file descriptor.">MessageChannel</a>(int fd) { +<a name="l00098"></a>00098 this->fd = fd; +<a name="l00099"></a>00099 } +<a name="l00100"></a>00100 +<a name="l00101"></a>00101 /** +<a name="l00102"></a>00102 * Close the underlying file descriptor. If this method is called multiple +<a name="l00103"></a>00103 * times, the file descriptor will only be closed the first time. +<a name="l00104"></a>00104 */ +<a name="l00105"></a><a class="code" href="classPassenger_1_1MessageChannel.html#06309e208fc5e10642a2e9bbe0f351eb">00105</a> void <a class="code" href="classPassenger_1_1MessageChannel.html#06309e208fc5e10642a2e9bbe0f351eb" title="Close the underlying file descriptor.">close</a>() { +<a name="l00106"></a>00106 if (fd != -1) {<a class="code" href="classPassenger_1_1MessageChannel.html#06309e208fc5e10642a2e9bbe0f351eb" title="Close the underlying file descriptor."></a> +<a name="l00107"></a>00107 <a class="code" href="classPassenger_1_1MessageChannel.html#06309e208fc5e10642a2e9bbe0f351eb" title="Close the underlying file descriptor."> ::close</a>(fd); +<a name="l00108"></a>00108 fd = -1; +<a name="l00109"></a>00109 } +<a name="l00110"></a>00110 } +<a name="l00111"></a>00111 +<a name="l00112"></a>00112 /** +<a name="l00113"></a>00113 * Send an array message, which consists of the given elements, over the underlying +<a name="l00114"></a>00114 * file descriptor. +<a name="l00115"></a>00115 * +<a name="l00116"></a>00116 * @param args The message elements. +<a name="l00117"></a>00117 * @throws SystemException An error occured while writing the data to the file descriptor. +<a name="l00118"></a>00118 * @pre None of the message elements may contain a NUL character (<tt>'\\0'</tt>). +<a name="l00119"></a>00119 * @see read(), write(const char *, ...) +<a name="l00120"></a>00120 */ +<a name="l00121"></a><a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a">00121</a> void <a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(const list<string> &args) { +<a name="l00122"></a>00122 list<string>::const_iterator it; +<a name="l00123"></a>00123 string data; +<a name="l00124"></a>00124 uint16_t dataSize = 0; +<a name="l00125"></a>00125 +<a name="l00126"></a>00126 for (it = args.begin(); it != args.end(); it++) { +<a name="l00127"></a>00127 dataSize += it->size() + 1; +<a name="l00128"></a>00128 } +<a name="l00129"></a>00129 data.reserve(dataSize + sizeof(dataSize)); +<a name="l00130"></a>00130 dataSize = htons(dataSize); +<a name="l00131"></a>00131 data.append((const char *) &dataSize, sizeof(dataSize)); +<a name="l00132"></a>00132 for (it = args.begin(); it != args.end(); it++) { +<a name="l00133"></a>00133 data.append(*it); +<a name="l00134"></a>00134 data.append(1, DELIMITER); +<a name="l00135"></a>00135 } +<a name="l00136"></a>00136 +<a name="l00137"></a>00137 <a class="code" href="classPassenger_1_1MessageChannel.html#069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>(data); +<a name="l00138"></a>00138 } +<a name="l00139"></a>00139 +<a name="l00140"></a>00140 /** +<a name="l00141"></a>00141 * Send an array message, which consists of the given strings, over the underlying +<a name="l00142"></a>00142 * file descriptor. +<a name="l00143"></a>00143 * +<a name="l00144"></a>00144 * @param name The first element of the message to send. +<a name="l00145"></a>00145 * @param ... Other elements of the message. These *must* be strings, i.e. of type char*. +<a name="l00146"></a>00146 * It is also required to terminate this list with a NULL. +<a name="l00147"></a>00147 * @throws SystemException An error occured while writing the data to the file descriptor. +<a name="l00148"></a>00148 * @pre None of the message elements may contain a NUL character (<tt>'\\0'</tt>). +<a name="l00149"></a>00149 * @see read(), write(const list<string> &) +<a name="l00150"></a>00150 */ +<a name="l00151"></a><a class="code" href="classPassenger_1_1MessageChannel.html#12cce3364023eacbe4fe09006cf3d38d">00151</a> void <a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(const char *name, ...) { +<a name="l00152"></a>00152 list<string> args; +<a name="l00153"></a>00153 args.push_back(name); +<a name="l00154"></a>00154 +<a name="l00155"></a>00155 va_list ap; +<a name="l00156"></a>00156 va_start(ap, name); +<a name="l00157"></a>00157 while (true) { +<a name="l00158"></a>00158 const char *arg = va_arg(ap, const char *); +<a name="l00159"></a>00159 if (arg == NULL) { +<a name="l00160"></a>00160 break; +<a name="l00161"></a>00161 } else { +<a name="l00162"></a>00162 args.push_back(arg); +<a name="l00163"></a>00163 } +<a name="l00164"></a>00164 } +<a name="l00165"></a>00165 va_end(ap); +<a name="l00166"></a>00166 <a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>(args); +<a name="l00167"></a>00167 } +<a name="l00168"></a>00168 +<a name="l00169"></a>00169 /** +<a name="l00170"></a>00170 * Send a scalar message over the underlying file descriptor. +<a name="l00171"></a>00171 * +<a name="l00172"></a>00172 * @param str The scalar message's content. +<a name="l00173"></a>00173 * @throws SystemException An error occured while writing the data to the file descriptor. +<a name="l00174"></a>00174 * @see readScalar(), writeScalar(const char *, unsigned int) +<a name="l00175"></a>00175 */ +<a name="l00176"></a><a class="code" href="classPassenger_1_1MessageChannel.html#44e01a783c48abadeea0d915b9893bfb">00176</a> void <a class="code" href="classPassenger_1_1MessageChannel.html#44e01a783c48abadeea0d915b9893bfb" title="Send a scalar message over the underlying file descriptor.">writeScalar</a>(const string &str) { +<a name="l00177"></a>00177 <a class="code" href="classPassenger_1_1MessageChannel.html#44e01a783c48abadeea0d915b9893bfb" title="Send a scalar message over the underlying file descriptor.">writeScalar</a>(str.c_str(), str.size()); +<a name="l00178"></a>00178 } +<a name="l00179"></a>00179 +<a name="l00180"></a>00180 /** +<a name="l00181"></a>00181 * Send a scalar message over the underlying file descriptor. +<a name="l00182"></a>00182 * +<a name="l00183"></a>00183 * @param data The scalar message's content. +<a name="l00184"></a>00184 * @param size The number of bytes in <tt>data</tt>. +<a name="l00185"></a>00185 * @pre <tt>data != NULL</tt> +<a name="l00186"></a>00186 * @throws SystemException An error occured while writing the data to the file descriptor. +<a name="l00187"></a>00187 * @see readScalar(), writeScalar(const string &) +<a name="l00188"></a>00188 */ +<a name="l00189"></a><a class="code" href="classPassenger_1_1MessageChannel.html#80977020ef895f3ea790c5d28a333dda">00189</a> void <a class="code" href="classPassenger_1_1MessageChannel.html#44e01a783c48abadeea0d915b9893bfb" title="Send a scalar message over the underlying file descriptor.">writeScalar</a>(const char *data, unsigned int size) { +<a name="l00190"></a>00190 uint32_t l = htonl(size); +<a name="l00191"></a>00191 <a class="code" href="classPassenger_1_1MessageChannel.html#069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>((const char *) &l, sizeof(uint32_t)); +<a name="l00192"></a>00192 <a class="code" href="classPassenger_1_1MessageChannel.html#069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>(data, size); +<a name="l00193"></a>00193 } +<a name="l00194"></a>00194 +<a name="l00195"></a>00195 /** +<a name="l00196"></a>00196 * Send a block of data over the underlying file descriptor. +<a name="l00197"></a>00197 * This method blocks until everything is sent. +<a name="l00198"></a>00198 * +<a name="l00199"></a>00199 * @param data The data to send. +<a name="l00200"></a>00200 * @param size The number of bytes in <tt>data</tt>. +<a name="l00201"></a>00201 * @pre <tt>data != NULL</tt> +<a name="l00202"></a>00202 * @throws SystemException An error occured while writing the data to the file descriptor. +<a name="l00203"></a>00203 * @see readRaw() +<a name="l00204"></a>00204 */ +<a name="l00205"></a><a class="code" href="classPassenger_1_1MessageChannel.html#069314e4c7e1fe8c8ab36e16d2cc5fef">00205</a> void <a class="code" href="classPassenger_1_1MessageChannel.html#069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>(const char *data, unsigned int size) { +<a name="l00206"></a>00206 ssize_t ret; +<a name="l00207"></a>00207 unsigned int written = 0; +<a name="l00208"></a>00208 do { +<a name="l00209"></a>00209 do { +<a name="l00210"></a>00210 ret =<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying..."> ::write</a>(fd, data + written, size - written); +<a name="l00211"></a>00211 } while (ret == -1 && errno == EINTR); +<a name="l00212"></a>00212 if (ret == -1) { +<a name="l00213"></a>00213 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("write() failed", errno); +<a name="l00214"></a>00214 } else { +<a name="l00215"></a>00215 written += ret; +<a name="l00216"></a>00216 } +<a name="l00217"></a>00217 } while (written < size); +<a name="l00218"></a>00218 } +<a name="l00219"></a>00219 +<a name="l00220"></a>00220 /** +<a name="l00221"></a>00221 * Send a block of data over the underlying file descriptor. +<a name="l00222"></a>00222 * This method blocks until everything is sent. +<a name="l00223"></a>00223 * +<a name="l00224"></a>00224 * @param data The data to send. +<a name="l00225"></a>00225 * @pre <tt>data != NULL</tt> +<a name="l00226"></a>00226 * @throws SystemException An error occured while writing the data to the file descriptor. +<a name="l00227"></a>00227 */ +<a name="l00228"></a><a class="code" href="classPassenger_1_1MessageChannel.html#cfa38f4f0e22ec16350b8cc159e8e364">00228</a> void <a class="code" href="classPassenger_1_1MessageChannel.html#069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>(const string &data) { +<a name="l00229"></a>00229 <a class="code" href="classPassenger_1_1MessageChannel.html#069314e4c7e1fe8c8ab36e16d2cc5fef" title="Send a block of data over the underlying file descriptor.">writeRaw</a>(data.c_str(), data.size()); +<a name="l00230"></a>00230 } +<a name="l00231"></a>00231 +<a name="l00232"></a>00232 /** +<a name="l00233"></a>00233 * Pass a file descriptor. This only works if the underlying file +<a name="l00234"></a>00234 * descriptor is a Unix socket. +<a name="l00235"></a>00235 * +<a name="l00236"></a>00236 * @param fileDescriptor The file descriptor to pass. +<a name="l00237"></a>00237 * @throws SystemException Something went wrong during file descriptor passing. +<a name="l00238"></a>00238 * @pre <tt>fileDescriptor >= 0</tt> +<a name="l00239"></a>00239 * @see readFileDescriptor() +<a name="l00240"></a>00240 */ +<a name="l00241"></a><a class="code" href="classPassenger_1_1MessageChannel.html#73e3f3cda384c085a2af0e820ccd3e98">00241</a> void <a class="code" href="classPassenger_1_1MessageChannel.html#73e3f3cda384c085a2af0e820ccd3e98" title="Pass a file descriptor.">writeFileDescriptor</a>(int fileDescriptor) { +<a name="l00242"></a>00242 struct msghdr msg; +<a name="l00243"></a>00243 struct iovec vec[1]; +<a name="l00244"></a>00244 char buf[1]; +<a name="l00245"></a>00245 struct { +<a name="l00246"></a>00246 struct cmsghdr hdr; +<a name="l00247"></a>00247 int fd; +<a name="l00248"></a>00248 } cmsg; +<a name="l00249"></a>00249 +<a name="l00250"></a>00250 msg.msg_name = NULL; +<a name="l00251"></a>00251 msg.msg_namelen = 0; +<a name="l00252"></a>00252 +<a name="l00253"></a>00253 /* Linux and Solaris doesn't work if msg_iov is NULL. */ +<a name="l00254"></a>00254 buf[0] = '\0'; +<a name="l00255"></a>00255 vec[0].iov_base = buf; +<a name="l00256"></a>00256 vec[0].iov_len = 1; +<a name="l00257"></a>00257 msg.msg_iov = vec; +<a name="l00258"></a>00258 msg.msg_iovlen = 1; +<a name="l00259"></a>00259 +<a name="l00260"></a>00260 msg.msg_control = (caddr_t)&cmsg; +<a name="l00261"></a>00261 msg.msg_controllen = CMSG_SPACE(sizeof(int)); +<a name="l00262"></a>00262 msg.msg_flags = 0; +<a name="l00263"></a>00263 cmsg.hdr.cmsg_len = CMSG_LEN(sizeof(int)); +<a name="l00264"></a>00264 cmsg.hdr.cmsg_level = SOL_SOCKET; +<a name="l00265"></a>00265 cmsg.hdr.cmsg_type = SCM_RIGHTS; +<a name="l00266"></a>00266 cmsg.fd = fileDescriptor; +<a name="l00267"></a>00267 +<a name="l00268"></a>00268 if (sendmsg(fd, &msg, 0) == -1) { +<a name="l00269"></a>00269 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("Cannot send file descriptor with sendmsg()", errno); +<a name="l00270"></a>00270 } +<a name="l00271"></a>00271 } +<a name="l00272"></a>00272 +<a name="l00273"></a>00273 /** +<a name="l00274"></a>00274 * Receive a message from the underlying file descriptor. +<a name="l00275"></a>00275 * +<a name="l00276"></a>00276 * @param args The message will be put in this variable. +<a name="l00277"></a>00277 * @return Whether end-of-file has been reached. If so, then the contents +<a name="l00278"></a>00278 * of <tt>args</tt> will be undefined. +<a name="l00279"></a>00279 * @throws SystemException If an error occured while receiving the message. +<a name="l00280"></a>00280 * @see write() +<a name="l00281"></a>00281 */ +<a name="l00282"></a><a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e">00282</a> bool <a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor.">read</a>(vector<string> &args) { +<a name="l00283"></a>00283 uint16_t size; +<a name="l00284"></a>00284 int ret; +<a name="l00285"></a>00285 unsigned int alreadyRead = 0; +<a name="l00286"></a>00286 +<a name="l00287"></a>00287 do { +<a name="l00288"></a>00288 do { +<a name="l00289"></a>00289 ret =<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor."> ::read</a>(fd, (char *) &size + alreadyRead, sizeof(size) - alreadyRead); +<a name="l00290"></a>00290 } while (ret == -1 && errno == EINTR); +<a name="l00291"></a>00291 if (ret == -1) { +<a name="l00292"></a>00292 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("read() failed", errno); +<a name="l00293"></a>00293 } else if (ret == 0) { +<a name="l00294"></a>00294 return false; +<a name="l00295"></a>00295 } +<a name="l00296"></a>00296 alreadyRead += ret; +<a name="l00297"></a>00297 } while (alreadyRead < sizeof(size)); +<a name="l00298"></a>00298 size = ntohs(size); +<a name="l00299"></a>00299 +<a name="l00300"></a>00300 string buffer; +<a name="l00301"></a>00301 args.clear(); +<a name="l00302"></a>00302 buffer.reserve(size); +<a name="l00303"></a>00303 while (buffer.size() < size) { +<a name="l00304"></a>00304 char tmp[1024 * 8]; +<a name="l00305"></a>00305 do { +<a name="l00306"></a>00306 ret =<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor."> ::read</a>(fd, tmp, min(size - buffer.size(), sizeof(tmp))); +<a name="l00307"></a>00307 } while (ret == -1 && errno == EINTR); +<a name="l00308"></a>00308 if (ret == -1) { +<a name="l00309"></a>00309 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("read() failed", errno); +<a name="l00310"></a>00310 } else if (ret == 0) { +<a name="l00311"></a>00311 return false; +<a name="l00312"></a>00312 } +<a name="l00313"></a>00313 buffer.append(tmp, ret); +<a name="l00314"></a>00314 } +<a name="l00315"></a>00315 +<a name="l00316"></a>00316 if (!buffer.empty()) { +<a name="l00317"></a>00317 string::size_type start = 0, pos; +<a name="l00318"></a>00318 const string &const_buffer(buffer); +<a name="l00319"></a>00319 while ((pos = const_buffer.find('\0', start)) != string::npos) { +<a name="l00320"></a>00320 args.push_back(const_buffer.substr(start, pos - start)); +<a name="l00321"></a>00321 start = pos + 1; +<a name="l00322"></a>00322 } +<a name="l00323"></a>00323 } +<a name="l00324"></a>00324 return true; +<a name="l00325"></a>00325 } +<a name="l00326"></a>00326 +<a name="l00327"></a>00327 /** +<a name="l00328"></a>00328 * Read a scalar message from the underlying file descriptor. +<a name="l00329"></a>00329 * +<a name="l00330"></a>00330 * @param output The message will be put in here. +<a name="l00331"></a>00331 * @returns Whether end-of-file was reached during reading. +<a name="l00332"></a>00332 * @throws SystemException An error occured while writing the data to the file descriptor. +<a name="l00333"></a>00333 * @see writeScalar() +<a name="l00334"></a>00334 */ +<a name="l00335"></a><a class="code" href="classPassenger_1_1MessageChannel.html#4ce6a0e751b5e3563bee583c231569bc">00335</a> bool <a class="code" href="classPassenger_1_1MessageChannel.html#4ce6a0e751b5e3563bee583c231569bc" title="Read a scalar message from the underlying file descriptor.">readScalar</a>(string &output) { +<a name="l00336"></a>00336 uint32_t size; +<a name="l00337"></a>00337 unsigned int remaining; +<a name="l00338"></a>00338 +<a name="l00339"></a>00339 if (!<a class="code" href="classPassenger_1_1MessageChannel.html#cd1d1bd1cc787784c8b54f5471fff479" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(&size, sizeof(uint32_t))) { +<a name="l00340"></a>00340 return false; +<a name="l00341"></a>00341 } +<a name="l00342"></a>00342 size = ntohl(size); +<a name="l00343"></a>00343 +<a name="l00344"></a>00344 output.clear(); +<a name="l00345"></a>00345 output.reserve(size); +<a name="l00346"></a>00346 remaining = size; +<a name="l00347"></a>00347 while (remaining > 0) { +<a name="l00348"></a>00348 char buf[1024 * 32]; +<a name="l00349"></a>00349 unsigned int blockSize = min((unsigned int) sizeof(buf), remaining); +<a name="l00350"></a>00350 +<a name="l00351"></a>00351 if (!<a class="code" href="classPassenger_1_1MessageChannel.html#cd1d1bd1cc787784c8b54f5471fff479" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(buf, blockSize)) { +<a name="l00352"></a>00352 return false; +<a name="l00353"></a>00353 } +<a name="l00354"></a>00354 output.append(buf, blockSize); +<a name="l00355"></a>00355 remaining -= blockSize; +<a name="l00356"></a>00356 } +<a name="l00357"></a>00357 return true; +<a name="l00358"></a>00358 } +<a name="l00359"></a>00359 +<a name="l00360"></a>00360 /** +<a name="l00361"></a>00361 * Read exactly <tt>size</tt> bytes of data from the underlying file descriptor, +<a name="l00362"></a>00362 * and put the result in <tt>buf</tt>. If end-of-file has been reached, or if +<a name="l00363"></a>00363 * end-of-file was encountered before <tt>size</tt> bytes have been read, then +<a name="l00364"></a>00364 * <tt>false</tt> will be returned. Otherwise (i.e. if the read was successful), +<a name="l00365"></a>00365 * <tt>true</tt> will be returned. +<a name="l00366"></a>00366 * +<a name="l00367"></a>00367 * @param buf The buffer to place the read data in. This buffer must be at least +<a name="l00368"></a>00368 * <tt>size</tt> bytes long. +<a name="l00369"></a>00369 * @param size The number of bytes to read. +<a name="l00370"></a>00370 * @return Whether reading was successful or whether EOF was reached. +<a name="l00371"></a>00371 * @pre buf != NULL +<a name="l00372"></a>00372 * @throws SystemException Something went wrong during reading. +<a name="l00373"></a>00373 * @see writeRaw() +<a name="l00374"></a>00374 */ +<a name="l00375"></a><a class="code" href="classPassenger_1_1MessageChannel.html#cd1d1bd1cc787784c8b54f5471fff479">00375</a> bool <a class="code" href="classPassenger_1_1MessageChannel.html#cd1d1bd1cc787784c8b54f5471fff479" title="Read exactly size bytes of data from the underlying file descriptor, and put the...">readRaw</a>(void *buf, unsigned int size) { +<a name="l00376"></a>00376 ssize_t ret; +<a name="l00377"></a>00377 unsigned int alreadyRead = 0; +<a name="l00378"></a>00378 +<a name="l00379"></a>00379 while (alreadyRead < size) { +<a name="l00380"></a>00380 do { +<a name="l00381"></a>00381 ret =<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor."> ::read</a>(fd, (char *) buf + alreadyRead, size - alreadyRead); +<a name="l00382"></a>00382 } while (ret == -1 && errno == EINTR); +<a name="l00383"></a>00383 if (ret == -1) { +<a name="l00384"></a>00384 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("read() failed", errno); +<a name="l00385"></a>00385 } else if (ret == 0) { +<a name="l00386"></a>00386 return false; +<a name="l00387"></a>00387 } else { +<a name="l00388"></a>00388 alreadyRead += ret; +<a name="l00389"></a>00389 } +<a name="l00390"></a>00390 } +<a name="l00391"></a>00391 return true; +<a name="l00392"></a>00392 } +<a name="l00393"></a>00393 +<a name="l00394"></a>00394 /** +<a name="l00395"></a>00395 * Receive a file descriptor, which had been passed over the underlying +<a name="l00396"></a>00396 * file descriptor. +<a name="l00397"></a>00397 * +<a name="l00398"></a>00398 * @return The passed file descriptor. +<a name="l00399"></a>00399 * @throws SystemException If something went wrong during the +<a name="l00400"></a>00400 * receiving of a file descriptor. Perhaps the underlying +<a name="l00401"></a>00401 * file descriptor isn't a Unix socket. +<a name="l00402"></a>00402 * @throws IOException Whatever was received doesn't seem to be a +<a name="l00403"></a>00403 * file descriptor. +<a name="l00404"></a>00404 */ +<a name="l00405"></a><a class="code" href="classPassenger_1_1MessageChannel.html#1561b7e4a0f4d39ea431f456e5655488">00405</a> int <a class="code" href="classPassenger_1_1MessageChannel.html#1561b7e4a0f4d39ea431f456e5655488" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>() { +<a name="l00406"></a>00406 struct msghdr msg; +<a name="l00407"></a>00407 struct iovec vec[2]; +<a name="l00408"></a>00408 char buf[1]; +<a name="l00409"></a>00409 struct { +<a name="l00410"></a>00410 struct cmsghdr hdr; +<a name="l00411"></a>00411 int fd; +<a name="l00412"></a>00412 } cmsg; +<a name="l00413"></a>00413 +<a name="l00414"></a>00414 msg.msg_name = NULL; +<a name="l00415"></a>00415 msg.msg_namelen = 0; +<a name="l00416"></a>00416 +<a name="l00417"></a>00417 vec[0].iov_base = buf; +<a name="l00418"></a>00418 vec[0].iov_len = sizeof(buf); +<a name="l00419"></a>00419 msg.msg_iov = vec; +<a name="l00420"></a>00420 msg.msg_iovlen = 1; +<a name="l00421"></a>00421 +<a name="l00422"></a>00422 msg.msg_control = (caddr_t)&cmsg; +<a name="l00423"></a>00423 msg.msg_controllen = CMSG_SPACE(sizeof(int)); +<a name="l00424"></a>00424 msg.msg_flags = 0; +<a name="l00425"></a>00425 cmsg.hdr.cmsg_len = CMSG_LEN(sizeof(int)); +<a name="l00426"></a>00426 cmsg.hdr.cmsg_level = SOL_SOCKET; +<a name="l00427"></a>00427 cmsg.hdr.cmsg_type = SCM_RIGHTS; +<a name="l00428"></a>00428 cmsg.fd = -1; +<a name="l00429"></a>00429 +<a name="l00430"></a>00430 if (recvmsg(fd, &msg, 0) == -1) { +<a name="l00431"></a>00431 throw <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>("Cannot read file descriptor with recvmsg()", errno); +<a name="l00432"></a>00432 } +<a name="l00433"></a>00433 +<a name="l00434"></a>00434 if (msg.msg_controllen != CMSG_SPACE(sizeof(int)) +<a name="l00435"></a>00435 || cmsg.hdr.cmsg_len != CMSG_SPACE(0) + sizeof(int) +<a name="l00436"></a>00436 || cmsg.hdr.cmsg_level != SOL_SOCKET +<a name="l00437"></a>00437 || cmsg.hdr.cmsg_type != SCM_RIGHTS) { +<a name="l00438"></a>00438 throw <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>("No valid file descriptor received."); +<a name="l00439"></a>00439 } +<a name="l00440"></a>00440 return cmsg.fd; +<a name="l00441"></a>00441 } +<a name="l00442"></a>00442 }; +<a name="l00443"></a>00443 +<a name="l00444"></a>00444 } // namespace Passenger +<a name="l00445"></a>00445 +<a name="l00446"></a>00446 #endif /* _PASSENGER_MESSAGE_CHANNEL_H_ */ +</pre></div><hr size="1"><address style="text-align: right;">Generated on Fri Feb 22 10:18:25 2008 for Passenger by  <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </address> </body> doc/cxxapi/MessageChannel_8h-source.html @@ -169,137 +169,152 @@ <a name="l00154"></a>00154 * @param user The user to run the application as. <a name="l00155"></a>00155 * @param group The group to run the application as. <a name="l00156"></a>00156 * @return An Application smart pointer, representing the spawned application. -<a name="l00157"></a>00157 * @throws IOException -<a name="l00158"></a>00158 * @throws SystemException -<a name="l00159"></a>00159 */ -<a name="l00160"></a>00160 ApplicationPtr sendSpawnCommand(const string &appRoot, const string &user, const string &group) { -<a name="l00161"></a>00161 vector<string> args; -<a name="l00162"></a>00162 -<a name="l00163"></a>00163 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>("spawn_application", appRoot.c_str(), user.c_str(), group.c_str(), NULL); -<a name="l00164"></a>00164 if (!channel.<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor.">read</a>(args)) { -<a name="l00165"></a>00165 throw <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>("The spawn server has exited unexpectedly."); -<a name="l00166"></a>00166 } -<a name="l00167"></a>00167 pid_t pid = atoi(args.front().c_str()); -<a name="l00168"></a>00168 int listenSocket = channel.<a class="code" href="classPassenger_1_1MessageChannel.html#1561b7e4a0f4d39ea431f456e5655488" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>(); -<a name="l00169"></a>00169 return ApplicationPtr(new <a class="code" href="classPassenger_1_1Application.html" title="Represents a single Ruby on Rails application instance.">Application</a>(appRoot, pid, listenSocket)); -<a name="l00170"></a>00170 } -<a name="l00171"></a>00171 -<a name="l00172"></a>00172 template<typename E> ApplicationPtr -<a name="l00173"></a>00173 handleSpawnException(const E &e, const string &appRoot, const string &user, const string &group) { -<a name="l00174"></a>00174 bool restarted; -<a name="l00175"></a>00175 try { -<a name="l00176"></a>00176 P_DEBUG("Spawn server died. Attempting to restart it..."); -<a name="l00177"></a>00177 restartServer(); -<a name="l00178"></a>00178 P_DEBUG("Restart seems to be successful."); -<a name="l00179"></a>00179 restarted = true; -<a name="l00180"></a>00180 } catch (const <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a> &e) { -<a name="l00181"></a>00181 P_DEBUG("Restart failed: " << e.<a class="code" href="classPassenger_1_1IOException.html#1b65d0fdb9bc5136f5b7df759c14768a">what</a>()); -<a name="l00182"></a>00182 restarted = false; -<a name="l00183"></a>00183 } catch (const <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &e) { -<a name="l00184"></a>00184 P_DEBUG("Restart failed: " << e.<a class="code" href="classPassenger_1_1SystemException.html#ee405d1078ff3aa1045bc60b1c93d7a3">what</a>()); -<a name="l00185"></a>00185 restarted = false; -<a name="l00186"></a>00186 } -<a name="l00187"></a>00187 if (restarted) { -<a name="l00188"></a>00188 return sendSpawnCommand(appRoot, user, group); -<a name="l00189"></a>00189 } else { -<a name="l00190"></a>00190 string message("Could not spawn the application at '"); -<a name="l00191"></a>00191 message.append(appRoot); -<a name="l00192"></a>00192 message.append("'"); -<a name="l00193"></a>00193 throw prependMessageToException(e, message); -<a name="l00194"></a>00194 } -<a name="l00195"></a>00195 } -<a name="l00196"></a>00196 -<a name="l00197"></a>00197 <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a> prependMessageToException(const <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a> &e, const string &message) { -<a name="l00198"></a>00198 return <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(message + ": " + e.<a class="code" href="classPassenger_1_1IOException.html#1b65d0fdb9bc5136f5b7df759c14768a">what</a>()); -<a name="l00199"></a>00199 } -<a name="l00200"></a>00200 -<a name="l00201"></a>00201 <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> prependMessageToException(const <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &e, const string &message) { -<a name="l00202"></a>00202 return <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(message + ": " + e.<a class="code" href="classPassenger_1_1SystemException.html#84fa2ab4f5b7b96704734fcdfdaa0269" title="A brief version of the exception message.">brief</a>(), e.<a class="code" href="classPassenger_1_1SystemException.html#ee7a6672bf79b72a4c3ee70c57d6a47c" title="The value of errno at the time the error occured.">code</a>()); -<a name="l00203"></a>00203 } -<a name="l00204"></a>00204 -<a name="l00205"></a>00205 public: -<a name="l00206"></a>00206 /** -<a name="l00207"></a>00207 * Construct a new SpawnManager. -<a name="l00208"></a>00208 * -<a name="l00209"></a>00209 * @param spawnServerCommand The filename of the spawn server to use. -<a name="l00210"></a>00210 * @param logFile Specify a log file that the spawn server should use. -<a name="l00211"></a>00211 * Messages on its standard output and standard error channels -<a name="l00212"></a>00212 * will be written to this log file. If an empty string is -<a name="l00213"></a>00213 * specified, no log file will be used, and the spawn server -<a name="l00214"></a>00214 * will use the same standard output/error channels as the -<a name="l00215"></a>00215 * current process. -<a name="l00216"></a>00216 * @param environment The RAILS_ENV environment that all RoR applications -<a name="l00217"></a>00217 * should use. If an empty string is specified, the current value -<a name="l00218"></a>00218 * of the RAILS_ENV environment variable will be used. -<a name="l00219"></a>00219 * @param rubyCommand The Ruby interpreter's command. -<a name="l00220"></a>00220 * @throws SystemException An error occured while trying to setup the spawn server. -<a name="l00221"></a>00221 * @throws IOException The specified log file could not be opened. -<a name="l00222"></a>00222 */ -<a name="l00223"></a><a class="code" href="classPassenger_1_1SpawnManager.html#9cc7466414fe2ed29fb269ce7b4d4670">00223</a> <a class="code" href="classPassenger_1_1SpawnManager.html#9cc7466414fe2ed29fb269ce7b4d4670" title="Construct a new SpawnManager.">SpawnManager</a>(const string &spawnServerCommand, -<a name="l00224"></a>00224 const string &logFile = "", -<a name="l00225"></a>00225 const string &environment = "production", -<a name="l00226"></a>00226 const string &rubyCommand = "ruby") { -<a name="l00227"></a>00227 this->spawnServerCommand = spawnServerCommand; -<a name="l00228"></a>00228 this->logFile = logFile; -<a name="l00229"></a>00229 this->environment = environment; -<a name="l00230"></a>00230 this->rubyCommand = rubyCommand; -<a name="l00231"></a>00231 pid = 0; -<a name="l00232"></a>00232 try { -<a name="l00233"></a>00233 restartServer(); -<a name="l00234"></a>00234 } catch (const <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a> &e) { -<a name="l00235"></a>00235 throw prependMessageToException(e, "Could not start the spawn server"); -<a name="l00236"></a>00236 } catch (const <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &e) { -<a name="l00237"></a>00237 throw prependMessageToException(e, "Could not start the spawn server"); -<a name="l00238"></a>00238 } -<a name="l00239"></a>00239 } -<a name="l00240"></a>00240 -<a name="l00241"></a>00241 ~<a class="code" href="classPassenger_1_1SpawnManager.html">SpawnManager</a>() throw() { -<a name="l00242"></a>00242 if (pid != 0) { -<a name="l00243"></a>00243 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#06309e208fc5e10642a2e9bbe0f351eb" title="Close the underlying file descriptor.">close</a>(); -<a name="l00244"></a>00244 waitpid(pid, NULL, 0); -<a name="l00245"></a>00245 } -<a name="l00246"></a>00246 } -<a name="l00247"></a>00247 -<a name="l00248"></a>00248 /** -<a name="l00249"></a>00249 * Spawn a new instance of a Ruby on Rails application. -<a name="l00250"></a>00250 * -<a name="l00251"></a>00251 * If the spawn server died during the spawning process, then the server -<a name="l00252"></a>00252 * will be automatically restarted, and another spawn attempt will made made. -<a name="l00253"></a>00253 * If restarting the server fails, or if the second spawn attempt fails, -<a name="l00254"></a>00254 * then an exception will be thrown. -<a name="l00255"></a>00255 * -<a name="l00256"></a>00256 * @param appRoot The application root of a RoR application, i.e. the folder that -<a name="l00257"></a>00257 * contains 'app/', 'public/', 'config/', etc. This must be a valid directory, -<a name="l00258"></a>00258 * but the path does not have to be absolute. -<a name="l00259"></a>00259 * @param user The user to run the instance as. -<a name="l00260"></a>00260 * @param group The group to run the instance as. -<a name="l00261"></a>00261 * @return A smart pointer to an Application object, which represents the application -<a name="l00262"></a>00262 * instance that has been spawned. Use this object to communicate with the -<a name="l00263"></a>00263 * spawned application. -<a name="l00264"></a>00264 * @throws IOException Something went wrong. -<a name="l00265"></a>00265 * @throws SystemException Something went wrong. -<a name="l00266"></a>00266 */ -<a name="l00267"></a><a class="code" href="classPassenger_1_1SpawnManager.html#5949f7eea4a6b4ef88d5f4ba5031cf1a">00267</a> ApplicationPtr <a class="code" href="classPassenger_1_1SpawnManager.html#5949f7eea4a6b4ef88d5f4ba5031cf1a" title="Spawn a new instance of a Ruby on Rails application.">spawn</a>(const string &appRoot, const string &user = "", const string &group = "") { -<a name="l00268"></a>00268 vector<string> args; -<a name="l00269"></a>00269 mutex::scoped_lock l(lock); -<a name="l00270"></a>00270 -<a name="l00271"></a>00271 try { -<a name="l00272"></a>00272 return sendSpawnCommand(appRoot, user, group); -<a name="l00273"></a>00273 } catch (const <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a> &e) { -<a name="l00274"></a>00274 return handleSpawnException(e, appRoot, user, group); -<a name="l00275"></a>00275 } catch (const <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &e) { -<a name="l00276"></a>00276 return handleSpawnException(e, appRoot, user, group); -<a name="l00277"></a>00277 } -<a name="l00278"></a>00278 } -<a name="l00279"></a>00279 }; -<a name="l00280"></a>00280 -<a name="l00281"></a>00281 /** Convenient alias for SpawnManager smart pointer. */ -<a name="l00282"></a>00282 typedef shared_ptr<SpawnManager> SpawnManagerPtr; -<a name="l00283"></a>00283 -<a name="l00284"></a>00284 } // namespace Passenger -<a name="l00285"></a>00285 -<a name="l00286"></a>00286 #endif /* _PASSENGER_SPAWN_MANAGER_H_ */ -</pre></div><hr size="1"><address style="text-align: right;">Generated on Fri Feb 8 20:08:48 2008 for Passenger by  +<a name="l00157"></a>00157 * @throws SpawnException Something went wrong. +<a name="l00158"></a>00158 */ +<a name="l00159"></a>00159 ApplicationPtr sendSpawnCommand(const string &appRoot, const string &user, const string &group) { +<a name="l00160"></a>00160 vector<string> args; +<a name="l00161"></a>00161 +<a name="l00162"></a>00162 channel.<a class="code" href="classPassenger_1_1MessageChannel.html#9ad7a978cf8409e01ab2f0a2b6be5a0a" title="Send an array message, which consists of the given elements, over the underlying...">write</a>("spawn_application", appRoot.c_str(), user.c_str(), group.c_str(), NULL); +<a name="l00163"></a>00163 try { +<a name="l00164"></a>00164 if (!channel.<a class="code" href="classPassenger_1_1MessageChannel.html#129659b60d1a663337873d2af944431e" title="Receive a message from the underlying file descriptor.">read</a>(args)) { +<a name="l00165"></a>00165 throw <a class="code" href="classPassenger_1_1SpawnException.html" title="Thrown when SpawnManager or ApplicationPool fail to spawn an application instance...">SpawnException</a>("The spawn server has exited unexpectedly."); +<a name="l00166"></a>00166 } +<a name="l00167"></a>00167 } catch (const <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &e) { +<a name="l00168"></a>00168 throw <a class="code" href="classPassenger_1_1SpawnException.html" title="Thrown when SpawnManager or ApplicationPool fail to spawn an application instance...">SpawnException</a>(string("Could not read from the spawn server: ") + e.<a class="code" href="classPassenger_1_1SystemException.html#ee405d1078ff3aa1045bc60b1c93d7a3">what</a>()); +<a name="l00169"></a>00169 } +<a name="l00170"></a>00170 pid_t pid = <a class="code" href="group__Support.html#g73b17b509ee44938a56bf16cbf82fb48" title="Converts the given string to an integer.">atoi</a>(args.front().c_str()); +<a name="l00171"></a>00171 try { +<a name="l00172"></a>00172 int listenSocket = channel.<a class="code" href="classPassenger_1_1MessageChannel.html#1561b7e4a0f4d39ea431f456e5655488" title="Receive a file descriptor, which had been passed over the underlying file descriptor...">readFileDescriptor</a>(); +<a name="l00173"></a>00173 return ApplicationPtr(new <a class="code" href="classPassenger_1_1Application.html" title="Represents a single Ruby on Rails application instance.">Application</a>(appRoot, pid, listenSocket)); +<a name="l00174"></a>00174 } catch (const <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a> &e) { +<a name="l00175"></a>00175 string message("Could not receive a file descriptor from the spawn server: "); +<a name="l00176"></a>00176 message.append(e.<a class="code" href="classPassenger_1_1IOException.html#1b65d0fdb9bc5136f5b7df759c14768a">what</a>()); +<a name="l00177"></a>00177 throw <a class="code" href="classPassenger_1_1SpawnException.html" title="Thrown when SpawnManager or ApplicationPool fail to spawn an application instance...">SpawnException</a>(message); +<a name="l00178"></a>00178 } catch (const <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &e) { +<a name="l00179"></a>00179 string message("Could not receive a file descriptor from the spawn server: "); +<a name="l00180"></a>00180 message.append(e.<a class="code" href="classPassenger_1_1SystemException.html#ee405d1078ff3aa1045bc60b1c93d7a3">what</a>()); +<a name="l00181"></a>00181 throw <a class="code" href="classPassenger_1_1SpawnException.html" title="Thrown when SpawnManager or ApplicationPool fail to spawn an application instance...">SpawnException</a>(message); +<a name="l00182"></a>00182 } +<a name="l00183"></a>00183 } +<a name="l00184"></a>00184 +<a name="l00185"></a>00185 ApplicationPtr +<a name="l00186"></a>00186 handleSpawnException(const <a class="code" href="classPassenger_1_1SpawnException.html" title="Thrown when SpawnManager or ApplicationPool fail to spawn an application instance...">SpawnException</a> &e, const string &appRoot, const string &user, const string &group) { +<a name="l00187"></a>00187 bool restarted; +<a name="l00188"></a>00188 try { +<a name="l00189"></a>00189 P_DEBUG("Spawn server died. Attempting to restart it..."); +<a name="l00190"></a>00190 restartServer(); +<a name="l00191"></a>00191 P_DEBUG("Restart seems to be successful."); +<a name="l00192"></a>00192 restarted = true; +<a name="l00193"></a>00193 } catch (const <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a> &e) { +<a name="l00194"></a>00194 P_DEBUG("Restart failed: " << e.<a class="code" href="classPassenger_1_1IOException.html#1b65d0fdb9bc5136f5b7df759c14768a">what</a>()); +<a name="l00195"></a>00195 restarted = false; +<a name="l00196"></a>00196 } catch (const <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &e) { +<a name="l00197"></a>00197 P_DEBUG("Restart failed: " << e.<a class="code" href="classPassenger_1_1SystemException.html#ee405d1078ff3aa1045bc60b1c93d7a3">what</a>()); +<a name="l00198"></a>00198 restarted = false; +<a name="l00199"></a>00199 } +<a name="l00200"></a>00200 if (restarted) { +<a name="l00201"></a>00201 return sendSpawnCommand(appRoot, user, group); +<a name="l00202"></a>00202 } else { +<a name="l00203"></a>00203 throw <a class="code" href="classPassenger_1_1SpawnException.html" title="Thrown when SpawnManager or ApplicationPool fail to spawn an application instance...">SpawnException</a>("The spawn server died unexpectedly, and restarting it failed."); +<a name="l00204"></a>00204 } +<a name="l00205"></a>00205 } +<a name="l00206"></a>00206 +<a name="l00207"></a>00207 <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a> prependMessageToException(const <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a> &e, const string &message) { +<a name="l00208"></a>00208 return <a class="code" href="classPassenger_1_1IOException.html" title="Represents an error that occured during an I/O operation.">IOException</a>(message + ": " + e.<a class="code" href="classPassenger_1_1IOException.html#1b65d0fdb9bc5136f5b7df759c14768a">what</a>()); +<a name="l00209"></a>00209 } +<a name="l00210"></a>00210 +<a name="l00211"></a>00211 <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> prependMessageToException(const <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a> &e, const string &message) { +<a name="l00212"></a>00212 return <a class="code" href="classPassenger_1_1SystemException.html" title="Represents an error returned by a system call or a standard library call.">SystemException</a>(message + ": " + e.<a class="code" href="classPassenger_1_1SystemException.html#84fa2ab4f5b7b96704734fcdfdaa0269" title="A brief version of the exception message.">brief</a>(), e.<a class="code" href="classPassenger_1_1SystemException.html#ee7a6672bf79b72a4c3ee70c57d6a47c" title="The value of errno at the time the error occured.">code</a>()); +<a name="l00213"></a>00213 } +<a name="l00214"></a>00214 +<a name="l00215"></a>00215 public: +<a name="l00216"></a>00216 /** +<a name="l00217"></a>00217 * Construct a new SpawnManager. +<a name="l00218"></a>00218 * +<a name="l00219"></a>00219 * @param spawnServerCommand The filename of the spawn server to use. +<a name="l00220"></a>00220 * @param logFile Specify a log file that the spawn server should use. +<a name="l00221"></a>00221 * Messages on its standard output and standard error channels +<a name="l00222"></a>00222 * will be written to this log file. If an empty string is +<a name="l00223"></a>00223 * specified, no log file will be used, and the spawn server +<a name="l00224"></a>00224 * will use the same standard output/error channels as the +<a name="l00225"></a>00225 * current process. +<a name="l00226"></a>00226 * @param environment The RAILS_ENV environment that all RoR applications +<a name="l00227"></a>00227 * should use. If an empty string is specified, the current value +<a name="l00228"></a>00228 * of the RAILS_ENV environment variable will be used. +<a name="l00229"></a>00229 * @param rubyCommand The Ruby interpreter's command. +<a name="l00230"></a>00230 * @throws SystemException An error occured while trying to setup the spawn server. +<a name="l00231"></a>00231 * @throws IOException The specified log file could not be opened. +<a name="l00232"></a>00232 */ +<a name="l00233"></a><a class="code" href="classPassenger_1_1SpawnMana