sablink/entropy
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Files
68b07c2d28e8ec4cada423b29f8bf69d09cb3ddc
entropy/docs/entropy/api/docs/entropy.client.services.system.interfaces.Client-class.html
T
Fabio Erculiani d4b092ec6f [docs] update API documentation
2009-09-04 11:50:36 +02:00

469 lines
20 KiB
HTML
Raw Blame History

<?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>entropy.client.services.system.interfaces.Client</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">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="entropy-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.sabayon.org/">Entropy Framework</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="entropy-module.html">Package&nbsp;entropy</a> ::
<a href="entropy.client-module.html">Package&nbsp;client</a> ::
<a href="entropy.client.services-module.html">Package&nbsp;services</a> ::
<a href="entropy.client.services.system-module.html">Package&nbsp;system</a> ::
<a href="entropy.client.services.system.interfaces-module.html">Module&nbsp;interfaces</a> ::
Class&nbsp;Client
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Client</h1><p class="nomargin-top"><span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client">source&nbsp;code</a></span></p>
<!-- ==================== 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 align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">OutputInterface</span>,
<span class="summary-sig-arg">MethodsInterface</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">ClientCommandsInterface</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">quiet</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">show_progress</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">do_cache_connection</span>=<span class="summary-sig-default">False</span>,
<span class="summary-sig-arg">do_cache_session</span>=<span class="summary-sig-default">False</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.__init__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__del__"></a><span class="summary-sig-name">__del__</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.__del__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="get_session_cache"></a><span class="summary-sig-name">get_session_cache</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">cmd_tuple</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.get_session_cache">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="set_session_cache"></a><span class="summary-sig-name">set_session_cache</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">cmd_tuple</span>,
<span class="summary-sig-arg">session_id</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.set_session_cache">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="remove_session_cache"></a><span class="summary-sig-name">remove_session_cache</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">cmd_tuple</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.remove_session_cache">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="get_connection_cache_key"></a><span class="summary-sig-name">get_connection_cache_key</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.get_connection_cache_key">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="get_connection_cache"></a><span class="summary-sig-name">get_connection_cache</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.get_connection_cache">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="cache_connection"></a><span class="summary-sig-name">cache_connection</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">srv</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.cache_connection">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="update_connection_ts"></a><span class="summary-sig-name">update_connection_ts</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.update_connection_ts">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="kill_all_connections"></a><span class="summary-sig-name">kill_all_connections</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.kill_all_connections">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="connection_killer_handler"></a><span class="summary-sig-name">connection_killer_handler</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.connection_killer_handler">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="get_ts"></a><span class="summary-sig-name">get_ts</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.get_ts">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="setup_connection"></a><span class="summary-sig-name">setup_connection</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">hostname</span>,
<span class="summary-sig-arg">port</span>,
<span class="summary-sig-arg">username</span>,
<span class="summary-sig-arg">password</span>,
<span class="summary-sig-arg">ssl</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.setup_connection">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="connect_to_service"></a><span class="summary-sig-name">connect_to_service</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.connect_to_service">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="get_service_connection"></a><span class="summary-sig-name">get_service_connection</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">timeout</span>=<span class="summary-sig-default">None</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.get_service_connection">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="logout"></a><span class="summary-sig-name">logout</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">srv</span>,
<span class="summary-sig-arg">session_id</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.logout">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="login"></a><span class="summary-sig-name">login</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">srv</span>,
<span class="summary-sig-arg">session_id</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.login">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="do_cmd"></a><span class="summary-sig-name">do_cmd</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">login_required</span>,
<span class="summary-sig-arg">func</span>,
<span class="summary-sig-arg">args</span>,
<span class="summary-sig-arg">kwargs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.do_cmd">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="get_available_client_commands"></a><span class="summary-sig-name">get_available_client_commands</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="entropy.client.services.system.interfaces-pysrc.html#Client.get_available_client_commands">source&nbsp;code</a></span>
</td>
</tr>
</table>
</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 align="left" colspan="2" class="table-header">
<span class="table-header">Class Variables</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<a name="ssl_connection"></a><span class="summary-name">ssl_connection</span> = <code title="True">True</code>
</td>
</tr>
</table>
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="entropy-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.sabayon.org/">Entropy Framework</a></th>
</tr></table></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 Fri Sep 4 11:50:11 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>
Reference in New Issue View Git Blame Copy Permalink