Skip to content

Commit

Permalink
Add details about function chains
Browse files Browse the repository at this point in the history
  • Loading branch information
Iain R. Learmonth committed Jul 1, 2016
1 parent 11b707a commit 7ee7e84
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions doc/observer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,34 @@
Observer
========

Observer Function Chains
------------------------

PATHspider's observer will accept functions and pass python-libtrace dissected
packets along with the associated flow record to them for every packet
recieved.

+----------------------+--------------------------------------------------+
| Function Chain | Description |
+======================+==================================================+
| new_flow_chain | Functions to initialise fields in the flow |
| | record for new flows. |
+----------------------+--------------------------------------------------+
| ip4_chain | Functions to record details from IPv4 headers. |
+----------------------+--------------------------------------------------+
| ip6_chain | Functions to record details from IPv6 headers. |
+----------------------+--------------------------------------------------+
| tcp_chain | Functions to record details from TCP headers. |
+----------------------+--------------------------------------------------+
| udp_chain | Functions to record details from UDP headers. |
+----------------------+--------------------------------------------------+
| l4_chain | Functions to record details from other layer |
| | 4 headers. |
+----------------------+--------------------------------------------------+

If a function returns False, the Observer will consider the flow to be finished
and will pass it to be merged with the job record after a short delay.

Observer Implementation
-----------------------

Expand Down

0 comments on commit 7ee7e84

Please sign in to comment.