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

\begin{DoxyCompactList}\small\item\em Virtual destructor. \item\end{DoxyCompactList}\item 
\hyperlink{classFirewallManager}{FirewallManager} \& \hyperlink{classFirewallSet_ae981cb3f97acdfd1ab64da2030757d83}{firewall\_\-manager} ()
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} \hyperlink{classFirewallManager}{FirewallManager} instance. \item\end{DoxyCompactList}\item 
\hyperlink{classFeaDataPlaneManager}{FeaDataPlaneManager} \& \hyperlink{classFirewallSet_aec33b8324a266ee0098fd13e6806c937}{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{classFirewallSet_a3dccce23626a469aa29baeac91d5eae0}{is\_\-running} () const 
\begin{DoxyCompactList}\small\item\em Test whether this instance is running. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{classFirewallSet_a25410e7217c75e821bc10a484ae25c2f}{start} (string \&error\_\-msg)=0
\begin{DoxyCompactList}\small\item\em Start operation. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{classFirewallSet_af9d73517c447d2c87c4325800719a5c4}{stop} (string \&error\_\-msg)=0
\begin{DoxyCompactList}\small\item\em Stop operation. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{classFirewallSet_a2a35640219f0a1505c7116eacf96034c}{update\_\-entries} (const list$<$ \hyperlink{classFirewallEntry}{FirewallEntry} $>$ \&added\_\-entries, const list$<$ \hyperlink{classFirewallEntry}{FirewallEntry} $>$ \&replaced\_\-entries, const list$<$ \hyperlink{classFirewallEntry}{FirewallEntry} $>$ \&deleted\_\-entries, string \&error\_\-msg)=0
\begin{DoxyCompactList}\small\item\em Update \hyperlink{protocolthe-p}{the} firewall entries by pushing them into \hyperlink{protocolthe-p}{the} underlying system. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{classFirewallSet_aeffd9dba73bbafa7499f373672d7aa42}{set\_\-table4} (const list$<$ \hyperlink{classFirewallEntry}{FirewallEntry} $>$ \&firewall\_\-entry\_\-list, string \&error\_\-msg)=0
\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} \hyperlink{classIPv4}{IPv4} firewall table. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{classFirewallSet_af5a3ce3d8cff159aa3a7d490575df65f}{delete\_\-all\_\-entries4} (string \&error\_\-msg)=0
\begin{DoxyCompactList}\small\item\em Delete all entries in \hyperlink{protocolthe-p}{the} \hyperlink{classIPv4}{IPv4} firewall table. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{classFirewallSet_af75142807ba8aaa93e7bf8308ae18d55}{set\_\-table6} (const list$<$ \hyperlink{classFirewallEntry}{FirewallEntry} $>$ \&firewall\_\-entry\_\-list, string \&error\_\-msg)=0
\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} \hyperlink{classIPv6}{IPv6} firewall table. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{classFirewallSet_a63e816f562f4fcc4fcb78cd6fc4f1973}{delete\_\-all\_\-entries6} (string \&error\_\-msg)=0
\begin{DoxyCompactList}\small\item\em Delete all entries in \hyperlink{protocolthe-p}{the} \hyperlink{classIPv6}{IPv6} firewall table. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classFirewallSet_ab0d4222f1c9a9030ce384f8de4df237a}{
bool {\bfseries \_\-is\_\-running}}
\label{classFirewallSet_ab0d4222f1c9a9030ce384f8de4df237a}

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

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

\end{DoxyCompactItemize}


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


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{classFirewallSet_af5a3ce3d8cff159aa3a7d490575df65f}{
\index{FirewallSet@{FirewallSet}!delete\_\-all\_\-entries4@{delete\_\-all\_\-entries4}}
\index{delete\_\-all\_\-entries4@{delete\_\-all\_\-entries4}!FirewallSet@{FirewallSet}}
\subsubsection[{delete\_\-all\_\-entries4}]{\setlength{\rightskip}{0pt plus 5cm}virtual int FirewallSet::delete\_\-all\_\-entries4 (
\begin{DoxyParamCaption}
\item[{string \&}]{error\_\-msg}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
\label{classFirewallSet_af5a3ce3d8cff159aa3a7d490575df65f}


Delete all entries in \hyperlink{protocolthe-p}{the} \hyperlink{classIPv4}{IPv4} firewall table. 


\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{classFirewallSetDummy_aed32efff23faaea485fab47e47805fda}{FirewallSetDummy}, \hyperlink{classFirewallSetIpfw2_a429a107f01c4a41ff17a88e49ab62f82}{FirewallSetIpfw2}, \hyperlink{classFirewallSetNetfilter_aff3fb43385cad3a812f3a5c53fe2fd8e}{FirewallSetNetfilter}, and \hyperlink{classFirewallSetPf_ae5a86a5eec002b5f048a54f7c1690492}{FirewallSetPf}.

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


Delete all entries in \hyperlink{protocolthe-p}{the} \hyperlink{classIPv6}{IPv6} firewall table. 


\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{classFirewallSetDummy_a0a6d2cbf315f3a277c2ccfaff3cce976}{FirewallSetDummy}, \hyperlink{classFirewallSetIpfw2_a2a0896f9539c618a5f949ca33203ae62}{FirewallSetIpfw2}, \hyperlink{classFirewallSetNetfilter_aee6b3fe57eb24cce053d9844dbee3abd}{FirewallSetNetfilter}, and \hyperlink{classFirewallSetPf_aab23049e9f933390db66c16b58a4b0ed}{FirewallSetPf}.

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


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

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


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

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} \hyperlink{classFirewallManager}{FirewallManager} instance. 
\end{DoxyReturn}
\hypertarget{classFirewallSet_a3dccce23626a469aa29baeac91d5eae0}{
\index{FirewallSet@{FirewallSet}!is\_\-running@{is\_\-running}}
\index{is\_\-running@{is\_\-running}!FirewallSet@{FirewallSet}}
\subsubsection[{is\_\-running}]{\setlength{\rightskip}{0pt plus 5cm}virtual bool FirewallSet::is\_\-running (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline, virtual\mbox{]}}}}
\label{classFirewallSet_a3dccce23626a469aa29baeac91d5eae0}


Test whether this instance is running. 

\begin{DoxyReturn}{Returns}
true if \hyperlink{protocolthe-p}{the} instance is running, otherwise false. 
\end{DoxyReturn}
\hypertarget{classFirewallSet_aeffd9dba73bbafa7499f373672d7aa42}{
\index{FirewallSet@{FirewallSet}!set\_\-table4@{set\_\-table4}}
\index{set\_\-table4@{set\_\-table4}!FirewallSet@{FirewallSet}}
\subsubsection[{set\_\-table4}]{\setlength{\rightskip}{0pt plus 5cm}virtual int FirewallSet::set\_\-table4 (
\begin{DoxyParamCaption}
\item[{const list$<$ {\bf FirewallEntry} $>$ \&}]{firewall\_\-entry\_\-list, }
\item[{string \&}]{error\_\-msg}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
\label{classFirewallSet_aeffd9dba73bbafa7499f373672d7aa42}


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


\begin{DoxyParams}{Parameters}
{\em firewall\_\-entry\_\-list} & \hyperlink{protocolthe-p}{the} list with all entries to install into \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{classFirewallSetDummy_a02d559236bf8fe30f35f2b17165e3332}{FirewallSetDummy}, \hyperlink{classFirewallSetIpfw2_a5d986e980f1f65920bfa480bbc55e84c}{FirewallSetIpfw2}, \hyperlink{classFirewallSetNetfilter_a8f757d45490c6418a778b75401250a04}{FirewallSetNetfilter}, and \hyperlink{classFirewallSetPf_a3d87deb02e0548f68a001d611e294aa9}{FirewallSetPf}.

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


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


\begin{DoxyParams}{Parameters}
{\em firewall\_\-entry\_\-list} & \hyperlink{protocolthe-p}{the} list with all entries to install into \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{classFirewallSetDummy_a83857403d1e9d4e417a729646b2525ec}{FirewallSetDummy}, \hyperlink{classFirewallSetIpfw2_ad92a8344cfa1472bec8dd0d65bb35a69}{FirewallSetIpfw2}, \hyperlink{classFirewallSetNetfilter_a87ac5ae6e5eec2c0db2c3ea0d3f6114c}{FirewallSetNetfilter}, and \hyperlink{classFirewallSetPf_ade848185551395fa744fdd28391636aa}{FirewallSetPf}.

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


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{classFirewallSetDummy_abcc7d97b80f2f11add72142578c0d1fd}{FirewallSetDummy}, \hyperlink{classFirewallSetIpfw2_a0597bb7af41985f0dfde7ed48d7013d4}{FirewallSetIpfw2}, \hyperlink{classFirewallSetNetfilter_afa334566f44a7902f269aac6f704aa32}{FirewallSetNetfilter}, and \hyperlink{classFirewallSetPf_a0990e1bdd76d714d4bf6a4db2051eedd}{FirewallSetPf}.

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


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{classFirewallSetDummy_a62b96a7ecda8b0ae8474d003ac0ec55d}{FirewallSetDummy}, \hyperlink{classFirewallSetIpfw2_abf8892d1c6275bfbb540c39814c44261}{FirewallSetIpfw2}, \hyperlink{classFirewallSetNetfilter_a0398464c8d09d674c9b4ab186c5e49b6}{FirewallSetNetfilter}, and \hyperlink{classFirewallSetPf_a15bfbb6e748be568f895543f47daf5fd}{FirewallSetPf}.

\hypertarget{classFirewallSet_a2a35640219f0a1505c7116eacf96034c}{
\index{FirewallSet@{FirewallSet}!update\_\-entries@{update\_\-entries}}
\index{update\_\-entries@{update\_\-entries}!FirewallSet@{FirewallSet}}
\subsubsection[{update\_\-entries}]{\setlength{\rightskip}{0pt plus 5cm}virtual int FirewallSet::update\_\-entries (
\begin{DoxyParamCaption}
\item[{const list$<$ {\bf FirewallEntry} $>$ \&}]{added\_\-entries, }
\item[{const list$<$ {\bf FirewallEntry} $>$ \&}]{replaced\_\-entries, }
\item[{const list$<$ {\bf FirewallEntry} $>$ \&}]{deleted\_\-entries, }
\item[{string \&}]{error\_\-msg}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
\label{classFirewallSet_a2a35640219f0a1505c7116eacf96034c}


Update \hyperlink{protocolthe-p}{the} firewall entries by pushing them into \hyperlink{protocolthe-p}{the} underlying system. 


\begin{DoxyParams}{Parameters}
{\em added\_\-entries} & \hyperlink{protocolthe-p}{the} entries to add. \\
\hline
{\em replaced\_\-entries} & \hyperlink{protocolthe-p}{the} entries to replace. \\
\hline
{\em deleted\_\-entries} & \hyperlink{protocolthe-p}{the} deleted entries. \\
\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{classFirewallSetDummy_a70e33dad0344ca34e3b685e1e4a620a6}{FirewallSetDummy}, \hyperlink{classFirewallSetIpfw2_abb09e5209e7e00b80de6a90a180966f1}{FirewallSetIpfw2}, \hyperlink{classFirewallSetNetfilter_aa9373823c8c836a7101be1c86bde5b37}{FirewallSetNetfilter}, and \hyperlink{classFirewallSetPf_ae820faa91fcd2a57025d4da6f123102e}{FirewallSetPf}.



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