~certify-web-dev/twisted/certify-trunk

<tr><td align="right">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.internet.process.Process.html" target="_top">no frames</a>]</td></tr>

</table></td>

</tr></table>

<h2 class="class">Class Process</h2>

<a href="twisted.persisted.styles.Ephemeral.html"><code>Ephemeral</code></a> --+

Process

</pre>

<hr/>

An operating-system Process.

This represents an operating-system process with arbitrary

input/output pipes connected to it. Those pipes may represent standard

input, standard output, and standard error, or any other file

descriptor.

On UNIX, this is implemented using fork(), exec(), pipe() and fcntl().

These calls may not exist elsewhere so this code is not cross-platform.

(also, windows can only select on sockets...)

<hr/>

<th colspan="2">Method Summary</th></tr>

<td><code><a href="twisted.internet.process.Process.html#__init__" class="summary-sig-name"><code>__init__</code></a>(self,

reactor,

command,

args,

environment,

path,

proto,

uid,

gid,

childFDs)</code>

Spawn an operating-system process.</td></tr>

<td><code><a name="_execChild"></a>_execChild(self,

path,

settingUID,

uid,

gid,

command,

args,

environment)</code>

</td></tr>

<td><code><a href="twisted.internet.process.Process.html#_setupChild" class="summary-sig-name"><code>_setupChild</code></a>(self,

fdmap)</code>

fdmap[childFD] = parentFD

The child wants to end up with 'childFD' attached to what used to be

the parent's parentFD.</td></tr>

100

101

<td><code><a name="childConnectionLost"></a>childConnectionLost(self,

102

childFD)</code>

103

</td></tr>

104

105

<td><code><a name="closeChildFD"></a>closeChildFD(self,

106

childFD)</code>

107

</td></tr>

108

109

<td><code><a name="closeStderr"></a>closeStderr(self)</code>

110

</td></tr>

111

112

<td><code><a href="twisted.internet.process.Process.html#closeStdin" class="summary-sig-name"><code>closeStdin</code></a>(self)</code>

113

114

Call this to close standard input on this process.</td></tr>

115

116

<td><code><a name="closeStdout"></a>closeStdout(self)</code>

117

</td></tr>

118

119

<td><code><a name="loseConnection"></a>loseConnection(self)</code>

120

</td></tr>

121

122

<td><code><a name="maybeCallProcessEnded"></a>maybeCallProcessEnded(self)</code>

123

</td></tr>

124

125

<td><code><a name="pauseProducing"></a>pauseProducing(self)</code>

126

</td></tr>

127

128

<td><code><a name="processEnded"></a>processEnded(self,

129

status)</code>

130

</td></tr>

131

132

<td><code><a href="twisted.internet.process.Process.html#reapProcess" class="summary-sig-name"><code>reapProcess</code></a>(self)</code>

133

134

Try to reap a process (without blocking) via waitpid.</td></tr>

135

136

<td><code><a name="resumeProducing"></a>resumeProducing(self)</code>

137

</td></tr>

138

139

<td><code><a name="signalProcess"></a>signalProcess(self,

140

signalID)</code>

141

</td></tr>

142

143

<td><code><a href="twisted.internet.process.Process.html#write" class="summary-sig-name"><code>write</code></a>(self,

144

data)</code>

145

146

Call this to write to standard input on this process.</td></tr>

147

148

<td><code><a name="writeToChild"></a>writeToChild(self,

149

childFD,

150

data)</code>

151

</td></tr>

152

153

<th colspan="2">    Inherited from Ephemeral</th></tr>

154

155

<td><code><a href="twisted.persisted.styles.Ephemeral.html#__getstate__" class="summary-sig-name"><code>__getstate__</code></a>(self)</code>

156

</td></tr>

157

158

<td><code><a href="twisted.persisted.styles.Ephemeral.html#__setstate__" class="summary-sig-name"><code>__setstate__</code></a>(self,

159

state)</code>

160

</td></tr>

161

</table>

162

163

164

165

166

167

<th colspan="2">Class Variable Summary</th></tr>

168

169

<td><a href="twisted.internet.process.Process.html#debug"><code>debug</code></a> = 0                                                                     </td></tr>

170

171

<td><a href="twisted.internet.process.Process.html#debug_child"><code>debug_child</code></a> = 0                                                                     </td></tr>

172

</table>

173

174

175

176

177

178

<th colspan="2">Method Details</th></tr>

179

</table>

180

181

182

183

<h3>__init__(self,

184

reactor,

185

command,

186

args,

187

environment,

188

path,

189

proto,

190

uid=None,

191

gid=None,

192

childFDs=None)

193

(Constructor)

194

</h3>

195

196

Spawn an operating-system process.

197

198

This is where the hard work of disconnecting all currently open

199

files / forking / executing the new process happens. (This is

200

executed automatically when a Process is instantiated.)

201

202

This will also run the subprocess as a given user ID and group ID, if

203

specified. (Implementation Note: this doesn't support all the arcane

204

nuances of setXXuid on UNIX: it will assume that either your effective

205

or real UID is 0.)

206

207

@param childFDs: a dictionary mapping

208

fd_in_child -> current_fd_in_parent/'r'/'w'

209

210

If the value is a number, it specifies one of the parent's fds

211

that will be remapped to the child's fd. This is useful for

212

things like inetd and shell-like file redirection.

213

214

If it is the string 'r', a pipe will be created and attached to

215

the child at that fd number, and the parent will be able to

216

read from the pipe. This is useful for the child's stdout and

217

stderr.

218

219

If it is the string 'w', a pipe will be created and attached,

220

and the parent will be able to write into that pipe. This is

221

useful for the child's stdin.

222

223

If childFDs is not passed, the default behaviour is to use a

224

mapping that opens the usual stdin/stdout/stderr pipes.

225

</pre>

226

227

</dd></dl>

228

</td></tr></table>

229

230

231

232

<h3>_setupChild(self,

233

fdmap)

234

</h3>

235

236

fdmap[childFD] = parentFD

237

238

The child wants to end up with 'childFD' attached to what used to be

239

the parent's parentFD. As an example, a bash command run like

240

'command 2>&1' would correspond to an fdmap of {0:0, 1:1, 2:1}.

241

'command >foo.txt' would be {0:0, 1:os.open('foo.txt'), 2:2}.

242

243

Step 1: close all file descriptors that aren't values of fdmap.

244

This means 0 .. maxfds.

245

246

Step 2: for each childFD:

247

if fdmap[childFD] == childFD, the descriptor is already in place.

248

Make sure the CLOEXEC flag is not set, then delete the entry from

249

fdmap.

250

251

if childFD is in fdmap.values(), then the target descriptor is

252

busy. Use os.dup() to move it elsewhere, update all fdmap[childFD]

253

items that point to it, then close the original. Then fall through

254

to the next case.

255

256

now fdmap[childFD] is not in fdmap.values(), and is free. Use

257

os.dup2() to move it to the right place, then close the original.

258

</pre>

259

260

</dd></dl>

261

</td></tr></table>

262

263

264

265

<h3>closeStdin(self)

266

</h3>

267

Call this to close standard input on this process.

268

269

</dd></dl>

270

</td></tr></table>

271

272

273

274

<h3>reapProcess(self)

275

</h3>

276

Try to reap a process (without blocking) via waitpid.

277

This is called when sigchild is caught or a Process object loses its

278

"connection" (stdout is closed) This ought to result in

279

reaping all zombie processes, since it will be called twice as often as

280

it needs to be.

281

(Unfortunately, this is a slightly experimental approach, since UNIX

282

has no way to be really sure that your process is going to go away w/o

283

blocking. I don't want to block.)

284

285

</dd></dl>

286

</td></tr></table>

287

288

289

290

<h3>write(self,

291

data)

292

</h3>

293

Call this to write to standard input on this process.

294

295

</dd></dl>

296

</td></tr></table>

297

298

299

300

301

302

303

<th colspan="2">Class Variable Details</th></tr>

304

</table>

305

306

307

<h3>debug</h3>

308

<dl>

309

310

<dd>

311

<dl>

312

313

<dd>

314

315

316

</dd>

317

<dt>Value:</dt>

318

319

320

0                                                                     </pre>

321

</td></tr></table></dd>

322

</dl>

323

</dd>

324

</dl></td></tr></table>

325

326

327

<h3>debug_child</h3>

328

<dl>

329

330

<dd>

331

<dl>

332

333

<dd>

334

335

336

</dd>

337

<dt>Value:</dt>

338

339

340

0                                                                     </pre>

341

</td></tr></table></dd>

342

</dl>

343

</dd>

344

</dl></td></tr></table>

345

346

347

348

349

350

351

352

<th class="navbar">   <a class="navbar" href="trees.html">Trees</a>   </th>

353

<th class="navbar">   <a class="navbar" href="indices.html">Index</a>   </th>

354

355

356

357

358

359

<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>

360

</th></tr></table>

361

</th>

362

</tr>

363

</table>

364

365

366

<tr>

367

<td align="left">Generated by Epydoc 2.0 on Sat May 15 20:08:06 2004</td>

368

<td align="right"><a href="http://epydoc.sourceforge.net"

369

>http://epydoc.sf.net</a></td>

370

</tr>

371

</table>

372

</body>

373

</html>

Older »