twisted.internet.utils.html   [plain text]


<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>twisted.internet.utils</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">

<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="center">
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar" align="right" width="100%">
      <table border="0" cellpadding="0" cellspacing="0">
      <tr><th class="navbar" align="center">
        <p class="nomargin">
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
      </p></th></tr></table>
    </th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <font size="-1"><b class="breadcrumbs">
        <a href="twisted.html">Package&nbsp;twisted</a> ::
        <a href="twisted.internet.html">Package&nbsp;internet</a> ::
        Module&nbsp;utils
      </b></font></br>
    </td>
    <td><table cellpadding="0" cellspacing="0">
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="twisted.internet.utils.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
    </table></td>
</tr></table>

<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.internet.utils</h2>

Utility methods.
<hr/>

<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
  <th colspan="2">Classes</th></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.utils._BackRelay.html"><code>_BackRelay</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.utils._SRVConnector_ClientFactoryWrapper.html"><code>_SRVConnector_ClientFactoryWrapper</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.utils._ValueGetter.html"><code>_ValueGetter</code></a></b></td>
  <td>&nbsp;</td></tr>
<tr><td width="15%">
  <b><a href="twisted.internet.utils.SRVConnector.html"><code>SRVConnector</code></a></b></td>
  <td>A connector that looks up DNS SRV records.</td></tr>
</table><br />


<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
  <th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="_callProtocolWithDeferred"></a><span class="summary-sig"><span class="summary-sig-name">_callProtocolWithDeferred</span>(<span class=summary-sig-arg>protocol</span>,
          <span class=summary-sig-arg>executable</span>,
          <span class=summary-sig-arg>args</span>,
          <span class=summary-sig-arg>env</span>,
          <span class=summary-sig-arg>path</span>,
          <span class=summary-sig-arg>reactor</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.internet.utils.html#getProcessOutput" class="summary-sig-name"><code>getProcessOutput</code></a>(<span class=summary-sig-arg>executable</span>,
          <span class=summary-sig-arg>args</span>,
          <span class=summary-sig-arg>env</span>,
          <span class=summary-sig-arg>path</span>,
          <span class=summary-sig-arg>reactor</span>)</span></code>
<br />
Spawn a process and return its output as a deferred returning a 
string.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.internet.utils.html#getProcessValue" class="summary-sig-name"><code>getProcessValue</code></a>(<span class=summary-sig-arg>executable</span>,
          <span class=summary-sig-arg>args</span>,
          <span class=summary-sig-arg>env</span>,
          <span class=summary-sig-arg>path</span>,
          <span class=summary-sig-arg>reactor</span>)</span></code>
<br />
Spawn a process and return its exit code as a Deferred.</td></tr>
</table><br />


<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
  <th colspan="2">Function Details</th></tr>
</table>

<a name="getProcessOutput"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">getProcessOutput</span>(<span class=sig-arg>executable</span>,
          <span class=sig-arg>args</span>=<span class=sig-default>()</span>,
          <span class=sig-arg>env</span>=<span class=sig-default>{}</span>,
          <span class=sig-arg>path</span>=<span class=sig-default>'.'</span>,
          <span class=sig-arg>reactor</span>=<span class=sig-default>&lt;twisted.internet.default.SelectReactor&nbsp;instance&nbsp;at&nbsp;0x825...</span>)</span>
  </h3>
  Spawn a process and return its output as a deferred returning a 
  string.
  <dl><dt></dt><dd>
    <dl><dt><b>Parameters:</b></dt>
      <dd><code><b>executable</b></code> -
         The file name to run and get the output of - the full path 
        should be used.
      <dd><code><b>args</b></code> -
         the command line arguments to pass to the process; a sequence 
        of strings. The first string should *NOT* be the executable's 
        name.
      <dd><code><b>env</b></code> -
         the environment variables to pass to the processs; a 
        dictionary of strings.
      <dd><code><b>path</b></code> -
         the path to run the subprocess in - defaults to the current 
        directory.
      <dd><code><b>reactor</b></code> -
         the reactor to use - defaults to the default reactor
      </dd>
    </dl>
  </dd></dl>
</td></tr></table>

<a name="getProcessValue"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">getProcessValue</span>(<span class=sig-arg>executable</span>,
          <span class=sig-arg>args</span>=<span class=sig-default>()</span>,
          <span class=sig-arg>env</span>=<span class=sig-default>{}</span>,
          <span class=sig-arg>path</span>=<span class=sig-default>'.'</span>,
          <span class=sig-arg>reactor</span>=<span class=sig-default>&lt;twisted.internet.default.SelectReactor&nbsp;instance&nbsp;at&nbsp;0x825...</span>)</span>
  </h3>
  Spawn a process and return its exit code as a Deferred.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>
<br />


<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="center">
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar" align="right" width="100%">
      <table border="0" cellpadding="0" cellspacing="0">
      <tr><th class="navbar" align="center">
        <p class="nomargin">
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
      </p></th></tr></table>
    </th>
  </tr>
</table>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
  <tr>
    <td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:08 2004</font></td>
    <td align="right"><a href="http://epydoc.sourceforge.net"
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
  </tr>
</table>
</body>
</html>