← Back to branch summary

~ubuntu-branches/ubuntu/natty/ntop/natty

« back to all changes in this revision

Viewing changes to html/docs/python/interface-module.html

  • Committer: Bazaar Package Importer
  • Author(s): Ludovico Cavedon, Jordan Metzmeier, Ludovico Cavedon
  • Date: 2010-12-15 20:06:19 UTC
  • mfrom: (5.1.5 sid)
  • Revision ID: james.westby@ubuntu.com-20101215200619-0ojz3iak95ihibun
Tags: 3:4.0.3+dfsg1-1
http://bugs.debian.org/522042
http://bugs.debian.org/595450
https://launchpad.net/bugs/257466
[ Jordan Metzmeier ]
* New upstream release (Closes: #522042)
* Move data files to /usr/share/ntop (Closes: #595450).
* Package architecture independent data in a separate ntop-data package.
* Use debhelper 7.
* Update Standards-Version to 3.9.1.
* Depend on python-mako.
* Do not include ntop.txt in binary packages as it is a copy of the man
  page.
* Do not include NEWS, as it is outdated.
* Switch to package source version 3.0 (quilt).
* Add password creation to debconf
* Changed init script to fix localization problems (thanks to Alejandro
  Varas <alej0varas@gmail.com>, LP: #257466)
* Remove manual update-rc.d calls from postrm and postinst. debhelper adds
  this for us.
* Add pre-depends on adduser for postinst script.
* Fix errors in the manpages: fix-manpage-errors.patch.
* Added fixes for matching active interfaces.
* Added a watch file.

[ Ludovico Cavedon ]
* Remove direct changes to upstream tree, and move them into specific patch
  files:
  - fix-manpage-errors.patch: fix typos in ntop.8.
  - dot-path.patch: fix path of /usr/bin/dot executable
* Add patches:
  - reduce-autogen-purged-files.patch: prevent agutogen.sh from reamoving
  too many files during cleanup.
  - Add build-without-ntop-darwin.patch, to fix compilation without
  ntop_darwin.c.
* No longer add faq.html, as it is not distributed in the upstream tarball.
* Use ${source:Version} in control file. Have ntop-data recommend
  ntop.
* Rename dirs to ntop.dirs and keep only empty directories that need
  to be created.
* Remove var/lib from ntop.install file, as it is empty (keeping it in
  ntop.dirs).
* Update po files.
* Breaks and Replaces instead of Conflitcs for ntop-data.
* Use a longer package description.
* Remove useless configure options from debian/rules.
* Move private shared libraries libraries in /usr/lib/ntop.
* Add change-plugin-dir.patch for adjusting plugin directory.
* Remove development files.
* Use system library for MochiKit.js.
* Rewrite DEP5 copyright file.
* Repackage upstream tarball in order to remove non-DFSG-compliant code. Add
  get-orig-source.sh script and get-orig-source target in debian/rules.
* Add explanation to README.Debian why geolocation is no longer working.
* Add avoid-copy-maxmind-db.patch to prevent copying of Geo*.dat
  files.
* Remove old unused patches.

Show diffs side-by-side

added added

removed removed

Lines of Context:
html/docs/python/interface-module.html
 
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>interface</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
 
 
18
  <!-- Tree link -->
 
19
      <th>&nbsp;&nbsp;&nbsp;<a
 
20
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
21
 
 
22
  <!-- Index link -->
 
23
      <th>&nbsp;&nbsp;&nbsp;<a
 
24
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
25
 
 
26
  <!-- Help link -->
 
27
      <th>&nbsp;&nbsp;&nbsp;<a
 
28
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
29
 
 
30
  <!-- Project homepage -->
 
31
      <th class="navbar" align="right" width="100%">
 
32
        <table border="0" cellpadding="0" cellspacing="0">
 
33
          <tr><th class="navbar" align="center"
 
34
            ><a href="http://www.ntop.org/">Ntop</a></th>
 
35
          </tr></table></th>
 
36
  </tr>
 
37
</table>
 
38
<table width="100%" cellpadding="0" cellspacing="0">
 
39
  <tr valign="top">
 
40
    <td width="100%">
 
41
      <span class="breadcrumbs">
 
42
        Module&nbsp;interface
 
43
      </span>
 
44
    </td>
 
45
    <td>
 
46
      <table cellpadding="0" cellspacing="0">
 
47
        <!-- hide/show private -->
 
48
        <tr><td align="right"><span class="options"
 
49
            >[<a href="frames.html" target="_top">frames</a
 
50
            >]&nbsp;|&nbsp;<a href="interface-module.html"
 
51
            target="_top">no&nbsp;frames</a>]</span></td></tr>
 
52
      </table>
 
53
    </td>
 
54
  </tr>
 
55
</table>
 
56
<!-- ==================== MODULE DESCRIPTION ==================== -->
 
57
<h1 class="epydoc">Module interface</h1><p class="nomargin-top"></p>
 
58
<p>Module that exposes functions to get information on the current 
 
59
  interfaces enabled in ntop.</p>
 
60
 
 
61
<!-- ==================== FUNCTIONS ==================== -->
 
62
<a name="section-Functions"></a>
 
63
<table class="summary" border="1" cellpadding="3"
 
64
       cellspacing="0" width="100%" bgcolor="white">
 
65
<tr bgcolor="#70b0f0" class="table-header">
 
66
  <td align="left" colspan="2" class="table-header">
 
67
    <span class="table-header">Functions</span></td>
 
68
</tr>
 
69
<tr>
 
70
    <td width="15%" align="right" valign="top" class="summary">
 
71
      <span class="summary-type">&nbsp;</span>
 
72
    </td><td class="summary">
 
73
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
74
        <tr>
 
75
          <td><span class="summary-sig"><a name="numInterfaces"></a><span class="summary-sig-name">numInterfaces</span>()</span><br />
 
76
      Get number of configured interfaces</td>
 
77
          <td align="right" valign="top">
 
78
            
 
79
            
 
80
          </td>
 
81
        </tr>
 
82
      </table>
 
83
      
 
84
    </td>
 
85
  </tr>
 
86
<tr>
 
87
    <td width="15%" align="right" valign="top" class="summary">
 
88
      <span class="summary-type">String @return the name of the interface</span>
 
89
    </td><td class="summary">
 
90
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
91
        <tr>
 
92
          <td><span class="summary-sig"><a name="name"></a><span class="summary-sig-name">name</span>()</span><br />
 
93
      Get interface name</td>
 
94
          <td align="right" valign="top">
 
95
            
 
96
            
 
97
          </td>
 
98
        </tr>
 
99
      </table>
 
100
      
 
101
    </td>
 
102
  </tr>
 
103
<tr>
 
104
    <td width="15%" align="right" valign="top" class="summary">
 
105
      <span class="summary-type">String @return the unique name of the interface</span>
 
106
    </td><td class="summary">
 
107
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
108
        <tr>
 
109
          <td><span class="summary-sig"><a name="uniqueName"></a><span class="summary-sig-name">uniqueName</span>()</span><br />
 
110
      Get unique interface name</td>
 
111
          <td align="right" valign="top">
 
112
            
 
113
            
 
114
          </td>
 
115
        </tr>
 
116
      </table>
 
117
      
 
118
    </td>
 
119
  </tr>
 
120
<tr>
 
121
    <td width="15%" align="right" valign="top" class="summary">
 
122
      <span class="summary-type">String @return the human-friendly name of the interface</span>
 
123
    </td><td class="summary">
 
124
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
125
        <tr>
 
126
          <td><span class="summary-sig"><a name="humanName"></a><span class="summary-sig-name">humanName</span>()</span><br />
 
127
      Get human-friendly interface name</td>
 
128
          <td align="right" valign="top">
 
129
            
 
130
            
 
131
          </td>
 
132
        </tr>
 
133
      </table>
 
134
      
 
135
    </td>
 
136
  </tr>
 
137
<tr>
 
138
    <td width="15%" align="right" valign="top" class="summary">
 
139
      <span class="summary-type">string</span>
 
140
    </td><td class="summary">
 
141
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
142
        <tr>
 
143
          <td><span class="summary-sig"><a href="interface-module.html#ipv4" class="summary-sig-name">ipv4</a>(<span class="summary-sig-arg">interfaceId</span>)</span><br />
 
144
      Get interface address (IPv4)</td>
 
145
          <td align="right" valign="top">
 
146
            
 
147
            
 
148
          </td>
 
149
        </tr>
 
150
      </table>
 
151
      
 
152
    </td>
 
153
  </tr>
 
154
<tr>
 
155
    <td width="15%" align="right" valign="top" class="summary">
 
156
      <span class="summary-type">string</span>
 
157
    </td><td class="summary">
 
158
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
159
        <tr>
 
160
          <td><span class="summary-sig"><a href="interface-module.html#network" class="summary-sig-name">network</a>(<span class="summary-sig-arg">interfaceId</span>)</span><br />
 
161
      Get network and mask to which the interface belongs</td>
 
162
          <td align="right" valign="top">
 
163
            
 
164
            
 
165
          </td>
 
166
        </tr>
 
167
      </table>
 
168
      
 
169
    </td>
 
170
  </tr>
 
171
<tr>
 
172
    <td width="15%" align="right" valign="top" class="summary">
 
173
      <span class="summary-type">number</span>
 
174
    </td><td class="summary">
 
175
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
176
        <tr>
 
177
          <td><span class="summary-sig"><a href="interface-module.html#numHosts" class="summary-sig-name">numHosts</a>(<span class="summary-sig-arg">interfaceId</span>)</span><br />
 
178
      Get the number of hosts active on this interface</td>
 
179
          <td align="right" valign="top">
 
180
            
 
181
            
 
182
          </td>
 
183
        </tr>
 
184
      </table>
 
185
      
 
186
    </td>
 
187
  </tr>
 
188
<tr>
 
189
    <td width="15%" align="right" valign="top" class="summary">
 
190
      <span class="summary-type">string</span>
 
191
    </td><td class="summary">
 
192
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
193
        <tr>
 
194
          <td><span class="summary-sig"><a href="interface-module.html#ipv6" class="summary-sig-name">ipv6</a>(<span class="summary-sig-arg">interfaceId</span>)</span><br />
 
195
      Get interface address (IPv6)</td>
 
196
          <td align="right" valign="top">
 
197
            
 
198
            
 
199
          </td>
 
200
        </tr>
 
201
      </table>
 
202
      
 
203
    </td>
 
204
  </tr>
 
205
<tr>
 
206
    <td width="15%" align="right" valign="top" class="summary">
 
207
      <span class="summary-type">dictionary @return {'startTime':number, 'firstSeen': number, 
 
208
      'lastSeen': number}</span>
 
209
    </td><td class="summary">
 
210
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
211
        <tr>
 
212
          <td><span class="summary-sig"><a href="interface-module.html#time" class="summary-sig-name">time</a>(<span class="summary-sig-arg">interfaceId</span>)</span><br />
 
213
      Get interface time</td>
 
214
          <td align="right" valign="top">
 
215
            
 
216
            
 
217
          </td>
 
218
        </tr>
 
219
      </table>
 
220
      
 
221
    </td>
 
222
  </tr>
 
223
<tr>
 
224
    <td width="15%" align="right" valign="top" class="summary">
 
225
      <span class="summary-type">&nbsp;</span>
 
226
    </td><td class="summary">
 
227
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
228
        <tr>
 
229
          <td><span class="summary-sig"><a name="virtual"></a><span class="summary-sig-name">virtual</span>()</span><br />
 
230
      Check if this is a virtual interface</td>
 
231
          <td align="right" valign="top">
 
232
            
 
233
            
 
234
          </td>
 
235
        </tr>
 
236
      </table>
 
237
      
 
238
    </td>
 
239
  </tr>
 
240
<tr>
 
241
    <td width="15%" align="right" valign="top" class="summary">
 
242
      <span class="summary-type">&nbsp;</span>
 
243
    </td><td class="summary">
 
244
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
245
        <tr>
 
246
          <td><span class="summary-sig"><a name="speed"></a><span class="summary-sig-name">speed</span>()</span><br />
 
247
      Interface speed (0 if unknown)</td>
 
248
          <td align="right" valign="top">
 
249
            
 
250
            
 
251
          </td>
 
252
        </tr>
 
253
      </table>
 
254
      
 
255
    </td>
 
256
  </tr>
 
257
<tr>
 
258
    <td width="15%" align="right" valign="top" class="summary">
 
259
      <span class="summary-type">&nbsp;</span>
 
260
    </td><td class="summary">
 
261
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
262
        <tr>
 
263
          <td><span class="summary-sig"><a name="mtu"></a><span class="summary-sig-name">mtu</span>()</span><br />
 
264
      Get interface MTU size</td>
 
265
          <td align="right" valign="top">
 
266
            
 
267
            
 
268
          </td>
 
269
        </tr>
 
270
      </table>
 
271
      
 
272
    </td>
 
273
  </tr>
 
274
<tr>
 
275
    <td width="15%" align="right" valign="top" class="summary">
 
276
      <span class="summary-type">&nbsp;</span>
 
277
    </td><td class="summary">
 
278
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
279
        <tr>
 
280
          <td><span class="summary-sig"><a name="bpf"></a><span class="summary-sig-name">bpf</span>()</span><br />
 
281
      Get BPF filter set for this interface (if any)</td>
 
282
          <td align="right" valign="top">
 
283
            
 
284
            
 
285
          </td>
 
286
        </tr>
 
287
      </table>
 
288
      
 
289
    </td>
 
290
  </tr>
 
291
<tr>
 
292
    <td width="15%" align="right" valign="top" class="summary">
 
293
      <span class="summary-type">&nbsp;</span>
 
294
    </td><td class="summary">
 
295
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
296
        <tr>
 
297
          <td><span class="summary-sig"><a name="pktsStats"></a><span class="summary-sig-name">pktsStats</span>()</span><br />
 
298
      Get packet statistics</td>
 
299
          <td align="right" valign="top">
 
300
            
 
301
            
 
302
          </td>
 
303
        </tr>
 
304
      </table>
 
305
      
 
306
    </td>
 
307
  </tr>
 
308
<tr>
 
309
    <td width="15%" align="right" valign="top" class="summary">
 
310
      <span class="summary-type">&nbsp;</span>
 
311
    </td><td class="summary">
 
312
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
313
        <tr>
 
314
          <td><span class="summary-sig"><a name="fcPktsStats"></a><span class="summary-sig-name">fcPktsStats</span>()</span><br />
 
315
      Get FC pkts stats</td>
 
316
          <td align="right" valign="top">
 
317
            
 
318
            
 
319
          </td>
 
320
        </tr>
 
321
      </table>
 
322
      
 
323
    </td>
 
324
  </tr>
 
325
<tr>
 
326
    <td width="15%" align="right" valign="top" class="summary">
 
327
      <span class="summary-type">&nbsp;</span>
 
328
    </td><td class="summary">
 
329
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
330
        <tr>
 
331
          <td><span class="summary-sig"><a name="fcBytesStats"></a><span class="summary-sig-name">fcBytesStats</span>()</span><br />
 
332
      Get FC byte stats</td>
 
333
          <td align="right" valign="top">
 
334
            
 
335
            
 
336
          </td>
 
337
        </tr>
 
338
      </table>
 
339
      
 
340
    </td>
 
341
  </tr>
 
342
<tr>
 
343
    <td width="15%" align="right" valign="top" class="summary">
 
344
      <span class="summary-type">&nbsp;</span>
 
345
    </td><td class="summary">
 
346
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
347
        <tr>
 
348
          <td><span class="summary-sig"><a name="bytesStats"></a><span class="summary-sig-name">bytesStats</span>()</span><br />
 
349
      Get bytes statistics</td>
 
350
          <td align="right" valign="top">
 
351
            
 
352
            
 
353
          </td>
 
354
        </tr>
 
355
      </table>
 
356
      
 
357
    </td>
 
358
  </tr>
 
359
<tr>
 
360
    <td width="15%" align="right" valign="top" class="summary">
 
361
      <span class="summary-type">&nbsp;</span>
 
362
    </td><td class="summary">
 
363
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
364
        <tr>
 
365
          <td><span class="summary-sig"><a name="throughputStats"></a><span class="summary-sig-name">throughputStats</span>()</span></td>
 
366
          <td align="right" valign="top">
 
367
            
 
368
            
 
369
          </td>
 
370
        </tr>
 
371
      </table>
 
372
      
 
373
    </td>
 
374
  </tr>
 
375
<tr>
 
376
    <td width="15%" align="right" valign="top" class="summary">
 
377
      <span class="summary-type">&nbsp;</span>
 
378
    </td><td class="summary">
 
379
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
380
        <tr>
 
381
          <td><span class="summary-sig"><a name="tcpStats"></a><span class="summary-sig-name">tcpStats</span>()</span><br />
 
382
      Get TCP stats</td>
 
383
          <td align="right" valign="top">
 
384
            
 
385
            
 
386
          </td>
 
387
        </tr>
 
388
      </table>
 
389
      
 
390
    </td>
 
391
  </tr>
 
392
<tr>
 
393
    <td width="15%" align="right" valign="top" class="summary">
 
394
      <span class="summary-type">&nbsp;</span>
 
395
    </td><td class="summary">
 
396
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
397
        <tr>
 
398
          <td><span class="summary-sig"><a name="udpStats"></a><span class="summary-sig-name">udpStats</span>()</span><br />
 
399
      Get UDP stats</td>
 
400
          <td align="right" valign="top">
 
401
            
 
402
            
 
403
          </td>
 
404
        </tr>
 
405
      </table>
 
406
      
 
407
    </td>
 
408
  </tr>
 
409
<tr>
 
410
    <td width="15%" align="right" valign="top" class="summary">
 
411
      <span class="summary-type">&nbsp;</span>
 
412
    </td><td class="summary">
 
413
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
414
        <tr>
 
415
          <td><span class="summary-sig"><a name="icmpStats"></a><span class="summary-sig-name">icmpStats</span>()</span><br />
 
416
      Get ICMP stats</td>
 
417
          <td align="right" valign="top">
 
418
            
 
419
            
 
420
          </td>
 
421
        </tr>
 
422
      </table>
 
423
      
 
424
    </td>
 
425
  </tr>
 
426
<tr>
 
427
    <td width="15%" align="right" valign="top" class="summary">
 
428
      <span class="summary-type">&nbsp;</span>
 
429
    </td><td class="summary">
 
430
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
431
        <tr>
 
432
          <td><span class="summary-sig"><a name="ipStats"></a><span class="summary-sig-name">ipStats</span>()</span><br />
 
433
      Get IP stats</td>
 
434
          <td align="right" valign="top">
 
435
            
 
436
            
 
437
          </td>
 
438
        </tr>
 
439
      </table>
 
440
      
 
441
    </td>
 
442
  </tr>
 
443
<tr>
 
444
    <td width="15%" align="right" valign="top" class="summary">
 
445
      <span class="summary-type">&nbsp;</span>
 
446
    </td><td class="summary">
 
447
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
448
        <tr>
 
449
          <td><span class="summary-sig"><a name="securityPkts"></a><span class="summary-sig-name">securityPkts</span>()</span><br />
 
450
      Get information about security packets</td>
 
451
          <td align="right" valign="top">
 
452
            
 
453
            
 
454
          </td>
 
455
        </tr>
 
456
      </table>
 
457
      
 
458
    </td>
 
459
  </tr>
 
460
<tr>
 
461
    <td width="15%" align="right" valign="top" class="summary">
 
462
      <span class="summary-type">&nbsp;</span>
 
463
    </td><td class="summary">
 
464
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
465
        <tr>
 
466
          <td><span class="summary-sig"><a name="netflowStats"></a><span class="summary-sig-name">netflowStats</span>()</span><br />
 
467
      Get NetFlow interface information</td>
 
468
          <td align="right" valign="top">
 
469
            
 
470
            
 
471
          </td>
 
472
        </tr>
 
473
      </table>
 
474
      
 
475
    </td>
 
476
  </tr>
 
477
<tr>
 
478
    <td width="15%" align="right" valign="top" class="summary">
 
479
      <span class="summary-type">&nbsp;</span>
 
480
    </td><td class="summary">
 
481
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
482
        <tr>
 
483
          <td><span class="summary-sig"><a name="sflowStats"></a><span class="summary-sig-name">sflowStats</span>()</span><br />
 
484
      Get sFlow interface information</td>
 
485
          <td align="right" valign="top">
 
486
            
 
487
            
 
488
          </td>
 
489
        </tr>
 
490
      </table>
 
491
      
 
492
    </td>
 
493
  </tr>
 
494
<tr>
 
495
    <td width="15%" align="right" valign="top" class="summary">
 
496
      <span class="summary-type">&nbsp;</span>
 
497
    </td><td class="summary">
 
498
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
499
        <tr>
 
500
          <td><span class="summary-sig"><a name="cpacketStats"></a><span class="summary-sig-name">cpacketStats</span>()</span><br />
 
501
      Get cPacket counter information</td>
 
502
          <td align="right" valign="top">
 
503
            
 
504
            
 
505
          </td>
 
506
        </tr>
 
507
      </table>
 
508
      
 
509
    </td>
 
510
  </tr>
 
511
</table>
 
512
<!-- ==================== VARIABLES ==================== -->
 
513
<a name="section-Variables"></a>
 
514
<table class="summary" border="1" cellpadding="3"
 
515
       cellspacing="0" width="100%" bgcolor="white">
 
516
<tr bgcolor="#70b0f0" class="table-header">
 
517
  <td align="left" colspan="2" class="table-header">
 
518
    <span class="table-header">Variables</span></td>
 
519
</tr>
 
520
<tr>
 
521
    <td width="15%" align="right" valign="top" class="summary">
 
522
      <span class="summary-type">&nbsp;</span>
 
523
    </td><td class="summary">
 
524
        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code>
 
525
    </td>
 
526
  </tr>
 
527
</table>
 
528
<!-- ==================== FUNCTION DETAILS ==================== -->
 
529
<a name="section-FunctionDetails"></a>
 
530
<table class="details" border="1" cellpadding="3"
 
531
       cellspacing="0" width="100%" bgcolor="white">
 
532
<tr bgcolor="#70b0f0" class="table-header">
 
533
  <td align="left" colspan="2" class="table-header">
 
534
    <span class="table-header">Function Details</span></td>
 
535
</tr>
 
536
</table>
 
537
<a name="ipv4"></a>
 
538
<div>
 
539
<table class="details" border="1" cellpadding="3"
 
540
       cellspacing="0" width="100%" bgcolor="white">
 
541
<tr><td>
 
542
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
543
  <tr valign="top"><td>
 
544
  <h3 class="epydoc"><span class="sig"><span class="sig-name">ipv4</span>(<span class="sig-arg">interfaceId</span>)</span>
 
545
  </h3>
 
546
  </td><td align="right" valign="top"
 
547
    >&nbsp;
 
548
    </td>
 
549
  </tr></table>
 
550
  
 
551
  <p>Get interface address (IPv4)</p>
 
552
  <dl class="fields">
 
553
    <dt>Parameters:</dt>
 
554
    <dd><ul class="nomargin-top">
 
555
        <li><strong class="pname"><code>interfaceId</code></strong> (int) - the id number for the specified interface</li>
 
556
    </ul></dd>
 
557
    <dt>Returns: string</dt>
 
558
        <dd>the ipv4 address of the interfeceId passed. Empty string if none.
 
559
          Null if no interface passed</dd>
 
560
  </dl>
 
561
</td></tr></table>
 
562
</div>
 
563
<a name="network"></a>
 
564
<div>
 
565
<table class="details" border="1" cellpadding="3"
 
566
       cellspacing="0" width="100%" bgcolor="white">
 
567
<tr><td>
 
568
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
569
  <tr valign="top"><td>
 
570
  <h3 class="epydoc"><span class="sig"><span class="sig-name">network</span>(<span class="sig-arg">interfaceId</span>)</span>
 
571
  </h3>
 
572
  </td><td align="right" valign="top"
 
573
    >&nbsp;
 
574
    </td>
 
575
  </tr></table>
 
576
  
 
577
  <p>Get network and mask to which the interface belongs</p>
 
578
  <dl class="fields">
 
579
    <dt>Parameters:</dt>
 
580
    <dd><ul class="nomargin-top">
 
581
        <li><strong class="pname"><code>interfaceId</code></strong> (int) - the id number for the specified interface</li>
 
582
    </ul></dd>
 
583
    <dt>Returns: string</dt>
 
584
        <dd>the network and the network mask for the specified interfaceId</dd>
 
585
  </dl>
 
586
</td></tr></table>
 
587
</div>
 
588
<a name="numHosts"></a>
 
589
<div>
 
590
<table class="details" border="1" cellpadding="3"
 
591
       cellspacing="0" width="100%" bgcolor="white">
 
592
<tr><td>
 
593
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
594
  <tr valign="top"><td>
 
595
  <h3 class="epydoc"><span class="sig"><span class="sig-name">numHosts</span>(<span class="sig-arg">interfaceId</span>)</span>
 
596
  </h3>
 
597
  </td><td align="right" valign="top"
 
598
    >&nbsp;
 
599
    </td>
 
600
  </tr></table>
 
601
  
 
602
  <p>Get the number of hosts active on this interface</p>
 
603
  <dl class="fields">
 
604
    <dt>Parameters:</dt>
 
605
    <dd><ul class="nomargin-top">
 
606
        <li><strong class="pname"><code>interfaceId</code></strong> (int) - the id number for the specified interface</li>
 
607
    </ul></dd>
 
608
    <dt>Returns: number</dt>
 
609
        <dd>the number of hosts for the specified interfaceId</dd>
 
610
  </dl>
 
611
</td></tr></table>
 
612
</div>
 
613
<a name="ipv6"></a>
 
614
<div>
 
615
<table class="details" border="1" cellpadding="3"
 
616
       cellspacing="0" width="100%" bgcolor="white">
 
617
<tr><td>
 
618
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
619
  <tr valign="top"><td>
 
620
  <h3 class="epydoc"><span class="sig"><span class="sig-name">ipv6</span>(<span class="sig-arg">interfaceId</span>)</span>
 
621
  </h3>
 
622
  </td><td align="right" valign="top"
 
623
    >&nbsp;
 
624
    </td>
 
625
  </tr></table>
 
626
  
 
627
  <p>Get interface address (IPv6)</p>
 
628
  <dl class="fields">
 
629
    <dt>Parameters:</dt>
 
630
    <dd><ul class="nomargin-top">
 
631
        <li><strong class="pname"><code>interfaceId</code></strong> (int) - the id number for the specified interface</li>
 
632
    </ul></dd>
 
633
    <dt>Returns: string</dt>
 
634
        <dd>the ipv6 address of the interfeceId passed. Empty string if none.
 
635
          Null if no interface passed</dd>
 
636
  </dl>
 
637
</td></tr></table>
 
638
</div>
 
639
<a name="time"></a>
 
640
<div>
 
641
<table class="details" border="1" cellpadding="3"
 
642
       cellspacing="0" width="100%" bgcolor="white">
 
643
<tr><td>
 
644
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
 
645
  <tr valign="top"><td>
 
646
  <h3 class="epydoc"><span class="sig"><span class="sig-name">time</span>(<span class="sig-arg">interfaceId</span>)</span>
 
647
  </h3>
 
648
  </td><td align="right" valign="top"
 
649
    >&nbsp;
 
650
    </td>
 
651
  </tr></table>
 
652
  
 
653
  <p>Get interface time</p>
 
654
  <dl class="fields">
 
655
    <dt>Parameters:</dt>
 
656
    <dd><ul class="nomargin-top">
 
657
        <li><strong class="pname"><code>interfaceId</code></strong> (int) - the id number for the specified interface</li>
 
658
    </ul></dd>
 
659
    <dt>Returns: dictionary @return {'startTime':number, 'firstSeen': number, 
 
660
      'lastSeen': number}</dt>
 
661
  </dl>
 
662
</td></tr></table>
 
663
</div>
 
664
<br />
 
665
<!-- ==================== NAVIGATION BAR ==================== -->
 
666
<table class="navbar" border="0" width="100%" cellpadding="0"
 
667
       bgcolor="#a0c0ff" cellspacing="0">
 
668
  <tr valign="middle">
 
669
 
 
670
  <!-- Tree link -->
 
671
      <th>&nbsp;&nbsp;&nbsp;<a
 
672
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
673
 
 
674
  <!-- Index link -->
 
675
      <th>&nbsp;&nbsp;&nbsp;<a
 
676
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 
677
 
 
678
  <!-- Help link -->
 
679
      <th>&nbsp;&nbsp;&nbsp;<a
 
680
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
681
 
 
682
  <!-- Project homepage -->
 
683
      <th class="navbar" align="right" width="100%">
 
684
        <table border="0" cellpadding="0" cellspacing="0">
 
685
          <tr><th class="navbar" align="center"
 
686
            ><a href="http://www.ntop.org/">Ntop</a></th>
 
687
          </tr></table></th>
 
688
  </tr>
 
689
</table>
 
690
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
 
691
  <tr>
 
692
    <td align="left" class="footer">
 
693
    Generated by Epydoc 3.0.1
 
694
    on Thu May  6 14:42:18 2010
 
695
    </td>
 
696
    <td align="right" class="footer">
 
697
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
 
698
        >http://epydoc.sourceforge.net</a>
 
699
    </td>
 
700
  </tr>
 
701
</table>
 
702
 
 
703
<script type="text/javascript">
 
704
  <!--
 
705
  // Private objects are initially displayed (because if
 
706
  // javascript is turned off then we want them to be
 
707
  // visible); but by default, we want to hide them.  So hide
 
708
  // them unless we have a cookie that says to show them.
 
709
  checkCookie();
 
710
  // -->
 
711
</script>
 
712
</body>
 
713
</html>