%
% API Documentation
% Module network
%
% Generated by epydoc 2.1
% [Mon Oct 31 17:18:56 2005]
%

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                          Module Description                           %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    \index{network \textit{(module)}|(}
\section{Module network}

    \label{network}
This module is a group of some useful function to work with network


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                               Functions                               %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsection{Functions}

    \label{network:bloc_ipmask}
    \index{network \textit{(module)}!bloc\_ipmask \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{bloc\_ipmask}(\textit{blocip}, \textit{blocmask})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    internal function :return the string that corresponds to blocnetwork 
    and the number of bit of blocmask

    \vspace{1ex}

    \end{boxedminipage}

    \label{network:checkIP}
    \index{network \textit{(module)}!checkIP \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{checkIP}(\textit{ip})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    checks if the IP ip is a valid one

    \vspace{1ex}

    \end{boxedminipage}

    \label{network:cmp_ip}
    \index{network \textit{(module)}!cmp\_ip \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{cmp\_ip}(\textit{ip1}, \textit{ip2})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    comparaison function for ip

    \vspace{1ex}

    \end{boxedminipage}

    \label{network:cmp_ip_port}
    \index{network \textit{(module)}!cmp\_ip\_port \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{cmp\_ip\_port}(\textit{iport1}, \textit{iport2})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    comparaison function for pair (ip,port)

    \vspace{1ex}

    \end{boxedminipage}

    \label{network:cmp_port}
    \index{network \textit{(module)}!cmp\_port \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{cmp\_port}(\textit{port1}, \textit{port2})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    comparaison function for port (port the number or port the structure)

    \vspace{1ex}

    \end{boxedminipage}

    \label{network:ip_mask2network}
    \index{network \textit{(module)}!ip\_mask2network \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{ip\_mask2network}(\textit{ip}, \textit{mask})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    return ip/number of 1 in the binary representation of mask

    \vspace{1ex}

    \end{boxedminipage}

    \label{network:str10tostr2}
    \index{network \textit{(module)}!str10tostr2 \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{str10tostr2}(\textit{bloc})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    Convert a str which represents a int between 0 and 255 in the 8 
    character string of his binary representation

    \vspace{1ex}

    \end{boxedminipage}

    \label{network:str2tostr10}
    \index{network \textit{(module)}!str2tostr10 \textit{(function)}}
    \vspace{0.5ex}

    \begin{boxedminipage}{\textwidth}

    \raggedright \textbf{str2tostr10}(\textit{bloc})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
    Convert a bloc of 8 0 et 1 in a string which is the decimal 
    representation of this number

    \vspace{1ex}

    \end{boxedminipage}

    \index{network \textit{(module)}|)}