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

\begin{DoxyCompactList}\small\item\em Virtual destructor. \item\end{DoxyCompactList}\item 
\hyperlink{classIfConfig}{IfConfig} \& \hyperlink{classIfConfigGet_a4a6c05ef4453c635c4b505eeeb9786bd}{ifconfig} ()
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} \hyperlink{classIfConfig}{IfConfig} instance. \item\end{DoxyCompactList}\item 
\hyperlink{classFeaDataPlaneManager}{FeaDataPlaneManager} \& \hyperlink{classIfConfigGet_a125bd8a9b82b29685e390d2c22307cd2}{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{classIfConfigGet_ae910a91f599f02bc15ad27497669717e}{is\_\-running} () const 
\begin{DoxyCompactList}\small\item\em Test whether this instance is running. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{classIfConfigGet_a95b2a958057c5427839a2aa0750c17b4}{start} (string \&error\_\-msg)=0
\begin{DoxyCompactList}\small\item\em Start operation. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{classIfConfigGet_a44e082924901b3b4f1b9d0089a12baaa}{stop} (string \&error\_\-msg)=0
\begin{DoxyCompactList}\small\item\em Stop operation. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{classIfConfigGet_a415c2064bf3ad7767ebbe7c8e918d931}{pull\_\-config} (const \hyperlink{classIfTree}{IfTree} $\ast$local\_\-config, \hyperlink{classIfTree}{IfTree} \&iftree)=0
\begin{DoxyCompactList}\small\item\em Pull \hyperlink{protocolthe-p}{the} network interface information from \hyperlink{protocolthe-p}{the} underlying system. \item\end{DoxyCompactList}\item 
\hypertarget{classIfConfigGet_a3b2e441bbed0f535a33814a4f3e3ff84}{
virtual bool \hyperlink{classIfConfigGet_a3b2e441bbed0f535a33814a4f3e3ff84}{can\_\-pull\_\-one} ()}
\label{classIfConfigGet_a3b2e441bbed0f535a33814a4f3e3ff84}

\begin{DoxyCompactList}\small\item\em Child classes that $\ast$can$\ast$ do this should over-\/ride. \item\end{DoxyCompactList}\item 
virtual int \hyperlink{classIfConfigGet_ab266ebb6c6e7ec706acde87bd5b429f8}{pull\_\-config\_\-one} (\hyperlink{classIfTree}{IfTree} \&iftree, const char $\ast$ifname, int if\_\-index)
\begin{DoxyCompactList}\small\item\em If\_\-index can be -\/1 if unknown: We will try to resolve it from ifname. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Protected Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classIfConfigGet_a6da806a1f741e3b583aeb9536bc6f1ff}{
bool {\bfseries \_\-is\_\-running}}
\label{classIfConfigGet_a6da806a1f741e3b583aeb9536bc6f1ff}

\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classIfConfigGet_a7750e11e20a303837d031af47180f6b5}{
\hyperlink{classIfConfig}{IfConfig} \& {\bfseries \_\-ifconfig}}
\label{classIfConfigGet_a7750e11e20a303837d031af47180f6b5}

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

\end{DoxyCompactItemize}


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


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{classIfConfigGet_a125bd8a9b82b29685e390d2c22307cd2}{
\index{IfConfigGet@{IfConfigGet}!fea\_\-data\_\-plane\_\-manager@{fea\_\-data\_\-plane\_\-manager}}
\index{fea\_\-data\_\-plane\_\-manager@{fea\_\-data\_\-plane\_\-manager}!IfConfigGet@{IfConfigGet}}
\subsubsection[{fea\_\-data\_\-plane\_\-manager}]{\setlength{\rightskip}{0pt plus 5cm}{\bf FeaDataPlaneManager}\& IfConfigGet::fea\_\-data\_\-plane\_\-manager (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classIfConfigGet_a125bd8a9b82b29685e390d2c22307cd2}


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

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


Get \hyperlink{protocolthe-p}{the} \hyperlink{classIfConfig}{IfConfig} instance. 

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


Test whether this instance is running. 

\begin{DoxyReturn}{Returns}
true if \hyperlink{protocolthe-p}{the} instance is running, otherwise false. 
\end{DoxyReturn}
\hypertarget{classIfConfigGet_a415c2064bf3ad7767ebbe7c8e918d931}{
\index{IfConfigGet@{IfConfigGet}!pull\_\-config@{pull\_\-config}}
\index{pull\_\-config@{pull\_\-config}!IfConfigGet@{IfConfigGet}}
\subsubsection[{pull\_\-config}]{\setlength{\rightskip}{0pt plus 5cm}virtual int IfConfigGet::pull\_\-config (
\begin{DoxyParamCaption}
\item[{const {\bf IfTree} $\ast$}]{local\_\-config, }
\item[{{\bf IfTree} \&}]{iftree}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
\label{classIfConfigGet_a415c2064bf3ad7767ebbe7c8e918d931}


Pull \hyperlink{protocolthe-p}{the} network interface information from \hyperlink{protocolthe-p}{the} underlying system. 


\begin{DoxyParams}{Parameters}
{\em local\_\-config} & If not NULL, optimized ifconfig-\/get subclasses may pull interface config for only interfaces found in local\_\-config. Set to NULl to pull all information from \hyperlink{protocolthe-p}{the} kernel. \\
\hline
{\em iftree} & \hyperlink{protocolthe-p}{the} \hyperlink{classIfTree}{IfTree} storage to store \hyperlink{protocolthe-p}{the} pulled information. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
XORP\_\-OK on success, otherwise XORP\_\-ERROR. 
\end{DoxyReturn}


Implemented in \hyperlink{classIfConfigGetDummy_a935abc5bca6104daa92e46a55cb2647b}{IfConfigGetDummy}, \hyperlink{classIfConfigGetGetifaddrs_a7c38391bec67ebd1b3025962161acf83}{IfConfigGetGetifaddrs}, \hyperlink{classIfConfigGetIPHelper_aa0ea91e1beb386fedb0eda4f459e9857}{IfConfigGetIPHelper}, and \hyperlink{classIfConfigGetSysctl_a28069b35a602fd997934ee5667bef1c7}{IfConfigGetSysctl}.

\hypertarget{classIfConfigGet_ab266ebb6c6e7ec706acde87bd5b429f8}{
\index{IfConfigGet@{IfConfigGet}!pull\_\-config\_\-one@{pull\_\-config\_\-one}}
\index{pull\_\-config\_\-one@{pull\_\-config\_\-one}!IfConfigGet@{IfConfigGet}}
\subsubsection[{pull\_\-config\_\-one}]{\setlength{\rightskip}{0pt plus 5cm}virtual int IfConfigGet::pull\_\-config\_\-one (
\begin{DoxyParamCaption}
\item[{{\bf IfTree} \&}]{iftree, }
\item[{const char $\ast$}]{ifname, }
\item[{int}]{if\_\-index}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline, virtual\mbox{]}}}}
\label{classIfConfigGet_ab266ebb6c6e7ec706acde87bd5b429f8}


If\_\-index can be -\/1 if unknown: We will try to resolve it from ifname. 

Child classes that can do this should implement \hyperlink{protocolthe-p}{the} method. \hypertarget{classIfConfigGet_a95b2a958057c5427839a2aa0750c17b4}{
\index{IfConfigGet@{IfConfigGet}!start@{start}}
\index{start@{start}!IfConfigGet@{IfConfigGet}}
\subsubsection[{start}]{\setlength{\rightskip}{0pt plus 5cm}virtual int IfConfigGet::start (
\begin{DoxyParamCaption}
\item[{string \&}]{error\_\-msg}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}pure virtual\mbox{]}}}}
\label{classIfConfigGet_a95b2a958057c5427839a2aa0750c17b4}


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{classIfConfigGetDummy_af073dddf1b2259d06c5cf4c84e28d7fc}{IfConfigGetDummy}, \hyperlink{classIfConfigGetGetifaddrs_a91f77020e7e8d8680db745047e80f587}{IfConfigGetGetifaddrs}, \hyperlink{classIfConfigGetIPHelper_a8763da4b85f2ba92fd96d5c501fcb5f0}{IfConfigGetIPHelper}, and \hyperlink{classIfConfigGetSysctl_a2c450da374a63aa9e700555fa3c9de97}{IfConfigGetSysctl}.

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


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{classIfConfigGetDummy_ad2ee04f4e2e7a4e11b6cabef5adda0c8}{IfConfigGetDummy}, \hyperlink{classIfConfigGetGetifaddrs_adb729cfa9209eb01096b57c0b9be8c20}{IfConfigGetGetifaddrs}, \hyperlink{classIfConfigGetIPHelper_a4332f057ecfbdbc356f7666034bf6b02}{IfConfigGetIPHelper}, and \hyperlink{classIfConfigGetSysctl_a613b9523ad69984c86b3eb60fc2ef07a}{IfConfigGetSysctl}.



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