\hypertarget{classFirewallGet}{
\section{FirewallGet Class Reference}
\label{classFirewallGet}\index{FirewallGet@{FirewallGet}}
}
Inheritance diagram for FirewallGet:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classFirewallGet}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classFirewallGet_abf835c9f8d658c4f6c7b9615c8279dd0}{FirewallGet} (\hyperlink{classFeaDataPlaneManager}{FeaDataPlaneManager} \&fea\_\-data\_\-plane\_\-manager)
\begin{DoxyCompactList}\small\item\em Constructor. \item\end{DoxyCompactList}\item 
\hypertarget{classFirewallGet_aed330573bb34b015f7f056337269cb3f}{
virtual \hyperlink{classFirewallGet_aed330573bb34b015f7f056337269cb3f}{$\sim$FirewallGet} ()}
\label{classFirewallGet_aed330573bb34b015f7f056337269cb3f}

\begin{DoxyCompactList}\small\item\em Virtual destructor. \item\end{DoxyCompactList}\item 
\hyperlink{classFirewallManager}{FirewallManager} \& \hyperlink{classFirewallGet_ade69998583e9eca7f0cba4e615f7b0a5}{firewall\_\-manager} ()
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} \hyperlink{classFirewallManager}{FirewallManager} instance. \item\end{DoxyCompactList}\item 
\hyperlink{classFeaDataPlaneManager}{FeaDataPlaneManager} \& \hyperlink{classFirewallGet_a47bb7f0fb74f888a1cc54418b7f457cc}{fea\_\-data\_\-plane\_\-manager} ()
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} \hyperlink{classFeaDataPlaneManager}{FeaDataPlaneManager} instance. \item\end{DoxyCompactList}\item 
virtual bool \hyperlink{classFirewallGet_a52dbbc6b1eadf344fd71f793a359aa7b}{is\_\-running} () const 
\begin{DoxyCompactList}\small\item\em Test whether this instance is running. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{classFirewallGet_ace67d987d1a1103f6a1c63df7bbae254}{start} (string \&error\_\-msg)=0
\begin{DoxyCompactList}\small\item\em Start operation. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{classFirewallGet_a140a600dc197aa474ffd05a63d05ff43}{stop} (string \&error\_\-msg)=0
\begin{DoxyCompactList}\small\item\em Stop operation. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{classFirewallGet_a0b86353a819777a0cf49391cba2c0fb1}{get\_\-table4} (list$<$ \hyperlink{classFirewallEntry}{FirewallEntry} $>$ \&firewall\_\-entry\_\-list, string \&error\_\-msg)=0
\begin{DoxyCompactList}\small\item\em Obtain \hyperlink{protocolthe-p}{the} \hyperlink{classIPv4}{IPv4} firewall table. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{classFirewallGet_aac422b2d3c4fdeefb9c164cde2dc69c6}{get\_\-table6} (list$<$ \hyperlink{classFirewallEntry}{FirewallEntry} $>$ \&firewall\_\-entry\_\-list, string \&error\_\-msg)=0
\begin{DoxyCompactList}\small\item\em Obtain \hyperlink{protocolthe-p}{the} \hyperlink{classIPv6}{IPv6} firewall table. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classFirewallGet_a9f7a83fee6e9b59e927a09111adefa1e}{
bool {\bfseries \_\-is\_\-running}}
\label{classFirewallGet_a9f7a83fee6e9b59e927a09111adefa1e}

\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classFirewallGet_a683600e452d042373dfb241753496c9c}{
\hyperlink{classFirewallManager}{FirewallManager} \& {\bfseries \_\-firewall\_\-manager}}
\label{classFirewallGet_a683600e452d042373dfb241753496c9c}

\item 
\hypertarget{classFirewallGet_ae8035437c36a7082fa809a38ac672c0f}{
\hyperlink{classFeaDataPlaneManager}{FeaDataPlaneManager} \& {\bfseries \_\-fea\_\-data\_\-plane\_\-manager}}
\label{classFirewallGet_ae8035437c36a7082fa809a38ac672c0f}

\end{DoxyCompactItemize}


\subsection{Constructor \& Destructor Documentation}
\hypertarget{classFirewallGet_abf835c9f8d658c4f6c7b9615c8279dd0}{
\index{FirewallGet@{FirewallGet}!FirewallGet@{FirewallGet}}
\index{FirewallGet@{FirewallGet}!FirewallGet@{FirewallGet}}
\subsubsection[{FirewallGet}]{\setlength{\rightskip}{0pt plus 5cm}FirewallGet::FirewallGet (
\begin{DoxyParamCaption}
\item[{{\bf FeaDataPlaneManager} \&}]{fea\_\-data\_\-plane\_\-manager}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classFirewallGet_abf835c9f8d658c4f6c7b9615c8279dd0}


Constructor. 


\begin{DoxyParams}{Parameters}
{\em fea\_\-data\_\-plane\_\-manager} & \hyperlink{protocolthe-p}{the} corresponding data plane manager (\hyperlink{classFeaDataPlaneManager}{FeaDataPlaneManager}). \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\hypertarget{classFirewallGet_a47bb7f0fb74f888a1cc54418b7f457cc}{
\index{FirewallGet@{FirewallGet}!fea\_\-data\_\-plane\_\-manager@{fea\_\-data\_\-plane\_\-manager}}
\index{fea\_\-data\_\-plane\_\-manager@{fea\_\-data\_\-plane\_\-manager}!FirewallGet@{FirewallGet}}
\subsubsection[{fea\_\-data\_\-plane\_\-manager}]{\setlength{\rightskip}{0pt plus 5cm}{\bf FeaDataPlaneManager}\& FirewallGet::fea\_\-data\_\-plane\_\-manager (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classFirewallGet_a47bb7f0fb74f888a1cc54418b7f457cc}


Get \hyperlink{protocolthe-p}{the} \hyperlink{classFeaDataPlaneManager}{FeaDataPlaneManager} instance. 

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} \hyperlink{classFeaDataPlaneManager}{FeaDataPlaneManager} instance. 
\end{DoxyReturn}
\hypertarget{classFirewallGet_ade69998583e9eca7f0cba4e615f7b0a5}{
\index{FirewallGet@{FirewallGet}!firewall\_\-manager@{firewall\_\-manager}}
\index{firewall\_\-manager@{firewall\_\-manager}!FirewallGet@{FirewallGet}}
\subsubsection[{firewall\_\-manager}]{\setlength{\rightskip}{0pt plus 5cm}{\bf FirewallManager}\& FirewallGet::firewall\_\-manager (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classFirewallGet_ade69998583e9eca7f0cba4e615f7b0a5}


Get \hyperlink{protocolthe-p}{the} \hyperlink{classFirewallManager}{FirewallManager} instance. 

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} \hyperlink{classFirewallManager}{FirewallManager} instance. 
\end{DoxyReturn}
\hypertarget{classFirewallGet_a0b86353a819777a0cf49391cba2c0fb1}{
\index{FirewallGet@{FirewallGet}!get\_\-table4@{get\_\-table4}}
\index{get\_\-table4@{get\_\-table4}!FirewallGet@{FirewallGet}}
\subsubsection[{get\_\-table4}]{\setlength{\rightskip}{0pt plus 5cm}virtual int FirewallGet::get\_\-table4 (
\begin{DoxyParamCaption}
\item[{list$<$ {\bf FirewallEntry} $>$ \&}]{firewall\_\-entry\_\-list, }
\item[{string \&}]{error\_\-msg}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
\label{classFirewallGet_a0b86353a819777a0cf49391cba2c0fb1}


Obtain \hyperlink{protocolthe-p}{the} \hyperlink{classIPv4}{IPv4} firewall table. 


\begin{DoxyParams}{Parameters}
{\em firewall\_\-entry\_\-list} & \hyperlink{protocolthe-p}{the} return-\/by-\/reference list with all entries in \hyperlink{protocolthe-p}{the} \hyperlink{classIPv4}{IPv4} firewall table. \\
\hline
{\em error\_\-msg} & \hyperlink{protocolthe-p}{the} error message (if error). \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
XORP\_\-OK on success, otherwise XORP\_\-ERROR. 
\end{DoxyReturn}


Implemented in \hyperlink{classFirewallGetDummy_a0e090d6f80766daac10520e531f31abb}{FirewallGetDummy}, \hyperlink{classFirewallGetIpfw2_a21b09b2b55bf3a9e987518914c987297}{FirewallGetIpfw2}, \hyperlink{classFirewallGetNetfilter_a7198ad54dc0525b86548c5f9579fd125}{FirewallGetNetfilter}, and \hyperlink{classFirewallGetPf_a40cd5e7646718e270fdf42b241673e11}{FirewallGetPf}.

\hypertarget{classFirewallGet_aac422b2d3c4fdeefb9c164cde2dc69c6}{
\index{FirewallGet@{FirewallGet}!get\_\-table6@{get\_\-table6}}
\index{get\_\-table6@{get\_\-table6}!FirewallGet@{FirewallGet}}
\subsubsection[{get\_\-table6}]{\setlength{\rightskip}{0pt plus 5cm}virtual int FirewallGet::get\_\-table6 (
\begin{DoxyParamCaption}
\item[{list$<$ {\bf FirewallEntry} $>$ \&}]{firewall\_\-entry\_\-list, }
\item[{string \&}]{error\_\-msg}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
\label{classFirewallGet_aac422b2d3c4fdeefb9c164cde2dc69c6}


Obtain \hyperlink{protocolthe-p}{the} \hyperlink{classIPv6}{IPv6} firewall table. 


\begin{DoxyParams}{Parameters}
{\em firewall\_\-entry\_\-list} & \hyperlink{protocolthe-p}{the} return-\/by-\/reference list with all entries in \hyperlink{protocolthe-p}{the} \hyperlink{classIPv6}{IPv6} firewall table. \\
\hline
{\em error\_\-msg} & \hyperlink{protocolthe-p}{the} error message (if error). \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
XORP\_\-OK on success, otherwise XORP\_\-ERROR. 
\end{DoxyReturn}


Implemented in \hyperlink{classFirewallGetDummy_a16ab908e292505b62954f5b1d63d5201}{FirewallGetDummy}, \hyperlink{classFirewallGetIpfw2_a7c847efd90f6e2ac2e93d5e134b7a37c}{FirewallGetIpfw2}, \hyperlink{classFirewallGetNetfilter_add0a9ef85d76f0e3579a5322109f1898}{FirewallGetNetfilter}, and \hyperlink{classFirewallGetPf_ad455436e1bc0e80bfd4b338e2474c9f0}{FirewallGetPf}.

\hypertarget{classFirewallGet_a52dbbc6b1eadf344fd71f793a359aa7b}{
\index{FirewallGet@{FirewallGet}!is\_\-running@{is\_\-running}}
\index{is\_\-running@{is\_\-running}!FirewallGet@{FirewallGet}}
\subsubsection[{is\_\-running}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool FirewallGet::is\_\-running (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline, virtual\mbox{]}}}}
\label{classFirewallGet_a52dbbc6b1eadf344fd71f793a359aa7b}


Test whether this instance is running. 

\begin{DoxyReturn}{Returns}
true if \hyperlink{protocolthe-p}{the} instance is running, otherwise false. 
\end{DoxyReturn}
\hypertarget{classFirewallGet_ace67d987d1a1103f6a1c63df7bbae254}{
\index{FirewallGet@{FirewallGet}!start@{start}}
\index{start@{start}!FirewallGet@{FirewallGet}}
\subsubsection[{start}]{\setlength{\rightskip}{0pt plus 5cm}virtual int FirewallGet::start (
\begin{DoxyParamCaption}
\item[{string \&}]{error\_\-msg}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
\label{classFirewallGet_ace67d987d1a1103f6a1c63df7bbae254}


Start operation. 


\begin{DoxyParams}{Parameters}
{\em error\_\-msg} & \hyperlink{protocolthe-p}{the} error message (if error). \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
XORP\_\-OK on success, otherwise XORP\_\-ERROR. 
\end{DoxyReturn}


Implemented in \hyperlink{classFirewallGetDummy_a126255785d4b811e6d82de6f5428cfe3}{FirewallGetDummy}, \hyperlink{classFirewallGetIpfw2_ac43f863aadfb70fe508ae001e33aba29}{FirewallGetIpfw2}, \hyperlink{classFirewallGetNetfilter_aa4d9243eca871d2643b6d0db94fb3723}{FirewallGetNetfilter}, and \hyperlink{classFirewallGetPf_a3ebb9efe03c8a0f51564a3498c73118d}{FirewallGetPf}.

\hypertarget{classFirewallGet_a140a600dc197aa474ffd05a63d05ff43}{
\index{FirewallGet@{FirewallGet}!stop@{stop}}
\index{stop@{stop}!FirewallGet@{FirewallGet}}
\subsubsection[{stop}]{\setlength{\rightskip}{0pt plus 5cm}virtual int FirewallGet::stop (
\begin{DoxyParamCaption}
\item[{string \&}]{error\_\-msg}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
\label{classFirewallGet_a140a600dc197aa474ffd05a63d05ff43}


Stop operation. 


\begin{DoxyParams}{Parameters}
{\em error\_\-msg} & \hyperlink{protocolthe-p}{the} error message (if error). \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
XORP\_\-OK on success, otherwise XORP\_\-ERROR. 
\end{DoxyReturn}


Implemented in \hyperlink{classFirewallGetDummy_abcbb5769a5c2156a284c8a3c6735c17e}{FirewallGetDummy}, \hyperlink{classFirewallGetIpfw2_a95fc06077ec12e9d9ae43d1ca7016d94}{FirewallGetIpfw2}, \hyperlink{classFirewallGetNetfilter_a16dd4b91300fad8fe5f3754107919600}{FirewallGetNetfilter}, and \hyperlink{classFirewallGetPf_a731e14df7d965a47a3302261488356eb}{FirewallGetPf}.



The documentation for this class was generated from the following file:\begin{DoxyCompactItemize}
\item 
/home/greearb/git/xorp.ct.github/xorp/fea/firewall\_\-get.hh\end{DoxyCompactItemize}
