<?xml version="1.0" encoding="ascii"?> <!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>flumotion.configure.configure</title> <link rel="stylesheet" href="epydoc.css" type="text/css" /> <script type="text/javascript" src="epydoc.js"></script> </head> <body bgcolor="white" text="black" link="blue" vlink="#204080" alink="#204080"> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <th class="navbar" width="100%"></th> </tr> </table> <table width="100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="100%"> <span class="breadcrumbs"> Package flumotion :: <a href="flumotion.configure-module.html">Package configure</a> :: Module configure </span> </td> <td> <table cellpadding="0" cellspacing="0"> <!-- hide/show private --> <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" onclick="toggle_private();">hide private</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== MODULE DESCRIPTION ==================== --> <h1 class="epydoc">Module configure</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.configure.configure-pysrc.html">source code</a></span></p> <p>configure-time variables for installed or uninstalled operation</p> <p>Code should run</p> <pre class="py-doctest"> <span class="py-prompt">>>> </span><span class="py-keyword">from</span> flumotion.configure <span class="py-keyword">import</span> configure</pre> <p>and then access the variables from the configure module. For example:</p> <pre class="py-doctest"> <span class="py-prompt">>>> </span><span class="py-keyword">print</span> configure.gladedir</pre> <p>The values are decided at ./configure time. They can be overridden at startup by programs based on environment or options. This allows running with different configdir, logdir and rundir.</p> <hr /> <div class="fields"> <p><strong>Version:</strong> $Rev: 7372 $ </p> </div><!-- ==================== FUNCTIONS ==================== --> <a name="section-Functions"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Functions</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Functions" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="_versionStringToTuple"></a><span class="summary-sig-name">_versionStringToTuple</span>(<span class="summary-sig-arg">versionString</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="flumotion.configure.configure-pysrc.html#_versionStringToTuple">source code</a></span> </td> </tr> </table> </td> </tr> </table> <!-- ==================== VARIABLES ==================== --> <a name="section-Variables"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Variables</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Variables" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="flumotion.configure.configure-module.html#__thisdir" class="summary-name" onclick="show_private();">__thisdir</a> = <code title="'/home/mandrake/rpm/BUILD/flumotion-0.6.1/flumotion/configure'"><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/flumotio</code><code class="variable-ellipsis">...</code></code> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a href="flumotion.configure.configure-module.html#_config" class="summary-name" onclick="show_private();">_config</a> = <code title="{'bindir': '/home/mandrake/rpm/BUILD/flumotion-0.6.1/bin', 'cachedir': '/home/mandrake/rpm/BUILD/flumotion-0.6.1/cache', 'configdir': '/home/mandrake/rpm/BUILD/flumotion-0.6.1/conf', 'daemondir': '/home/mandrake/rpm/BUILD/flumotion-0.6.1', 'datadir': '/home/mandrake/rpm/BUILD/flumotion-0.6.1/data', 'gladedir': '/home/mandrake/rpm/BUILD/flumotion-0.6.1/data/glade', 'imagedir': '/home/mandrake/rpm/BUILD/flumotion-0.6.1/data/image', 'isinstalled': False, ..."><code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">bindir</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1</code><code class="variable-ellipsis">...</code></code> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">boolean</span> </td><td class="summary"> <a name="isinstalled"></a><span class="summary-name">isinstalled</span> = <code title="False">False</code><br /> whether an installed version is being run </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">stringed</span> </td><td class="summary"> <a name="cachedir"></a><span class="summary-name">cachedir</span> = <code title="'/home/mandrake/rpm/BUILD/flumotion-0.6.1/cache'"><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/cache</code><code class="variable-quote">'</code></code><br /> directory where cached code is stored </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <a name="configdir"></a><span class="summary-name">configdir</span> = <code title="'/home/mandrake/rpm/BUILD/flumotion-0.6.1/conf'"><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/conf</code><code class="variable-quote">'</code></code><br /> directory where configuration files are stored </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <a name="daemondir"></a><span class="summary-name">daemondir</span> = <code title="'/home/mandrake/rpm/BUILD/flumotion-0.6.1'"><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1</code><code class="variable-quote">'</code></code><br /> directory where daemonized programs should run </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <a name="datadir"></a><span class="summary-name">datadir</span> = <code title="'/home/mandrake/rpm/BUILD/flumotion-0.6.1/data'"><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/data</code><code class="variable-quote">'</code></code><br /> directory where data files are stored </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <a name="gladedir"></a><span class="summary-name">gladedir</span> = <code title="'/home/mandrake/rpm/BUILD/flumotion-0.6.1/data/glade'"><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/data/glade</code><code class="variable-quote">'</code></code><br /> directory where glade files are stored </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <a name="imagedir"></a><span class="summary-name">imagedir</span> = <code title="'/home/mandrake/rpm/BUILD/flumotion-0.6.1/data/image'"><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/data/image</code><code class="variable-quote">'</code></code><br /> directory where image files are stored </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <a name="logdir"></a><span class="summary-name">logdir</span> = <code title="'/home/mandrake/rpm/BUILD/flumotion-0.6.1/log'"><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/log</code><code class="variable-quote">'</code></code><br /> directory where log files are stored </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="localedatadir"></a><span class="summary-name">localedatadir</span> = <code title="'/home/mandrake/rpm/BUILD/flumotion-0.6.1'"><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1</code><code class="variable-quote">'</code></code> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <a name="pythondir"></a><span class="summary-name">pythondir</span> = <code title="'/home/mandrake/rpm/BUILD/flumotion-0.6.1'"><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1</code><code class="variable-quote">'</code></code><br /> directory where the flumotion python files are stored </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <a href="flumotion.configure.configure-module.html#registrydir" class="summary-name">registrydir</a> = <code title="'/home/mandrake/rpm/BUILD/flumotion-0.6.1/cache/registry'"><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/cache/</code><code class="variable-ellipsis">...</code></code><br /> directory where the registry files are stored </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <a name="rundir"></a><span class="summary-name">rundir</span> = <code title="'/home/mandrake/rpm/BUILD/flumotion-0.6.1/run'"><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/run</code><code class="variable-quote">'</code></code><br /> directory where the run/pid files are stored </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <a name="bindir"></a><span class="summary-name">bindir</span> = <code title="'/home/mandrake/rpm/BUILD/flumotion-0.6.1/bin'"><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/bin</code><code class="variable-quote">'</code></code><br /> directory where the flumotion executables live </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <a name="sbindir"></a><span class="summary-name">sbindir</span> = <code title="'/home/mandrake/rpm/BUILD/flumotion-0.6.1/bin'"><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/bin</code><code class="variable-quote">'</code></code><br /> directory where the flumotion service program lives </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">int</span> </td><td class="summary"> <a name="defaultTCPManagerPort"></a><span class="summary-name">defaultTCPManagerPort</span> = <code title="8642">8642</code><br /> the default manager port for TCP communication </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">int</span> </td><td class="summary"> <a name="defaultSSLManagerPort"></a><span class="summary-name">defaultSSLManagerPort</span> = <code title="7531">7531</code><br /> the default manager port for SSL communication </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">int</span> </td><td class="summary"> <a name="defaultHTTPStreamPort"></a><span class="summary-name">defaultHTTPStreamPort</span> = <code title="8800">8800</code><br /> the default external http streaming port </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">list of ints</span> </td><td class="summary"> <a href="flumotion.configure.configure-module.html#defaultGstPortRange" class="summary-name">defaultGstPortRange</a> = <code title="[8600, 8601, 8602, 8603, 8604, 8605, 8606, 8607, ..."><code class="variable-group">[</code>8600<code class="variable-op">, </code>8601<code class="variable-op">, </code>8602<code class="variable-op">, </code>8603<code class="variable-op">, </code>8604<code class="variable-op">, </code>8605<code class="variable-op">, </code>860<code class="variable-ellipsis">...</code></code><br /> the default range of internal GStreamer ports </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <a name="PACKAGE"></a><span class="summary-name">PACKAGE</span> = <code title="'flumotion'"><code class="variable-quote">'</code><code class="variable-string">flumotion</code><code class="variable-quote">'</code></code><br /> Flumotion package </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string</span> </td><td class="summary"> <a name="version"></a><span class="summary-name">version</span> = <code title="'0.6.1'"><code class="variable-quote">'</code><code class="variable-string">0.6.1</code><code class="variable-quote">'</code></code><br /> Flumotion version number </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">4-tuple of integers</span> </td><td class="summary"> <a name="versionTuple"></a><span class="summary-name">versionTuple</span> = <code title="(0, 6, 1, 0)"><code class="variable-group">(</code>0<code class="variable-op">, </code>6<code class="variable-op">, </code>1<code class="variable-op">, </code>0<code class="variable-group">)</code></code><br /> Flumotion version number </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">string <p># default values for service-related stuff</p></span> </td><td class="summary"> <a name="branchName"></a><span class="summary-name">branchName</span> = <code title="'trunk'"><code class="variable-quote">'</code><code class="variable-string">trunk</code><code class="variable-quote">'</code></code><br /> Flumotion branch name </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="processTermWait"></a><span class="summary-name">processTermWait</span> = <code title="20">20</code><br /> how long to wait before timing out term signals @type processTermWait int </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="processKillWait"></a><span class="summary-name">processKillWait</span> = <code title="10">10</code><br /> how long to wait before timing out kill signals @type processKillWait int </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">int</span> </td><td class="summary"> <a name="heartbeatInterval"></a><span class="summary-name">heartbeatInterval</span> = <code title="5">5</code><br /> component heartbeat interval, in seconds </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">float</span> </td><td class="summary"> <a name="pingTimeoutMultiplier"></a><span class="summary-name">pingTimeoutMultiplier</span> = <code title="6.0">6.0</code><br /> how long to wait before assuming a lost connection, specified as a multiple of the heartbeatInterval </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'flumotion.configure'"><code class="variable-quote">'</code><code class="variable-string">flumotion.configure</code><code class="variable-quote">'</code></code> </td> </tr> </table> <!-- ==================== VARIABLES DETAILS ==================== --> <a name="section-VariablesDetails"></a> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Variables Details</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-VariablesDetails" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> </table> <a name="__thisdir"></a> <div class="private"> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <h3 class="epydoc">__thisdir</h3> <dl class="fields"> </dl> <dl class="fields"> <dt>Value:</dt> <dd><table><tr><td><pre class="variable"> <code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/flumotion/configure</code><code class="variable-quote">'</code> </pre></td></tr></table> </dd> </dl> </td></tr></table> </div> <a name="_config"></a> <div class="private"> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <h3 class="epydoc">_config</h3> <dl class="fields"> </dl> <dl class="fields"> <dt>Value:</dt> <dd><table><tr><td><pre class="variable"> <code class="variable-group">{</code><code class="variable-quote">'</code><code class="variable-string">bindir</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/bin</code><code class="variable-quote">'</code><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">cachedir</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/cache</code><code class="variable-quote">'</code><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">configdir</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/conf</code><code class="variable-quote">'</code><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">daemondir</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1</code><code class="variable-quote">'</code><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">datadir</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/data</code><code class="variable-quote">'</code><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">gladedir</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/data/glade</code><code class="variable-quote">'</code><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">imagedir</code><code class="variable-quote">'</code><code class="variable-op">: </code><code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/data/image</code><code class="variable-quote">'</code><code class="variable-op">,</code> <code class="variable-quote">'</code><code class="variable-string">isinstalled</code><code class="variable-quote">'</code><code class="variable-op">: </code>False<code class="variable-op">,</code> <code class="variable-ellipsis">...</code> </pre></td></tr></table> </dd> </dl> </td></tr></table> </div> <a name="registrydir"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <h3 class="epydoc">registrydir</h3> directory where the registry files are stored <dl class="fields"> <dt>Type:</dt> <dd>string</dd> </dl> <dl class="fields"> <dt>Value:</dt> <dd><table><tr><td><pre class="variable"> <code class="variable-quote">'</code><code class="variable-string">/home/mandrake/rpm/BUILD/flumotion-0.6.1/cache/registry</code><code class="variable-quote">'</code> </pre></td></tr></table> </dd> </dl> </td></tr></table> </div> <a name="defaultGstPortRange"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <h3 class="epydoc">defaultGstPortRange</h3> the default range of internal GStreamer ports <dl class="fields"> <dt>Type:</dt> <dd>list of ints</dd> </dl> <dl class="fields"> <dt>Value:</dt> <dd><table><tr><td><pre class="variable"> <code class="variable-group">[</code>8600<code class="variable-op">,</code> 8601<code class="variable-op">,</code> 8602<code class="variable-op">,</code> 8603<code class="variable-op">,</code> 8604<code class="variable-op">,</code> 8605<code class="variable-op">,</code> 8606<code class="variable-op">,</code> 8607<code class="variable-op">,</code> <code class="variable-ellipsis">...</code> </pre></td></tr></table> </dd> </dl> </td></tr></table> </div> <br /> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <th class="navbar" width="100%"></th> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> Generated by Epydoc 3.0.1 on Sun Sep 13 13:13:57 2009 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" >http://epydoc.sourceforge.net</a> </td> </tr> </table> <script type="text/javascript"> <!-- // Private objects are initially displayed (because if // javascript is turned off then we want them to be // visible); but by default, we want to hide them. So hide // them unless we have a cookie that says to show them. checkCookie(); // --> </script> </body> </html>