Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 016dce254e4c4a3b478dd177a366cef9d7766e06 / . / TestON / Documentation / TestON_Document / TestON.drivers.common.api.fvtapidriver.FvtApiDriver-class.html
blob: 9f8368bc263f36d02622e8fee6c4581846fb433b [file] [log] [blame]
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>TestON.drivers.common.api.fvtapidriver.FvtApiDriver</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
33 <th class="navbar" width="100%"></th>
34 </tr>
35</table>
36<table width="100%" cellpadding="0" cellspacing="0">
37 <tr valign="top">
38 <td width="100%">
39 <span class="breadcrumbs">
40 <a href="TestON-module.html">Package&nbsp;TestON</a> ::
41 <a href="TestON.drivers-module.html">Package&nbsp;drivers</a> ::
42 <a href="TestON.drivers.common-module.html">Package&nbsp;common</a> ::
43 <a href="TestON.drivers.common.api-module.html">Package&nbsp;api</a> ::
44 <a href="TestON.drivers.common.api.fvtapidriver-module.html">Module&nbsp;fvtapidriver</a> ::
45 Class&nbsp;FvtApiDriver
46 </span>
47 </td>
48 <td>
49 <table cellpadding="0" cellspacing="0">
50 <!-- hide/show private -->
51 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
52 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
53 <tr><td align="right"><span class="options"
54 >[<a href="frames.html" target="_top">frames</a
55 >]&nbsp;|&nbsp;<a href="TestON.drivers.common.api.fvtapidriver.FvtApiDriver-class.html"
56 target="_top">no&nbsp;frames</a>]</span></td></tr>
57 </table>
58 </td>
59 </tr>
60</table>
61<!-- ==================== CLASS DESCRIPTION ==================== -->
62<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>
63<pre class="base-tree">
64 ??-41 --+
65 |
66 apidriver.API --+
67 |
68templatetest.TemplateTest --+
69 |
70 <strong class="uidshort">FvtApiDriver</strong>
71</pre>
72
73<hr />
74<!-- ==================== INSTANCE METHODS ==================== -->
75<a name="section-InstanceMethods"></a>
76<table class="summary" border="1" cellpadding="3"
77 cellspacing="0" width="100%" bgcolor="white">
78<tr bgcolor="#70b0f0" class="table-header">
79 <td colspan="2" class="table-header">
80 <table border="0" cellpadding="0" cellspacing="0" width="100%">
81 <tr valign="top">
82 <td align="left"><span class="table-header">Instance Methods</span></td>
83 <td align="right" valign="top"
84 ><span class="options">[<a href="#section-InstanceMethods"
85 class="privatelink" onclick="toggle_private();"
86 >hide private</a>]</span></td>
87 </tr>
88 </table>
89 </td>
90</tr>
91<tr>
92 <td width="15%" align="right" valign="top" class="summary">
93 <span class="summary-type">&nbsp;</span>
94 </td><td class="summary">
95 <table width="100%" cellpadding="0" cellspacing="0" border="0">
96 <tr>
97 <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>
98 <td align="right" valign="top">
99 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.__init__">source&nbsp;code</a></span>
100
101 </td>
102 </tr>
103 </table>
104
105 </td>
106 </tr>
107<tr>
108 <td width="15%" align="right" valign="top" class="summary">
109 <span class="summary-type">&nbsp;</span>
110 </td><td class="summary">
111 <table width="100%" cellpadding="0" cellspacing="0" border="0">
112 <tr>
113 <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>,
114 <span class="summary-sig-arg">**connectargs</span>)</span><br />
115 Connection will establish to the remote host using ssh.</td>
116 <td align="right" valign="top">
117 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.connect">source&nbsp;code</a></span>
118
119 </td>
120 </tr>
121 </table>
122
123 </td>
124 </tr>
125<tr>
126 <td width="15%" align="right" valign="top" class="summary">
127 <span class="summary-type">&nbsp;</span>
128 </td><td class="summary">
129 <table width="100%" cellpadding="0" cellspacing="0" border="0">
130 <tr>
131 <td><span class="summary-sig"><a name="simplePacket"></a><span class="summary-sig-name">simplePacket</span>(<span class="summary-sig-arg">self</span>,
132 <span class="summary-sig-arg">dl_src</span>)</span></td>
133 <td align="right" valign="top">
134 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.simplePacket">source&nbsp;code</a></span>
135
136 </td>
137 </tr>
138 </table>
139
140 </td>
141 </tr>
142<tr>
143 <td width="15%" align="right" valign="top" class="summary">
144 <span class="summary-type">&nbsp;</span>
145 </td><td class="summary">
146 <table width="100%" cellpadding="0" cellspacing="0" border="0">
147 <tr>
148 <td><span class="summary-sig"><a name="genPacketIn"></a><span class="summary-sig-name">genPacketIn</span>(<span class="summary-sig-arg">self</span>,
149 <span class="summary-sig-arg">in_port</span>,
150 <span class="summary-sig-arg">pkt</span>)</span></td>
151 <td align="right" valign="top">
152 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.genPacketIn">source&nbsp;code</a></span>
153
154 </td>
155 </tr>
156 </table>
157
158 </td>
159 </tr>
160<tr>
161 <td width="15%" align="right" valign="top" class="summary">
162 <span class="summary-type">&nbsp;</span>
163 </td><td class="summary">
164 <table width="100%" cellpadding="0" cellspacing="0" border="0">
165 <tr>
166 <td><span class="summary-sig"><a name="ofmsgSndCmp"></a><span class="summary-sig-name">ofmsgSndCmp</span>(<span class="summary-sig-arg">self</span>,
167 <span class="summary-sig-arg">snd_list</span>,
168 <span class="summary-sig-arg">exp_list</span>,
169 <span class="summary-sig-arg">xid_ignore</span>=<span class="summary-sig-default">True</span>,
170 <span class="summary-sig-arg">hdr_only</span>=<span class="summary-sig-default">True</span>)</span></td>
171 <td align="right" valign="top">
172 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.ofmsgSndCmp">source&nbsp;code</a></span>
173
174 </td>
175 </tr>
176 </table>
177
178 </td>
179 </tr>
180<tr>
181 <td width="15%" align="right" valign="top" class="summary">
182 <span class="summary-type">&nbsp;</span>
183 </td><td class="summary">
184 <table width="100%" cellpadding="0" cellspacing="0" border="0">
185 <tr>
186 <td><span class="summary-sig"><a name="setRule"></a><span class="summary-sig-name">setRule</span>(<span class="summary-sig-arg">self</span>,
187 <span class="summary-sig-arg">sv</span>,
188 <span class="summary-sig-arg">rule</span>,
189 <span class="summary-sig-arg">num_try</span>)</span></td>
190 <td align="right" valign="top">
191 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.setRule">source&nbsp;code</a></span>
192
193 </td>
194 </tr>
195 </table>
196
197 </td>
198 </tr>
199<tr>
200 <td width="15%" align="right" valign="top" class="summary">
201 <span class="summary-type">&nbsp;</span>
202 </td><td class="summary">
203 <table width="100%" cellpadding="0" cellspacing="0" border="0">
204 <tr>
205 <td><span class="summary-sig"><a name="chkFlowdb"></a><span class="summary-sig-name">chkFlowdb</span>(<span class="summary-sig-arg">self</span>,
206 <span class="summary-sig-arg">controller_number</span>,
207 <span class="summary-sig-arg">switch_number</span>,
208 <span class="summary-sig-arg">exp_count</span>,
209 <span class="summary-sig-arg">exp_rewrites</span>)</span></td>
210 <td align="right" valign="top">
211 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.chkFlowdb">source&nbsp;code</a></span>
212
213 </td>
214 </tr>
215 </table>
216
217 </td>
218 </tr>
219<tr>
220 <td width="15%" align="right" valign="top" class="summary">
221 <span class="summary-type">&nbsp;</span>
222 </td><td class="summary">
223 <table width="100%" cellpadding="0" cellspacing="0" border="0">
224 <tr>
225 <td><span class="summary-sig"><a name="chkSwitchStats"></a><span class="summary-sig-name">chkSwitchStats</span>(<span class="summary-sig-arg">self</span>,
226 <span class="summary-sig-arg">switch_number</span>,
227 <span class="summary-sig-arg">ofproto</span>,
228 <span class="summary-sig-arg">exp_snd_count</span>,
229 <span class="summary-sig-arg">exp_rcv_count</span>)</span></td>
230 <td align="right" valign="top">
231 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.chkSwitchStats">source&nbsp;code</a></span>
232
233 </td>
234 </tr>
235 </table>
236
237 </td>
238 </tr>
239<tr>
240 <td width="15%" align="right" valign="top" class="summary">
241 <span class="summary-type">&nbsp;</span>
242 </td><td class="summary">
243 <table width="100%" cellpadding="0" cellspacing="0" border="0">
244 <tr>
245 <td><span class="summary-sig"><a name="chkSliceStats"></a><span class="summary-sig-name">chkSliceStats</span>(<span class="summary-sig-arg">self</span>,
246 <span class="summary-sig-arg">controller_number</span>,
247 <span class="summary-sig-arg">ofproto</span>,
248 <span class="summary-sig-arg">exp_snd_count</span>,
249 <span class="summary-sig-arg">exp_rcv_count</span>)</span></td>
250 <td align="right" valign="top">
251 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.chkSliceStats">source&nbsp;code</a></span>
252
253 </td>
254 </tr>
255 </table>
256
257 </td>
258 </tr>
259<tr>
260 <td width="15%" align="right" valign="top" class="summary">
261 <span class="summary-type">&nbsp;</span>
262 </td><td class="summary">
263 <table width="100%" cellpadding="0" cellspacing="0" border="0">
264 <tr>
265 <td><span class="summary-sig"><a name="recvStats"></a><span class="summary-sig-name">recvStats</span>(<span class="summary-sig-arg">self</span>,
266 <span class="summary-sig-arg">swId</span>,
267 <span class="summary-sig-arg">typ</span>)</span></td>
268 <td align="right" valign="top">
269 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.recvStats">source&nbsp;code</a></span>
270
271 </td>
272 </tr>
273 </table>
274
275 </td>
276 </tr>
277<tr>
278 <td width="15%" align="right" valign="top" class="summary">
279 <span class="summary-type">&nbsp;</span>
280 </td><td class="summary">
281 <table width="100%" cellpadding="0" cellspacing="0" border="0">
282 <tr>
283 <td><span class="summary-sig"><a name="ofmsgSndCmpWithXid"></a><span class="summary-sig-name">ofmsgSndCmpWithXid</span>(<span class="summary-sig-arg">self</span>,
284 <span class="summary-sig-arg">snd_list</span>,
285 <span class="summary-sig-arg">exp_list</span>,
286 <span class="summary-sig-arg">xid_ignore</span>,
287 <span class="summary-sig-arg">hdr_only</span>)</span></td>
288 <td align="right" valign="top">
289 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.ofmsgSndCmpWithXid">source&nbsp;code</a></span>
290
291 </td>
292 </tr>
293 </table>
294
295 </td>
296 </tr>
297<tr>
298 <td width="15%" align="right" valign="top" class="summary">
299 <span class="summary-type">&nbsp;</span>
300 </td><td class="summary">
301 <table width="100%" cellpadding="0" cellspacing="0" border="0">
302 <tr>
303 <td><span class="summary-sig"><a name="genPacketOut"></a><span class="summary-sig-name">genPacketOut</span>(<span class="summary-sig-arg">self</span>,
304 <span class="summary-sig-arg">xid</span>,
305 <span class="summary-sig-arg">buffer_id</span>,
306 <span class="summary-sig-arg">in_port</span>,
307 <span class="summary-sig-arg">action_ports</span>,
308 <span class="summary-sig-arg">pkt</span>)</span></td>
309 <td align="right" valign="top">
310 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.genPacketOut">source&nbsp;code</a></span>
311
312 </td>
313 </tr>
314 </table>
315
316 </td>
317 </tr>
318<tr>
319 <td width="15%" align="right" valign="top" class="summary">
320 <span class="summary-type">&nbsp;</span>
321 </td><td class="summary">
322 <table width="100%" cellpadding="0" cellspacing="0" border="0">
323 <tr>
324 <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>
325 <td align="right" valign="top">
326 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.genFlowModFlush">source&nbsp;code</a></span>
327
328 </td>
329 </tr>
330 </table>
331
332 </td>
333 </tr>
334<tr>
335 <td width="15%" align="right" valign="top" class="summary">
336 <span class="summary-type">&nbsp;</span>
337 </td><td class="summary">
338 <table width="100%" cellpadding="0" cellspacing="0" border="0">
339 <tr>
340 <td><span class="summary-sig"><a name="genPhyPort"></a><span class="summary-sig-name">genPhyPort</span>(<span class="summary-sig-arg">self</span>,
341 <span class="summary-sig-arg">name</span>,
342 <span class="summary-sig-arg">addr</span>,
343 <span class="summary-sig-arg">port_no</span>)</span></td>
344 <td align="right" valign="top">
345 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.genPhyPort">source&nbsp;code</a></span>
346
347 </td>
348 </tr>
349 </table>
350
351 </td>
352 </tr>
353<tr>
354 <td width="15%" align="right" valign="top" class="summary">
355 <span class="summary-type">&nbsp;</span>
356 </td><td class="summary">
357 <table width="100%" cellpadding="0" cellspacing="0" border="0">
358 <tr>
359 <td><span class="summary-sig"><a name="disconnect"></a><span class="summary-sig-name">disconnect</span>(<span class="summary-sig-arg">self</span>,
360 <span class="summary-sig-arg">handle</span>)</span></td>
361 <td align="right" valign="top">
362 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.disconnect">source&nbsp;code</a></span>
363
364 </td>
365 </tr>
366 </table>
367
368 </td>
369 </tr>
370<tr>
371 <td width="15%" align="right" valign="top" class="summary">
372 <span class="summary-type">&nbsp;</span>
373 </td><td class="summary">
374 <table width="100%" cellpadding="0" cellspacing="0" border="0">
375 <tr>
376 <td><span class="summary-sig"><a name="setUp"></a><span class="summary-sig-name">setUp</span>(<span class="summary-sig-arg">self</span>,
377 <span class="summary-sig-arg">basic_logger</span>)</span></td>
378 <td align="right" valign="top">
379 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.setUp">source&nbsp;code</a></span>
380
381 </td>
382 </tr>
383 </table>
384
385 </td>
386 </tr>
387<tr>
388 <td width="15%" align="right" valign="top" class="summary">
389 <span class="summary-type">&nbsp;</span>
390 </td><td class="summary">
391 <table width="100%" cellpadding="0" cellspacing="0" border="0">
392 <tr>
393 <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>
394 <td align="right" valign="top">
395 <span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.close_log_handles">source&nbsp;code</a></span>
396
397 </td>
398 </tr>
399 </table>
400
401 </td>
402 </tr>
403</table>
404<!-- ==================== METHOD DETAILS ==================== -->
405<a name="section-MethodDetails"></a>
406<table class="details" border="1" cellpadding="3"
407 cellspacing="0" width="100%" bgcolor="white">
408<tr bgcolor="#70b0f0" class="table-header">
409 <td colspan="2" class="table-header">
410 <table border="0" cellpadding="0" cellspacing="0" width="100%">
411 <tr valign="top">
412 <td align="left"><span class="table-header">Method Details</span></td>
413 <td align="right" valign="top"
414 ><span class="options">[<a href="#section-MethodDetails"
415 class="privatelink" onclick="toggle_private();"
416 >hide private</a>]</span></td>
417 </tr>
418 </table>
419 </td>
420</tr>
421</table>
422<a name="__init__"></a>
423<div>
424<table class="details" border="1" cellpadding="3"
425 cellspacing="0" width="100%" bgcolor="white">
426<tr><td>
427 <table width="100%" cellpadding="0" cellspacing="0" border="0">
428 <tr valign="top"><td>
429 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
430 <br /><em class="fname">(Constructor)</em>
431 </h3>
432 </td><td align="right" valign="top"
433 ><span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.__init__">source&nbsp;code</a></span>&nbsp;
434 </td>
435 </tr></table>
436
437
438 <dl class="fields">
439 <dt>Overrides:
440 apidriver.API.__init__
441 </dt>
442 </dl>
443</td></tr></table>
444</div>
445<a name="connect"></a>
446<div>
447<table class="details" border="1" cellpadding="3"
448 cellspacing="0" width="100%" bgcolor="white">
449<tr><td>
450 <table width="100%" cellpadding="0" cellspacing="0" border="0">
451 <tr valign="top"><td>
452 <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
453 <span class="sig-arg">**connectargs</span>)</span>
454 </h3>
455 </td><td align="right" valign="top"
456 ><span class="codelink"><a href="TestON.drivers.common.api.fvtapidriver-pysrc.html#FvtApiDriver.connect">source&nbsp;code</a></span>&nbsp;
457 </td>
458 </tr></table>
459
460 <p>Connection will establish to the remote host using ssh. It will take
461 user_name ,ip_address and password as arguments&lt;br&gt; and will return
462 the handle.</p>
463 <dl class="fields">
464 <dt>Overrides:
465 apidriver.API.connect
466 <dd><em class="note">(inherited documentation)</em></dd>
467 </dt>
468 </dl>
469</td></tr></table>
470</div>
471<br />
472<!-- ==================== NAVIGATION BAR ==================== -->
473<table class="navbar" border="0" width="100%" cellpadding="0"
474 bgcolor="#a0c0ff" cellspacing="0">
475 <tr valign="middle">
476 <!-- Home link -->
477 <th>&nbsp;&nbsp;&nbsp;<a
478 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
479
480 <!-- Tree link -->
481 <th>&nbsp;&nbsp;&nbsp;<a
482 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
483
484 <!-- Index link -->
485 <th>&nbsp;&nbsp;&nbsp;<a
486 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
487
488 <!-- Help link -->
489 <th>&nbsp;&nbsp;&nbsp;<a
490 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
491
492 <th class="navbar" width="100%"></th>
493 </tr>
494</table>
495<table border="0" cellpadding="0" cellspacing="0" width="100%%">
496 <tr>
497 <td align="left" class="footer">
498 Generated by Epydoc 3.0.1 on Mon Mar 11 12:56:26 2013
499 </td>
500 <td align="right" class="footer">
501 <a target="mainFrame" href="http://epydoc.sourceforge.net"
502 >http://epydoc.sourceforge.net</a>
503 </td>
504 </tr>
505</table>
506
507<script type="text/javascript">
508 <!--
509 // Private objects are initially displayed (because if
510 // javascript is turned off then we want them to be
511 // visible); but by default, we want to hide them. So hide
512 // them unless we have a cookie that says to show them.
513 checkCookie();
514 // -->
515</script>
516</body>
517</html>