<commit_before>Overview
========

The **of.topology** is a app responsible to update links between
machines and switches, and build a network topology.

Requirements
============

All requirements is installed using the *requirements.txt* packages.

Installing
==========

This is a default Kytos Network Application and the installation process is
straight forward: Just copy the ``kytos/of.topology`` directory to your napps
directory. The default path is ``/var/lib/kytos/napps/``.

.. note:: Please note that you must copy from the root of the napp (including
    the ``kyto`` folder). So you will have
    ``/var/lib/kytos/napps/kytos/of.topology`` at the end.

If you are going to install the whole repository, with all napps, you do not
have to worry about the above procedings, since all napps will be copied into<commit_msg>updates README.rst file with details about of.topology behaviour.<commit_after>Overview
========

The **of.topology** is an app responsible to update links 
between machines and network devices (i.e. switches and 
routers) and them update the current state of the network 
topology. This application depends of another application, 
called **of.lldp**, since it makes use of lldp packets to 
discover links between network devices. 

This application listen for two kinds of packets in. The 
first one is lldp packets which carry information regarding 
the sender, such as port number, mac address, switch id and 
interface. The other packet that this application listen for 
is port status open flow messages. When a packet of this 
kind is received, the application identify which kind of 
change the packet is warning (i.e. created, deleted or 
modified). In both cases, the application returns a Json file 
with all updated changes identified.

Requirements
============

All requirements is installed using the *requirements.txt* packages.

Installing
==========

This is a default Kytos Network Application and the installation process is
straight forward: Just copy the ``kytos/of.topology`` directory to your napps
directory. The default path is ``/var/lib/kytos/napps/``.

.. note:: Please note that you must copy from the root of the napp (including
    the ``kyto`` folder). So you will have
    ``/var/lib/kytos/napps/kytos/of.topology`` at the end.

If you are going to install the whole repository, with all napps, you do not
have to worry about the above procedings, since all napps will be copied into
{'fraction_non_alphanumeric': 0.0836734693877551, 'fraction_numerical': 0.0, 'mean_word_length': 4.363238512035011, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3599625', 'n_tokens_mistral': 655, 'n_tokens_neox': 644, 'n_words': 342}