YANP-it, Yet Another Network Profiler

YANP-it (short version of yet another network profiler) is a project to be developed throughout the ages to assess networking connections, obtaining some metrics from them, such as bandwidth, delay, jitter, packet loss, in both active and passive way. This project, despite being able to feature functionalities which could cover most of the network scenarios, is most specifically developed for vehicular networks.

Getting Started

You can first clone this repository or download a proper tagged release in order to proceed with the installation.

git clone https://code.nap.av.it.pt/mobility-networks/yanp-it.git --recurse-submodules

Then you can compile the code as a usual CMake project.

cd yanpit
mkdir build
cd build
cmake ..
make

In order to install this package onto your machine, you just need to run the following command, in which you are instructing to install the binary in the /opt/bin directory:

sudo make install

Project Structure

This project follows the standardized project structure as Go's. For more information, please consult this link.

• api, descriptions for external interfaces;
• cmd, executables for main applications for this project;
• docs, design and user documents for this project;
• internal, some internal libraries, exclusive to this project;
• pkg, libraries for applications of this project and others;
• tests, software and unit testing codes;
• vendor, application dependencies (manually managed).

Code Style

This current project uses a formatting style based on the LLVM coding style. For more information you can consult this link on LLVM Coding Style and the definition of style with the Clang Formatting file in .clang-format.

To apply the coding format as defined in the description file you can use the standalone tool of ClangFormat, but the easiest way is to explore the IDE integration of the ClangFormat file and formatter. More information about it can be seen through this link.

Development tools and platforms

Some notes and thoughts for developers can be accessed and edited in the following Notion page: this project's notes.