<?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.admin.command.main.Command</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.admin-module.html">Package admin</a> ::
<a href="flumotion.admin.command-module.html">Package command</a> ::
<a href="flumotion.admin.command.main-module.html">Module main</a> ::
Class Command
</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>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Command</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.admin.command.main-pysrc.html#Command">source code</a></span></p>
<pre class="base-tree">
<a href="flumotion.extern.command.command.Command-class.html">extern.command.command.Command</a> --+
|
<a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a> --+
|
monitor.nagios.util.LogCommand --+
|
<strong class="uidshort">Command</strong>
</pre>
<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></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">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<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 href="flumotion.admin.command.main.Command-class.html#addOptions" class="summary-sig-name">addOptions</a>(<span class="summary-sig-arg">self</span>)</span><br />
Override me to add options to the parser.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.admin.command.main-pysrc.html#Command.addOptions">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<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 href="flumotion.admin.command.main.Command-class.html#handleOptions" class="summary-sig-name">handleOptions</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">options</span>)</span><br />
Handle the parsed options.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.admin.command.main-pysrc.html#Command.handleOptions">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">int</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.admin.command.main.Command-class.html#parse" class="summary-sig-name">parse</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">argv</span>)</span><br />
Parse the given arguments and act on them.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.admin.command.main-pysrc.html#Command.parse">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<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 href="flumotion.admin.command.main.Command-class.html#run" class="summary-sig-name">run</a>(<span class="summary-sig-arg">self</span>)</span><br />
Run the reactor.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.admin.command.main-pysrc.html#Command.run">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<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="connect"></a><span class="summary-sig-name">connect</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">options</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.admin.command.main-pysrc.html#Command.connect">source code</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="_connectedCb"></a><span class="summary-sig-name">_connectedCb</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">result</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.admin.command.main-pysrc.html#Command._connectedCb">source code</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="_connectedEb"></a><span class="summary-sig-name">_connectedEb</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">failure</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.admin.command.main-pysrc.html#Command._connectedEb">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>monitor.nagios.util.LogCommand</code></b>:
<code>__init__</code>,
<code>debug</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.extern.command.command.Command-class.html">extern.command.command.Command</a></code></b>:
<code><a href="flumotion.extern.command.command.Command-class.html#do">do</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#getRootCommand">getRootCommand</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#outputHelp">outputHelp</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#outputUsage">outputUsage</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a></code></b>:
<code><a href="flumotion.extern.log.log.Loggable-class.html#doLog">doLog</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#error">error</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#info">info</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#log">log</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#logFunction">logFunction</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#logObjectName">logObjectName</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#warning">warning</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#warningFailure">warningFailure</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#writeMarker">writeMarker</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></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">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="usage"></a><span class="summary-name">usage</span> = <code title="'%prog %command'"><code class="variable-quote">'</code><code class="variable-string">%prog %command</code><code class="variable-quote">'</code></code><br />
short one-line usage string; %command gets expanded to a sub-command
or [commands] as appropriate.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="description"></a><span class="summary-name">description</span> = <code title="'Run commands on Flumotion manager.'"><code class="variable-quote">'</code><code class="variable-string">Run commands on Flumotion manager.</code><code class="variable-quote">'</code></code><br />
longer paragraph explaining the command
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="loginDeferred"></a><span class="summary-name">loginDeferred</span> = <code title="None">None</code><br />
hash(x)
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="medium"></a><span class="summary-name">medium</span> = <code title="None">None</code><br />
hash(x)
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="flumotion.admin.command.main.Command-class.html#subCommandClasses" class="summary-name">subCommandClasses</a> = <code title="[component.Component, manager.Manager, worker.Worker]">[component.Component, manager.Manager, wor<code class="variable-ellipsis">...</code></code><br />
hash(x)
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.extern.command.command.Command-class.html">extern.command.command.Command</a></code></b>:
<code><a href="flumotion.extern.command.command.Command-class.html#aliasedSubCommands">aliasedSubCommands</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#aliases">aliases</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#name">name</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#parentCommand">parentCommand</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#parser">parser</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#subCommands">subCommands</a></code>,
<code><a href="flumotion.extern.command.command.Command-class.html#summary">summary</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a></code></b>:
<code><a href="flumotion.extern.log.log.Loggable-class.html#logCategory">logCategory</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></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">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="addOptions"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">addOptions</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.admin.command.main-pysrc.html#Command.addOptions">source code</a></span>
</td>
</tr></table>
<p>Override me to add options to the parser.</p>
<dl class="fields">
<dt>Overrides:
<a href="flumotion.extern.command.command.Command-class.html#addOptions">extern.command.command.Command.addOptions</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="handleOptions"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">handleOptions</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">options</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.admin.command.main-pysrc.html#Command.handleOptions">source code</a></span>
</td>
</tr></table>
<p>Handle the parsed options.</p>
<dl class="fields">
<dt>Overrides:
<a href="flumotion.extern.command.command.Command-class.html#handleOptions">extern.command.command.Command.handleOptions</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="parse"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">parse</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">argv</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.admin.command.main-pysrc.html#Command.parse">source code</a></span>
</td>
</tr></table>
<p>Parse the given arguments and act on them.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>argv</code></strong> - list of arguments to parse</li>
</ul></dd>
<dt>Returns: int</dt>
<dd>an exit code, or None if no actual action was taken.</dd>
<dt>Overrides:
<a href="flumotion.extern.command.command.Command-class.html#parse">extern.command.command.Command.parse</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="run"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">run</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.admin.command.main-pysrc.html#Command.run">source code</a></span>
</td>
</tr></table>
<p>Run the reactor.</p>
<p>Resets .exitStatus, and returns its value after running the
reactor.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
<a name="section-ClassVariableDetails"></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">Class Variable Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariableDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="subCommandClasses"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">subCommandClasses</h3>
<p>hash(x)</p>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
[component.Component, manager.Manager, worker.Worker]
</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:58 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>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
contrib-release
>
by-pkgid
>
2eca861f24be6048290ed27335ec22aa
>
files
>
69
