Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 64b33715b42f35afd6792fe10bc07c8247688c18 / . / TestON / Documentation / TestON_Document / TestON.drivers.common.api.fvtapidriver.FvtApiDriver-class.html
blob: 9f8368bc263f36d02622e8fee6c4581846fb433b [file] [log] [blame]
<?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>TestON.drivers.common.api.fvtapidriver.FvtApiDriver</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="TestON-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>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="TestON-module.html">Package&nbsp;TestON</a> ::
<a href="TestON.drivers-module.html">Package&nbsp;drivers</a> ::
<a href="TestON.drivers.common-module.html">Package&nbsp;common</a> ::
<a href="TestON.drivers.common.api-module.html">Package&nbsp;api</a> ::
<a href="TestON.drivers.common.api.fvtapidriver-module.html">Module&nbsp;fvtapidriver</a> ::
Class&nbsp;FvtApiDriver
</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&nbsp;private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="TestON.drivers.common.api.fvtapidriver.FvtApiDriver-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class FvtApiDriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver">source&nbsp;code</a></span></p>
<pre class="base-tree">
??-41 --+
|
apidriver.API --+
|
templatetest.TemplateTest --+
|
<strong class="uidshort">FvtApiDriver</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">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="TestON.drivers.common.api.fvtapidriver.FvtApiDriver-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.__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 href="TestON.drivers.common.api.fvtapidriver.FvtApiDriver-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**connectargs</span>)</span><br />
Connection will establish to the remote host using ssh.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.connect">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="simplePacket"></a><span class="summary-sig-name">simplePacket</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">dl_src</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.simplePacket">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="genPacketIn"></a><span class="summary-sig-name">genPacketIn</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">in_port</span>,
<span class="summary-sig-arg">pkt</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.genPacketIn">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="ofmsgSndCmp"></a><span class="summary-sig-name">ofmsgSndCmp</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">snd_list</span>,
<span class="summary-sig-arg">exp_list</span>,
<span class="summary-sig-arg">xid_ignore</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">hdr_only</span>=<span class="summary-sig-default">True</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.ofmsgSndCmp">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="setRule"></a><span class="summary-sig-name">setRule</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">sv</span>,
<span class="summary-sig-arg">rule</span>,
<span class="summary-sig-arg">num_try</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.setRule">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="chkFlowdb"></a><span class="summary-sig-name">chkFlowdb</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">controller_number</span>,
<span class="summary-sig-arg">switch_number</span>,
<span class="summary-sig-arg">exp_count</span>,
<span class="summary-sig-arg">exp_rewrites</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.chkFlowdb">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="chkSwitchStats"></a><span class="summary-sig-name">chkSwitchStats</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">switch_number</span>,
<span class="summary-sig-arg">ofproto</span>,
<span class="summary-sig-arg">exp_snd_count</span>,
<span class="summary-sig-arg">exp_rcv_count</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.chkSwitchStats">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="chkSliceStats"></a><span class="summary-sig-name">chkSliceStats</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">controller_number</span>,
<span class="summary-sig-arg">ofproto</span>,
<span class="summary-sig-arg">exp_snd_count</span>,
<span class="summary-sig-arg">exp_rcv_count</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.chkSliceStats">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="recvStats"></a><span class="summary-sig-name">recvStats</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">swId</span>,
<span class="summary-sig-arg">typ</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.recvStats">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="ofmsgSndCmpWithXid"></a><span class="summary-sig-name">ofmsgSndCmpWithXid</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">snd_list</span>,
<span class="summary-sig-arg">exp_list</span>,
<span class="summary-sig-arg">xid_ignore</span>,
<span class="summary-sig-arg">hdr_only</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.ofmsgSndCmpWithXid">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="genPacketOut"></a><span class="summary-sig-name">genPacketOut</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">xid</span>,
<span class="summary-sig-arg">buffer_id</span>,
<span class="summary-sig-arg">in_port</span>,
<span class="summary-sig-arg">action_ports</span>,
<span class="summary-sig-arg">pkt</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.genPacketOut">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="genFlowModFlush"></a><span class="summary-sig-name">genFlowModFlush</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.genFlowModFlush">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="genPhyPort"></a><span class="summary-sig-name">genPhyPort</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">addr</span>,
<span class="summary-sig-arg">port_no</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.genPhyPort">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="disconnect"></a><span class="summary-sig-name">disconnect</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">handle</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.disconnect">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"></a><span class="summary-sig-name">setUp</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">basic_logger</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.setUp">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="close_log_handles"></a><span class="summary-sig-name">close_log_handles</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.close_log_handles">source&nbsp;code</a></span>
</td>
</tr>
</table>
</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="__init__"></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">__init__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.__init__">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<dl class="fields">
<dt>Overrides:
apidriver.API.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="connect"></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">connect</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**connectargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.connect">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>Connection will establish to the remote host using ssh. It will take
user_name ,ip_address and password as arguments&lt;br&gt; and will return
the handle.</p>
<dl class="fields">
<dt>Overrides:
apidriver.API.connect
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== 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="TestON-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>
<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 Mon Mar 11 12:56:26 2013
</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>