\hypertarget{classIfTreeAddr6}{
\section{IfTreeAddr6 Class Reference}
\label{classIfTreeAddr6}\index{IfTreeAddr6@{IfTreeAddr6}}
}


Class for holding an \hyperlink{classIPv6}{IPv6} interface address and address related items.  




{\ttfamily \#include $<$iftree.hh$>$}

Inheritance diagram for IfTreeAddr6:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=3.000000cm]{classIfTreeAddr6}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classIfTreeAddr6_aa3cf2689be61800c6f9be54d49545f21}{
{\bfseries IfTreeAddr6} (const \hyperlink{classIPv6}{IPv6} \&addr)}
\label{classIfTreeAddr6_aa3cf2689be61800c6f9be54d49545f21}

\item 
\hypertarget{classIfTreeAddr6_a0bbda541e7ab5b47c45752e5a903f84d}{
const \hyperlink{classIPv6}{IPv6} \& {\bfseries addr} () const }
\label{classIfTreeAddr6_a0bbda541e7ab5b47c45752e5a903f84d}

\item 
\hypertarget{classIfTreeAddr6_af06c17b4ab386d901c81c382eb5f9767}{
bool {\bfseries enabled} () const }
\label{classIfTreeAddr6_af06c17b4ab386d901c81c382eb5f9767}

\item 
\hypertarget{classIfTreeAddr6_ad11abfe72590a7e204ab92e2876059f7}{
bool {\bfseries loopback} () const }
\label{classIfTreeAddr6_ad11abfe72590a7e204ab92e2876059f7}

\item 
\hypertarget{classIfTreeAddr6_a246d677deb89cb324d73c345acf3b3b1}{
bool {\bfseries point\_\-to\_\-point} () const }
\label{classIfTreeAddr6_a246d677deb89cb324d73c345acf3b3b1}

\item 
\hypertarget{classIfTreeAddr6_ae52c957f2e55613acdf38696b60cf8f2}{
bool {\bfseries multicast} () const }
\label{classIfTreeAddr6_ae52c957f2e55613acdf38696b60cf8f2}

\item 
\hypertarget{classIfTreeAddr6_adb907cf3c864f9a07ab5553e3c5b2d5f}{
void {\bfseries set\_\-enabled} (bool en)}
\label{classIfTreeAddr6_adb907cf3c864f9a07ab5553e3c5b2d5f}

\item 
\hypertarget{classIfTreeAddr6_ad22c709e6bda5a4b3f2391487b7277e7}{
void {\bfseries set\_\-loopback} (bool v)}
\label{classIfTreeAddr6_ad22c709e6bda5a4b3f2391487b7277e7}

\item 
\hypertarget{classIfTreeAddr6_acc4faf782e013cff49d5f999756f3b72}{
void {\bfseries set\_\-point\_\-to\_\-point} (bool v)}
\label{classIfTreeAddr6_acc4faf782e013cff49d5f999756f3b72}

\item 
\hypertarget{classIfTreeAddr6_a1cbc8100ad6a9ca36b39df6c0ba2db61}{
void {\bfseries set\_\-multicast} (bool v)}
\label{classIfTreeAddr6_a1cbc8100ad6a9ca36b39df6c0ba2db61}

\item 
\hypertarget{classIfTreeAddr6_a7a457f484fe248a1a25566ff1c0c797f}{
uint32\_\-t \hyperlink{classIfTreeAddr6_a7a457f484fe248a1a25566ff1c0c797f}{prefix\_\-len} () const }
\label{classIfTreeAddr6_a7a457f484fe248a1a25566ff1c0c797f}

\begin{DoxyCompactList}\small\item\em Get prefix length associated with address. \item\end{DoxyCompactList}\item 
int \hyperlink{classIfTreeAddr6_a0b55154747847d0406a3b0ff54a585fe}{set\_\-prefix\_\-len} (uint32\_\-t prefix\_\-len)
\begin{DoxyCompactList}\small\item\em Set prefix length associate with address. \item\end{DoxyCompactList}\item 
\hypertarget{classIfTreeAddr6_a6642d6001d6a746774640dad4577dd64}{
\hyperlink{classIPv6}{IPv6} {\bfseries endpoint} () const }
\label{classIfTreeAddr6_a6642d6001d6a746774640dad4577dd64}

\item 
\hypertarget{classIfTreeAddr6_af858a800f76f5470ea392e9f01f3fdcb}{
void {\bfseries set\_\-endpoint} (const \hyperlink{classIPv6}{IPv6} \&oaddr)}
\label{classIfTreeAddr6_af858a800f76f5470ea392e9f01f3fdcb}

\item 
\hypertarget{classIfTreeAddr6_af43c47be24ff1a9e0458a2034d9479dc}{
void \hyperlink{classIfTreeAddr6_af43c47be24ff1a9e0458a2034d9479dc}{copy\_\-state} (const \hyperlink{classIfTreeAddr6}{IfTreeAddr6} \&o)}
\label{classIfTreeAddr6_af43c47be24ff1a9e0458a2034d9479dc}

\begin{DoxyCompactList}\small\item\em Copy state of internal variables from another \hyperlink{classIfTreeAddr6}{IfTreeAddr6}. \item\end{DoxyCompactList}\item 
bool \hyperlink{classIfTreeAddr6_ad1743cae0fa854b9d504a9ec8acd4bd1}{is\_\-same\_\-state} (const \hyperlink{classIfTreeAddr6}{IfTreeAddr6} \&o)
\begin{DoxyCompactList}\small\item\em Test if \hyperlink{protocolthe-p}{the} address-\/specific internal state is same. \item\end{DoxyCompactList}\item 
\hypertarget{classIfTreeAddr6_a9bc2fcf7e36df79f28e89ae6624d7b5b}{
void \hyperlink{classIfTreeAddr6_a9bc2fcf7e36df79f28e89ae6624d7b5b}{finalize\_\-state} ()}
\label{classIfTreeAddr6_a9bc2fcf7e36df79f28e89ae6624d7b5b}

\begin{DoxyCompactList}\small\item\em Virtual method to be implemented to flush out state associated objects, ie if an object is marked CREATED or CHANGED it should be marked NO\_\-CHANGE, if an object is marked DELETED, it should be removed from \hyperlink{protocolthe-p}{the} relevant container and destructed. \item\end{DoxyCompactList}\item 
\hypertarget{classIfTreeAddr6_a5779a3505813a58b04e696c672a01a7e}{
string {\bfseries str} () const }
\label{classIfTreeAddr6_a5779a3505813a58b04e696c672a01a7e}

\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classIfTreeAddr6_a4b30be6750155577040527d108bd1ad2}{
\hyperlink{classIPv6}{IPv6} {\bfseries \_\-addr}}
\label{classIfTreeAddr6_a4b30be6750155577040527d108bd1ad2}

\item 
\hypertarget{classIfTreeAddr6_ab6bb206153c1ec5433f02f82165a35d6}{
bool {\bfseries \_\-enabled}}
\label{classIfTreeAddr6_ab6bb206153c1ec5433f02f82165a35d6}

\item 
\hypertarget{classIfTreeAddr6_a7b29f7e56d1fd8537461a9f77f529784}{
bool {\bfseries \_\-loopback}}
\label{classIfTreeAddr6_a7b29f7e56d1fd8537461a9f77f529784}

\item 
\hypertarget{classIfTreeAddr6_aeeafa4cde46ca41a51784d4f3b5448bf}{
bool {\bfseries \_\-point\_\-to\_\-point}}
\label{classIfTreeAddr6_aeeafa4cde46ca41a51784d4f3b5448bf}

\item 
\hypertarget{classIfTreeAddr6_a3d2a98e8a2b8a6a3c6c92a1bb096db88}{
bool {\bfseries \_\-multicast}}
\label{classIfTreeAddr6_a3d2a98e8a2b8a6a3c6c92a1bb096db88}

\item 
\hypertarget{classIfTreeAddr6_abc354cc697e704de3c5be2b5fe5e5851}{
\hyperlink{classIPv6}{IPv6} {\bfseries \_\-oaddr}}
\label{classIfTreeAddr6_abc354cc697e704de3c5be2b5fe5e5851}

\item 
\hypertarget{classIfTreeAddr6_a8f9604a2b2822046a815476ef63b422f}{
uint32\_\-t {\bfseries \_\-prefix\_\-len}}
\label{classIfTreeAddr6_a8f9604a2b2822046a815476ef63b422f}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
Class for holding an \hyperlink{classIPv6}{IPv6} interface address and address related items. 

\subsection{Member Function Documentation}
\hypertarget{classIfTreeAddr6_ad1743cae0fa854b9d504a9ec8acd4bd1}{
\index{IfTreeAddr6@{IfTreeAddr6}!is\_\-same\_\-state@{is\_\-same\_\-state}}
\index{is\_\-same\_\-state@{is\_\-same\_\-state}!IfTreeAddr6@{IfTreeAddr6}}
\subsubsection[{is\_\-same\_\-state}]{\setlength{\rightskip}{0pt plus 5cm}bool IfTreeAddr6::is\_\-same\_\-state (
\begin{DoxyParamCaption}
\item[{const {\bf IfTreeAddr6} \&}]{o}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classIfTreeAddr6_ad1743cae0fa854b9d504a9ec8acd4bd1}


Test if \hyperlink{protocolthe-p}{the} address-\/specific internal state is same. 


\begin{DoxyParams}{Parameters}
{\em o} & \hyperlink{protocolthe-p}{the} \hyperlink{classIfTreeAddr6}{IfTreeAddr6} to compare against. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if \hyperlink{protocolthe-p}{the} address-\/specific internal state is same. 
\end{DoxyReturn}
\hypertarget{classIfTreeAddr6_a0b55154747847d0406a3b0ff54a585fe}{
\index{IfTreeAddr6@{IfTreeAddr6}!set\_\-prefix\_\-len@{set\_\-prefix\_\-len}}
\index{set\_\-prefix\_\-len@{set\_\-prefix\_\-len}!IfTreeAddr6@{IfTreeAddr6}}
\subsubsection[{set\_\-prefix\_\-len}]{\setlength{\rightskip}{0pt plus 5cm}int IfTreeAddr6::set\_\-prefix\_\-len (
\begin{DoxyParamCaption}
\item[{uint32\_\-t}]{prefix\_\-len}
\end{DoxyParamCaption}
)}}
\label{classIfTreeAddr6_a0b55154747847d0406a3b0ff54a585fe}


Set prefix length associate with address. 

\begin{DoxyReturn}{Returns}
XORP\_\-OK on success, otherwise XORP\_\-ERROR. 
\end{DoxyReturn}


The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
\item 
/home/greearb/git/xorp.ct.github/xorp/fea/iftree.hh\item 
/home/greearb/git/xorp.ct.github/xorp/fea/iftree.cc\end{DoxyCompactItemize}
