vrr/nfstream
2
0
Fork 0
mirror of https://github.com/nfstream/nfstream.git synced 2026-05-21 18:46:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Major cleanup.

Browse source
This commit is contained in:
aouinizied 2019-12-06 19:03:51 +01:00
parent 489db8e175
commit 26b484d1e7
7 changed files with 86 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/source/get_started.rst
View file

@ -58,13 +58,13 @@ NFStreamer object
- Maximum per flow UDP packets to dissect (ignored when dissect=False).
NFStreamer returns an iterator of **NFFlow** object.
NFStreamer returns an iterator of **NFEntry** object.
*************
NFFlow object
*************
**************
NFEntry object
**************
.. list-table:: NFFlow object
.. list-table:: NFEntry object
:widths: 25 25 50
:header-rows: 1
@ -159,7 +159,7 @@ NFFlow object
- str
- J3A_ server fingerprint.
**NFFlow** is an aggregation of **NFPacket** objects.
**NFEntry** is an aggregation of **NFPacket** objects.
***************
NFPacket object

6
docs/source/plugins.rst
View file

@ -39,15 +39,15 @@ NFPlugin methods
****************
* ``on_init(self, obs)`` [default= ``return 0`` ]
- Method called at entry creation). When aggregating packets into flows, this method is called on ``NFFlow`` object creation based on first ``NFPacket`` object belonging to it.
- Method called at entry creation). When aggregating packets into flows, this method is called on ``NFEntry`` object creation based on first ``NFPacket`` object belonging to it.
* ``on_update(self, obs, entry)`` [default= ``pass`` ]
- Method called to update each entry with its belonging obs. When aggregating packets into flows, the entry is an ``NFFlow`` object and the obs is an ``NFPacket`` object.
- Method called to update each entry with its belonging obs. When aggregating packets into flows, the entry is an ``NFEntry`` object and the obs is an ``NFPacket`` object.
* ``on_expire(self, entry)`` [default= ``pass`` ]
- Method called at entry expiration. When aggregating packets into flows, the entry is an ``NFFlow``
- Method called at entry expiration. When aggregating packets into flows, the entry is an ``NFEntry``
* ``cleanup(self)`` [default= ``pass`` ]