1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Passenger: AbstractSpawnManager.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<h1>AbstractSpawnManager.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Phusion Passenger - http://www.modrails.com/</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright (c) 2010 Phusion</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * "Phusion Passenger" is a trademark of Hongli Lai & Ninh Bui.</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span>
<a name="l00008"></a>00008 <span class="comment"> * of this software and associated documentation files (the "Software"), to deal</span>
<a name="l00009"></a>00009 <span class="comment"> * in the Software without restriction, including without limitation the rights</span>
<a name="l00010"></a>00010 <span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
<a name="l00011"></a>00011 <span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span>
<a name="l00012"></a>00012 <span class="comment"> * furnished to do so, subject to the following conditions:</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> * The above copyright notice and this permission notice shall be included in</span>
<a name="l00015"></a>00015 <span class="comment"> * all copies or substantial portions of the Software.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
<a name="l00018"></a>00018 <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
<a name="l00019"></a>00019 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
<a name="l00020"></a>00020 <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
<a name="l00021"></a>00021 <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
<a name="l00022"></a>00022 <span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
<a name="l00023"></a>00023 <span class="comment"> * THE SOFTWARE.</span>
<a name="l00024"></a>00024 <span class="comment"> */</span>
<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_ABSTRACT_SPAWN_MANAGER_H_</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_ABSTRACT_SPAWN_MANAGER_H_</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <string></span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="preprocessor">#include <boost/shared_ptr.hpp></span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="preprocessor">#include <unistd.h></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="preprocessor">#include "Process.h"</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include "PoolOptions.h"</span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="keyword">namespace </span>Passenger {
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="keyword">using namespace </span>std;
<a name="l00040"></a>00040 <span class="keyword">using namespace </span>boost;
<a name="l00041"></a>00041 <span class="comment"></span>
<a name="l00042"></a>00042 <span class="comment">/**</span>
<a name="l00043"></a>00043 <span class="comment"> * @brief Spawning of application processes.</span>
<a name="l00044"></a>00044 <span class="comment"> *</span>
<a name="l00045"></a>00045 <span class="comment"> * An AbstractSpawnManager is responsible for spawning new application processes.</span>
<a name="l00046"></a>00046 <span class="comment"> * Use the spawn() method to do so. AbstractSpawnManager is guaranteed to be thread-safe.</span>
<a name="l00047"></a>00047 <span class="comment"> *</span>
<a name="l00048"></a>00048 <span class="comment"> * AbstractSpawnManager is just an interface. There are two concrete implementations,</span>
<a name="l00049"></a>00049 <span class="comment"> * namely SpawnManager and StubSpawnManager. The former is the one that's usually used,</span>
<a name="l00050"></a>00050 <span class="comment"> * while the latter exists for unit testing purposes.</span>
<a name="l00051"></a>00051 <span class="comment"> *</span>
<a name="l00052"></a>00052 <span class="comment"> * @ingroup Support</span>
<a name="l00053"></a>00053 <span class="comment"> */</span>
<a name="l00054"></a><a class="code" href="classPassenger_1_1AbstractSpawnManager.html">00054</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1AbstractSpawnManager.html" title="Spawning of application processes.">AbstractSpawnManager</a> {
<a name="l00055"></a>00055 <span class="keyword">public</span>:
<a name="l00056"></a>00056 <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1AbstractSpawnManager.html" title="Spawning of application processes.">AbstractSpawnManager</a>() { }
<a name="l00057"></a>00057 <span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment"> /**</span>
<a name="l00059"></a>00059 <span class="comment"> * Spawn a new application process. Spawning details are to be passed</span>
<a name="l00060"></a>00060 <span class="comment"> * via the <tt>options</tt> argument.</span>
<a name="l00061"></a>00061 <span class="comment"> *</span>
<a name="l00062"></a>00062 <span class="comment"> * If the spawn server died during the spawning process, then the server</span>
<a name="l00063"></a>00063 <span class="comment"> * will be automatically restarted, and another spawn attempt will be made.</span>
<a name="l00064"></a>00064 <span class="comment"> * If restarting the server fails, or if the second spawn attempt fails,</span>
<a name="l00065"></a>00065 <span class="comment"> * then an exception will be thrown.</span>
<a name="l00066"></a>00066 <span class="comment"> *</span>
<a name="l00067"></a>00067 <span class="comment"> * @param options An object containing the details for this spawn operation,</span>
<a name="l00068"></a>00068 <span class="comment"> * such as which application to spawn. See PoolOptions for details.</span>
<a name="l00069"></a>00069 <span class="comment"> * @return A smart pointer to a Process object, which represents the application</span>
<a name="l00070"></a>00070 <span class="comment"> * process that has been spawned. Use this object to communicate with the</span>
<a name="l00071"></a>00071 <span class="comment"> * spawned process.</span>
<a name="l00072"></a>00072 <span class="comment"> * @throws SpawnException Something went wrong.</span>
<a name="l00073"></a>00073 <span class="comment"> * @throws boost::thread_interrupted</span>
<a name="l00074"></a>00074 <span class="comment"> * @throws Anything thrown by options.environmentVariables->getItems().</span>
<a name="l00075"></a>00075 <span class="comment"> */</span>
<a name="l00076"></a>00076 <span class="keyword">virtual</span> <a class="code" href="namespacePassenger.html#ced1f248465136b313c6dec5fe6ca492" title="Convenient alias for Process smart pointer.">ProcessPtr</a> <a class="code" href="classPassenger_1_1AbstractSpawnManager.html#6ca7efc68595bf962f5cce5e6407f176" title="Spawn a new application process.">spawn</a>(<span class="keyword">const</span> <a class="code" href="structPassenger_1_1PoolOptions.html" title="This struct encapsulates information for ApplicationPool::get() and for SpawnManager::spawn()...">PoolOptions</a> &options) = 0;
<a name="l00077"></a>00077 <span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment"> /**</span>
<a name="l00079"></a>00079 <span class="comment"> * Shutdown the ApplicationSpawner server that's running at the given</span>
<a name="l00080"></a>00080 <span class="comment"> * application root. This method should be called when it's time to reload</span>
<a name="l00081"></a>00081 <span class="comment"> * an application.</span>
<a name="l00082"></a>00082 <span class="comment"> *</span>
<a name="l00083"></a>00083 <span class="comment"> * @throws SystemException Unable to communicate with the spawn server,</span>
<a name="l00084"></a>00084 <span class="comment"> * even after a restart.</span>
<a name="l00085"></a>00085 <span class="comment"> * @throws SpawnException The spawn server died unexpectedly, and a</span>
<a name="l00086"></a>00086 <span class="comment"> * restart was attempted, but it failed.</span>
<a name="l00087"></a>00087 <span class="comment"> */</span>
<a name="l00088"></a>00088 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1AbstractSpawnManager.html#5043681dbfb9b77fa0679c510ede853c" title="Shutdown the ApplicationSpawner server that&#39;s running at the given application...">reload</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &appRoot) = 0;
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment"> /**</span>
<a name="l00091"></a>00091 <span class="comment"> * Forcefully kill the spawn server. This AbstractSpawnManager's state will</span>
<a name="l00092"></a>00092 <span class="comment"> * not be modified, so that it won't know that the spawn server is killed</span>
<a name="l00093"></a>00093 <span class="comment"> * until next time it sends a command to it.</span>
<a name="l00094"></a>00094 <span class="comment"> *</span>
<a name="l00095"></a>00095 <span class="comment"> * Used within unit tests.</span>
<a name="l00096"></a>00096 <span class="comment"> */</span>
<a name="l00097"></a>00097 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1AbstractSpawnManager.html#225574ef363847058554fde9d5704950" title="Forcefully kill the spawn server.">killSpawnServer</a>() <span class="keyword">const</span> = 0;
<a name="l00098"></a>00098 <span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment"> /**</span>
<a name="l00100"></a>00100 <span class="comment"> * Returns the spawn server's PID. Used within unit tests.</span>
<a name="l00101"></a>00101 <span class="comment"> */</span>
<a name="l00102"></a>00102 <span class="keyword">virtual</span> pid_t <a class="code" href="classPassenger_1_1AbstractSpawnManager.html#a630e8c364f391b54c0bfb723326836a" title="Returns the spawn server&#39;s PID.">getServerPid</a>() <span class="keyword">const</span> = 0;
<a name="l00103"></a>00103 };
<a name="l00104"></a>00104 <span class="comment"></span>
<a name="l00105"></a>00105 <span class="comment">/** Convenient alias for AbstractSpawnManager smart pointer. */</span>
<a name="l00106"></a><a class="code" href="namespacePassenger.html#fd60d942a89fbb7f306e330d75704570">00106</a> <span class="keyword">typedef</span> shared_ptr<AbstractSpawnManager> <a class="code" href="namespacePassenger.html#fd60d942a89fbb7f306e330d75704570" title="Convenient alias for AbstractSpawnManager smart pointer.">AbstractSpawnManagerPtr</a>;
<a name="l00107"></a>00107
<a name="l00108"></a>00108 } <span class="comment">// namespace Passenger</span>
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_ABSTRACT_SPAWN_MANAGER_H_ */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:45 2010 for Passenger by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
|
