Skip to content

Commit

Permalink
trying nwe code automodule rtd
Browse files Browse the repository at this point in the history
  • Loading branch information
jay-johnson committed Apr 2, 2018
1 parent aa5e3a7 commit b290798
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/source/handle_packets.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Source Code - Handle Packets from a Network Interface
=====================================================

This is the default handler for processing network packets received from the network interface with ``eth0`` or ``eth1``. In production, this is the starting point for making live predictions with the AntiNex REST API.

Here is the workflow for processing a network packet from a monitored interface:

#. Get Available Layers in the Packet
#. Convert the Packet to a JSON dictionary
#. Publish the Message using Kombu with environment values setting the routing decision for the message in the aggregation message broker: ``FORWARD_EXCHANGE``, ``FORWARD_ROUTING_KEY``, ``FORWARD_QUEUE``.

.. automodule:: network_pipeline.handle_packets
:members: handle_packets
3 changes: 3 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,9 @@ These are the docs for the AntiNex Network Pipeline repository.
.. toctree::
:maxdepth: 2

handle_packets
record_packets_to_csv

Indices and tables
==================

Expand Down
7 changes: 7 additions & 0 deletions docs/source/record_packets_to_csv.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Source Code - Process Consumed Messages from the Queue
======================================================

This is the default handler for processing messages consumed from the aggregration message broker. At the conceptual level, all network interface capture tools forward JSON dictionaries to this class.

.. automodule:: network_pipeline.record_packets_to_csv
:members: RecordPacketsToCSV

0 comments on commit b290798

Please sign in to comment.