sorting-networkanalyzer/doc/en/latex/class_packet.tex

\hypertarget{class_packet}{}\section{Packet Class Reference}
\label{class_packet}\index{Packet@{Packet}}


A class to represent packets.  




{\ttfamily \#include $<$packet.\+h$>$}

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_packet_aabcfb963c0d5bc0fa554668f92989622}{Packet} ()
\begin{DoxyCompactList}\small\item\em Default constructor. The properties of the packet are set as follows\+: \end{DoxyCompactList}\item 
\hyperlink{class_packet_a46516634a765e6fea19a4df08406adc8}{Packet} (string, string, int, int, int, int)
\begin{DoxyCompactList}\small\item\em Constructor which accepts specification for sa(src\+\_\+addr), da(dst\+\_\+addr), sp(src\+\_\+port), dp(dst\+\_\+port), oct(octects) and pkt(packets) \end{DoxyCompactList}\item 
string \hyperlink{class_packet_a3e9aed01edd0023e97276041894c5c1f}{get\+Src\+Addr} ()
\begin{DoxyCompactList}\small\item\em Getter for the source addr. \end{DoxyCompactList}\item 
string \hyperlink{class_packet_a092161eb22c1ff6ffa2eb9961d3868b0}{get\+Dst\+Addr} ()
\begin{DoxyCompactList}\small\item\em Getter for the destination addr. \end{DoxyCompactList}\item 
int \hyperlink{class_packet_acf4fbcd48861393cbc96c6aeb9e5846f}{get\+Src\+Port} ()
\begin{DoxyCompactList}\small\item\em Getter for the source port. \end{DoxyCompactList}\item 
int \hyperlink{class_packet_a92347c94882b6e5b3209cc70ea0d77b5}{get\+Dst\+Port} ()
\begin{DoxyCompactList}\small\item\em Getter for the destination port. \end{DoxyCompactList}\item 
\hypertarget{class_packet_acd8d06afbd5a289a8b92e02d0cf72cc1}{}int {\bfseries get\+Octects} ()\label{class_packet_acd8d06afbd5a289a8b92e02d0cf72cc1}

\item 
int \hyperlink{class_packet_a6ee74fd953f6d57d56e48a596d897f05}{get\+Packets} ()
\begin{DoxyCompactList}\small\item\em Getter for the packets. \end{DoxyCompactList}\item 
void \hyperlink{class_packet_a8c939968eb35f357884900bf8794a3d7}{set\+Src\+Addr} (string)
\begin{DoxyCompactList}\small\item\em Setter for the src\+\_\+addr. \end{DoxyCompactList}\item 
void \hyperlink{class_packet_acaa3e1703fe14b9a39d4c4426453e65c}{set\+Dst\+Addr} (string)
\begin{DoxyCompactList}\small\item\em Setter for the destination addr. \end{DoxyCompactList}\item 
void \hyperlink{class_packet_a9844970ffe7eb2ecf6e2407a39f04807}{set\+Src\+Port} (int)
\begin{DoxyCompactList}\small\item\em Setter for the source port. \end{DoxyCompactList}\item 
void \hyperlink{class_packet_ab51c81cc6958913652b3fe5316ec6af3}{set\+Dst\+Port} (int)
\begin{DoxyCompactList}\small\item\em Setter for the destination port. \end{DoxyCompactList}\item 
\hypertarget{class_packet_adc6e90455b92f776ec7583d5e62b50d7}{}void {\bfseries set\+Octects} (int)\label{class_packet_adc6e90455b92f776ec7583d5e62b50d7}

\item 
void \hyperlink{class_packet_acfb4620179dba167031a8e8b1cad0c25}{set\+Packets} (int)
\begin{DoxyCompactList}\small\item\em Setter for the packets value. \end{DoxyCompactList}\item 
\hypertarget{class_packet_a5b57162c18731c0186027f450670d14e}{}void \hyperlink{class_packet_a5b57162c18731c0186027f450670d14e}{enable} ()\label{class_packet_a5b57162c18731c0186027f450670d14e}

\begin{DoxyCompactList}\small\item\em Sets that the packet is enabled to be displayed in G\+U\+I. \end{DoxyCompactList}\item 
\hypertarget{class_packet_a0c16d1f66f1fd8c99e9e760cf2ce07f2}{}void \hyperlink{class_packet_a0c16d1f66f1fd8c99e9e760cf2ce07f2}{disable} ()\label{class_packet_a0c16d1f66f1fd8c99e9e760cf2ce07f2}

\begin{DoxyCompactList}\small\item\em Sets that the packet is disabled to be displayed in G\+U\+I. \end{DoxyCompactList}\item 
\hypertarget{class_packet_a3c92559f89a09cd5790e8ab5171b509f}{}bool {\bfseries is\+Enabled} ()\label{class_packet_a3c92559f89a09cd5790e8ab5171b509f}

\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
string \hyperlink{class_packet_ad22856878226959be10e1a024e3446cc}{src\+\_\+addr}
\item 
string \hyperlink{class_packet_a4a1c8c11292c6116e393245fbfad00b7}{dst\+\_\+addr}
\item 
int \hyperlink{class_packet_a191dd835177b18f84fd64596249008cc}{src\+\_\+port}
\item 
int \hyperlink{class_packet_ae8a78379783d1a2795318ca9118e77e3}{dst\+\_\+port}
\item 
int \hyperlink{class_packet_a3dfcef408535f5e7ecdb3ef6bc3e9654}{octects}
\item 
int \hyperlink{class_packet_abe4ea1613634961b78de7c609b1f0c75}{packets}
\item 
bool \hyperlink{class_packet_a72dbd5f3d8e2f802ebb4173c64495cda}{enabled}
\end{DoxyCompactItemize}


\subsection{Detailed Description}
A class to represent packets. 

The class contains two constructurs and various functions for searching and filtering network flow packets. 

\subsection{Constructor \& Destructor Documentation}
\hypertarget{class_packet_aabcfb963c0d5bc0fa554668f92989622}{}\index{Packet@{Packet}!Packet@{Packet}}
\index{Packet@{Packet}!Packet@{Packet}}
\subsubsection[{Packet}]{\setlength{\rightskip}{0pt plus 5cm}Packet\+::\+Packet (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}\label{class_packet_aabcfb963c0d5bc0fa554668f92989622}


Default constructor. The properties of the packet are set as follows\+: 


\begin{DoxyItemize}
\item src\+\_\+addr\+: set to the empty string.
\item dst\+\_\+addr\+: set to the empty string.
\item src\+\_\+port\+: set to 0.
\item dst\+\_\+port\+: set to 0.
\item octects\+: set to 0.
\item packets\+: set to 0.
\item enabled\+: set to false. 
\end{DoxyItemize}\hypertarget{class_packet_a46516634a765e6fea19a4df08406adc8}{}\index{Packet@{Packet}!Packet@{Packet}}
\index{Packet@{Packet}!Packet@{Packet}}
\subsubsection[{Packet}]{\setlength{\rightskip}{0pt plus 5cm}Packet\+::\+Packet (
\begin{DoxyParamCaption}
\item[{string}]{sa, }
\item[{string}]{da, }
\item[{int}]{sp, }
\item[{int}]{dp, }
\item[{int}]{oct, }
\item[{int}]{pkt}
\end{DoxyParamCaption}
)}\label{class_packet_a46516634a765e6fea19a4df08406adc8}


Constructor which accepts specification for sa(src\+\_\+addr), da(dst\+\_\+addr), sp(src\+\_\+port), dp(dst\+\_\+port), oct(octects) and pkt(packets) 


\begin{DoxyParams}{Parameters}
{\em sa} & source address \\
\hline
{\em da} & destination address \\
\hline
{\em sp} & source port \\
\hline
{\em dp} & destination port \\
\hline
{\em oct} & octects \\
\hline
{\em pkt} & packets \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\hypertarget{class_packet_a092161eb22c1ff6ffa2eb9961d3868b0}{}\index{Packet@{Packet}!get\+Dst\+Addr@{get\+Dst\+Addr}}
\index{get\+Dst\+Addr@{get\+Dst\+Addr}!Packet@{Packet}}
\subsubsection[{get\+Dst\+Addr}]{\setlength{\rightskip}{0pt plus 5cm}string Packet\+::get\+Dst\+Addr (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}\label{class_packet_a092161eb22c1ff6ffa2eb9961d3868b0}


Getter for the destination addr. 

\begin{DoxyReturn}{Returns}
dst address 
\end{DoxyReturn}
\hypertarget{class_packet_a92347c94882b6e5b3209cc70ea0d77b5}{}\index{Packet@{Packet}!get\+Dst\+Port@{get\+Dst\+Port}}
\index{get\+Dst\+Port@{get\+Dst\+Port}!Packet@{Packet}}
\subsubsection[{get\+Dst\+Port}]{\setlength{\rightskip}{0pt plus 5cm}string Packet\+::get\+Dst\+Port (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}\label{class_packet_a92347c94882b6e5b3209cc70ea0d77b5}


Getter for the destination port. 

\begin{DoxyReturn}{Returns}
dst port 
\end{DoxyReturn}
\hypertarget{class_packet_a6ee74fd953f6d57d56e48a596d897f05}{}\index{Packet@{Packet}!get\+Packets@{get\+Packets}}
\index{get\+Packets@{get\+Packets}!Packet@{Packet}}
\subsubsection[{get\+Packets}]{\setlength{\rightskip}{0pt plus 5cm}string Packet\+::get\+Packets (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}\label{class_packet_a6ee74fd953f6d57d56e48a596d897f05}


Getter for the packets. 

\begin{DoxyReturn}{Returns}
packets 
\end{DoxyReturn}
\hypertarget{class_packet_a3e9aed01edd0023e97276041894c5c1f}{}\index{Packet@{Packet}!get\+Src\+Addr@{get\+Src\+Addr}}
\index{get\+Src\+Addr@{get\+Src\+Addr}!Packet@{Packet}}
\subsubsection[{get\+Src\+Addr}]{\setlength{\rightskip}{0pt plus 5cm}string Packet\+::get\+Src\+Addr (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}\label{class_packet_a3e9aed01edd0023e97276041894c5c1f}


Getter for the source addr. 

\begin{DoxyReturn}{Returns}
src address 
\end{DoxyReturn}
\hypertarget{class_packet_acf4fbcd48861393cbc96c6aeb9e5846f}{}\index{Packet@{Packet}!get\+Src\+Port@{get\+Src\+Port}}
\index{get\+Src\+Port@{get\+Src\+Port}!Packet@{Packet}}
\subsubsection[{get\+Src\+Port}]{\setlength{\rightskip}{0pt plus 5cm}string Packet\+::get\+Src\+Port (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}\label{class_packet_acf4fbcd48861393cbc96c6aeb9e5846f}


Getter for the source port. 

\begin{DoxyReturn}{Returns}
src port 
\end{DoxyReturn}
\hypertarget{class_packet_acaa3e1703fe14b9a39d4c4426453e65c}{}\index{Packet@{Packet}!set\+Dst\+Addr@{set\+Dst\+Addr}}
\index{set\+Dst\+Addr@{set\+Dst\+Addr}!Packet@{Packet}}
\subsubsection[{set\+Dst\+Addr}]{\setlength{\rightskip}{0pt plus 5cm}void Packet\+::set\+Dst\+Addr (
\begin{DoxyParamCaption}
\item[{string}]{addr}
\end{DoxyParamCaption}
)}\label{class_packet_acaa3e1703fe14b9a39d4c4426453e65c}


Setter for the destination addr. 


\begin{DoxyParams}{Parameters}
{\em addr} & destination address \\
\hline
\end{DoxyParams}
\hypertarget{class_packet_ab51c81cc6958913652b3fe5316ec6af3}{}\index{Packet@{Packet}!set\+Dst\+Port@{set\+Dst\+Port}}
\index{set\+Dst\+Port@{set\+Dst\+Port}!Packet@{Packet}}
\subsubsection[{set\+Dst\+Port}]{\setlength{\rightskip}{0pt plus 5cm}void Packet\+::set\+Dst\+Port (
\begin{DoxyParamCaption}
\item[{int}]{port}
\end{DoxyParamCaption}
)}\label{class_packet_ab51c81cc6958913652b3fe5316ec6af3}


Setter for the destination port. 


\begin{DoxyParams}{Parameters}
{\em port} & destination port \\
\hline
\end{DoxyParams}
\hypertarget{class_packet_acfb4620179dba167031a8e8b1cad0c25}{}\index{Packet@{Packet}!set\+Packets@{set\+Packets}}
\index{set\+Packets@{set\+Packets}!Packet@{Packet}}
\subsubsection[{set\+Packets}]{\setlength{\rightskip}{0pt plus 5cm}void Packet\+::set\+Packets (
\begin{DoxyParamCaption}
\item[{int}]{val}
\end{DoxyParamCaption}
)}\label{class_packet_acfb4620179dba167031a8e8b1cad0c25}


Setter for the packets value. 


\begin{DoxyParams}{Parameters}
{\em val} & packets \\
\hline
\end{DoxyParams}
\hypertarget{class_packet_a8c939968eb35f357884900bf8794a3d7}{}\index{Packet@{Packet}!set\+Src\+Addr@{set\+Src\+Addr}}
\index{set\+Src\+Addr@{set\+Src\+Addr}!Packet@{Packet}}
\subsubsection[{set\+Src\+Addr}]{\setlength{\rightskip}{0pt plus 5cm}void Packet\+::set\+Src\+Addr (
\begin{DoxyParamCaption}
\item[{string}]{addr}
\end{DoxyParamCaption}
)}\label{class_packet_a8c939968eb35f357884900bf8794a3d7}


Setter for the src\+\_\+addr. 


\begin{DoxyParams}{Parameters}
{\em addr} & source address \\
\hline
\end{DoxyParams}
\hypertarget{class_packet_a9844970ffe7eb2ecf6e2407a39f04807}{}\index{Packet@{Packet}!set\+Src\+Port@{set\+Src\+Port}}
\index{set\+Src\+Port@{set\+Src\+Port}!Packet@{Packet}}
\subsubsection[{set\+Src\+Port}]{\setlength{\rightskip}{0pt plus 5cm}void Packet\+::set\+Src\+Port (
\begin{DoxyParamCaption}
\item[{int}]{port}
\end{DoxyParamCaption}
)}\label{class_packet_a9844970ffe7eb2ecf6e2407a39f04807}


Setter for the source port. 


\begin{DoxyParams}{Parameters}
{\em port} & source port \\
\hline
\end{DoxyParams}


\subsection{Member Data Documentation}
\hypertarget{class_packet_a4a1c8c11292c6116e393245fbfad00b7}{}\index{Packet@{Packet}!dst\+\_\+addr@{dst\+\_\+addr}}
\index{dst\+\_\+addr@{dst\+\_\+addr}!Packet@{Packet}}
\subsubsection[{dst\+\_\+addr}]{\setlength{\rightskip}{0pt plus 5cm}string Packet\+::dst\+\_\+addr\hspace{0.3cm}{\ttfamily [private]}}\label{class_packet_a4a1c8c11292c6116e393245fbfad00b7}
dst\+\_\+addr destination address (direccion destino) \hypertarget{class_packet_ae8a78379783d1a2795318ca9118e77e3}{}\index{Packet@{Packet}!dst\+\_\+port@{dst\+\_\+port}}
\index{dst\+\_\+port@{dst\+\_\+port}!Packet@{Packet}}
\subsubsection[{dst\+\_\+port}]{\setlength{\rightskip}{0pt plus 5cm}int Packet\+::dst\+\_\+port\hspace{0.3cm}{\ttfamily [private]}}\label{class_packet_ae8a78379783d1a2795318ca9118e77e3}
dst\+\_\+port destination port (puerto destino) \hypertarget{class_packet_a72dbd5f3d8e2f802ebb4173c64495cda}{}\index{Packet@{Packet}!enabled@{enabled}}
\index{enabled@{enabled}!Packet@{Packet}}
\subsubsection[{enabled}]{\setlength{\rightskip}{0pt plus 5cm}bool Packet\+::enabled\hspace{0.3cm}{\ttfamily [private]}}\label{class_packet_a72dbd5f3d8e2f802ebb4173c64495cda}
enabled in the G\+U\+I (disponible en el G\+U\+I) \hypertarget{class_packet_a3dfcef408535f5e7ecdb3ef6bc3e9654}{}\index{Packet@{Packet}!octects@{octects}}
\index{octects@{octects}!Packet@{Packet}}
\subsubsection[{octects}]{\setlength{\rightskip}{0pt plus 5cm}int Packet\+::octects\hspace{0.3cm}{\ttfamily [private]}}\label{class_packet_a3dfcef408535f5e7ecdb3ef6bc3e9654}
octets/bytes value (octetos) \hypertarget{class_packet_abe4ea1613634961b78de7c609b1f0c75}{}\index{Packet@{Packet}!packets@{packets}}
\index{packets@{packets}!Packet@{Packet}}
\subsubsection[{packets}]{\setlength{\rightskip}{0pt plus 5cm}int Packet\+::packets\hspace{0.3cm}{\ttfamily [private]}}\label{class_packet_abe4ea1613634961b78de7c609b1f0c75}
packets value (paquetes) \hypertarget{class_packet_ad22856878226959be10e1a024e3446cc}{}\index{Packet@{Packet}!src\+\_\+addr@{src\+\_\+addr}}
\index{src\+\_\+addr@{src\+\_\+addr}!Packet@{Packet}}
\subsubsection[{src\+\_\+addr}]{\setlength{\rightskip}{0pt plus 5cm}string Packet\+::src\+\_\+addr\hspace{0.3cm}{\ttfamily [private]}}\label{class_packet_ad22856878226959be10e1a024e3446cc}
src\+\_\+addr source address (direccion fuente) \hypertarget{class_packet_a191dd835177b18f84fd64596249008cc}{}\index{Packet@{Packet}!src\+\_\+port@{src\+\_\+port}}
\index{src\+\_\+port@{src\+\_\+port}!Packet@{Packet}}
\subsubsection[{src\+\_\+port}]{\setlength{\rightskip}{0pt plus 5cm}int Packet\+::src\+\_\+port\hspace{0.3cm}{\ttfamily [private]}}\label{class_packet_a191dd835177b18f84fd64596249008cc}
src\+\_\+port source port (puerto fuente) 

The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item 
packet.\+h\item 
packet.\+cpp\end{DoxyCompactItemize}