\hypertarget{classMrib}{
\section{Mrib Class Reference}
\label{classMrib}\index{Mrib@{Mrib}}
}


The Multicast \hyperlink{classRouting}{Routing} Information Base payload entry.  




{\ttfamily \#include $<$mrib\_\-table.hh$>$}

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{classMrib_a8485e8d0393ff7385ad8dc0202050bcf}{Mrib} (int family)
\begin{DoxyCompactList}\small\item\em Constructor for a given address family. \item\end{DoxyCompactList}\item 
\hyperlink{classMrib_ace7c1aa881795d66280ec1e0b6b3ce7d}{Mrib} (const \hyperlink{classIPvXNet}{IPvXNet} \&dest\_\-prefix)
\begin{DoxyCompactList}\small\item\em Constructor for a given network address prefix. \item\end{DoxyCompactList}\item 
\hyperlink{classMrib_ad91bfcfc41afe11ae7f8bd970473b78a}{Mrib} (const \hyperlink{classMrib}{Mrib} \&mrib)
\begin{DoxyCompactList}\small\item\em Copy constructor for a given \hyperlink{classMrib}{Mrib} entry. \item\end{DoxyCompactList}\item 
bool \hyperlink{classMrib_a09dee2fec97c847624d46c478cbd8b7e}{operator==} (const \hyperlink{classMrib}{Mrib} \&other) const 
\begin{DoxyCompactList}\small\item\em Equality Operator. \item\end{DoxyCompactList}\item 
const \hyperlink{classIPvXNet}{IPvXNet} \& \hyperlink{classMrib_a2dd18c32b60a69ff6ab868ec4b1fbcab}{dest\_\-prefix} () const 
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} network prefix address. \item\end{DoxyCompactList}\item 
void \hyperlink{classMrib_ab6c87d23e09cf875f539c0f84b3ae307}{set\_\-dest\_\-prefix} (const \hyperlink{classIPvXNet}{IPvXNet} \&v)
\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} network prefix address. \item\end{DoxyCompactList}\item 
const \hyperlink{classIPvX}{IPvX} \& \hyperlink{classMrib_af223717a6905d8eb5d264b57d36fe7e6}{next\_\-hop\_\-router\_\-addr} () const 
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} next-\/hop router address. \item\end{DoxyCompactList}\item 
void \hyperlink{classMrib_a5160671ab19868f36c9cf07cc7a07b61}{set\_\-next\_\-hop\_\-router\_\-addr} (const \hyperlink{classIPvX}{IPvX} \&v)
\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} next-\/hop router address. \item\end{DoxyCompactList}\item 
uint32\_\-t \hyperlink{classMrib_a824c585f1e1844f3ecbd885c75bf01e2}{next\_\-hop\_\-vif\_\-index} () const 
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} vif index of \hyperlink{protocolthe-p}{the} interface toward \hyperlink{protocolthe-p}{the} next-\/hop router. \item\end{DoxyCompactList}\item 
void \hyperlink{classMrib_a04894c88dd14e8c7355c22dbffdc99d2}{set\_\-next\_\-hop\_\-vif\_\-index} (uint32\_\-t v)
\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} vif index of \hyperlink{protocolthe-p}{the} interface toward \hyperlink{protocolthe-p}{the} next-\/hop router. \item\end{DoxyCompactList}\item 
uint32\_\-t \hyperlink{classMrib_a09f405c7ba5dac76f9719750459875c3}{metric\_\-preference} () const 
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} metric preference value. \item\end{DoxyCompactList}\item 
void \hyperlink{classMrib_afd2bceb4becadf89a2b19c9486509055}{set\_\-metric\_\-preference} (uint32\_\-t v)
\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} metric preference value. \item\end{DoxyCompactList}\item 
uint32\_\-t \hyperlink{classMrib_a1d62ed7b853ee8fa502045b561c7a2b2}{metric} () const 
\begin{DoxyCompactList}\small\item\em Get \hyperlink{protocolthe-p}{the} metric value. \item\end{DoxyCompactList}\item 
void \hyperlink{classMrib_a7350dea69ee1f3e4a31a4fefe8e0f772}{set\_\-metric} (uint32\_\-t v)
\begin{DoxyCompactList}\small\item\em Set \hyperlink{protocolthe-p}{the} metric value. \item\end{DoxyCompactList}\item 
string \hyperlink{classMrib_aa104ca53e379bbefbe7396e1262323ff}{str} () const 
\begin{DoxyCompactList}\small\item\em Convert this entry from binary form to presentation format. \item\end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{classMrib_a07c279ac1e0cd11ce18babf21e4ad8fa}{
\hyperlink{classIPvXNet}{IPvXNet} {\bfseries \_\-dest\_\-prefix}}
\label{classMrib_a07c279ac1e0cd11ce18babf21e4ad8fa}

\item 
\hypertarget{classMrib_ab6522449d45b717270c7821aabda15e7}{
\hyperlink{classIPvX}{IPvX} {\bfseries \_\-next\_\-hop\_\-router\_\-addr}}
\label{classMrib_ab6522449d45b717270c7821aabda15e7}

\item 
\hypertarget{classMrib_ad6c034e1acc4d4cf16b808b9cb0f46f9}{
uint32\_\-t {\bfseries \_\-next\_\-hop\_\-vif\_\-index}}
\label{classMrib_ad6c034e1acc4d4cf16b808b9cb0f46f9}

\item 
\hypertarget{classMrib_a5b3883ae9375676250bf80e50ad35f29}{
uint32\_\-t {\bfseries \_\-metric\_\-preference}}
\label{classMrib_a5b3883ae9375676250bf80e50ad35f29}

\item 
\hypertarget{classMrib_a3a8d1ff4e22e291319e8e01248080891}{
uint32\_\-t {\bfseries \_\-metric}}
\label{classMrib_a3a8d1ff4e22e291319e8e01248080891}

\end{DoxyCompactItemize}


\subsection{Detailed Description}
The Multicast \hyperlink{classRouting}{Routing} Information Base payload entry. 

\subsection{Constructor \& Destructor Documentation}
\hypertarget{classMrib_a8485e8d0393ff7385ad8dc0202050bcf}{
\index{Mrib@{Mrib}!Mrib@{Mrib}}
\index{Mrib@{Mrib}!Mrib@{Mrib}}
\subsubsection[{Mrib}]{\setlength{\rightskip}{0pt plus 5cm}Mrib::Mrib (
\begin{DoxyParamCaption}
\item[{int}]{family}
\end{DoxyParamCaption}
)}}
\label{classMrib_a8485e8d0393ff7385ad8dc0202050bcf}


Constructor for a given address family. 


\begin{DoxyParams}{Parameters}
{\em family} & \hyperlink{protocolthe-p}{the} address family. \\
\hline
\end{DoxyParams}
\hypertarget{classMrib_ace7c1aa881795d66280ec1e0b6b3ce7d}{
\index{Mrib@{Mrib}!Mrib@{Mrib}}
\index{Mrib@{Mrib}!Mrib@{Mrib}}
\subsubsection[{Mrib}]{\setlength{\rightskip}{0pt plus 5cm}Mrib::Mrib (
\begin{DoxyParamCaption}
\item[{const {\bf IPvXNet} \&}]{dest\_\-prefix}
\end{DoxyParamCaption}
)}}
\label{classMrib_ace7c1aa881795d66280ec1e0b6b3ce7d}


Constructor for a given network address prefix. 


\begin{DoxyParams}{Parameters}
{\em dest\_\-prefix} & \hyperlink{protocolthe-p}{the} network address prefix. \\
\hline
\end{DoxyParams}
\hypertarget{classMrib_ad91bfcfc41afe11ae7f8bd970473b78a}{
\index{Mrib@{Mrib}!Mrib@{Mrib}}
\index{Mrib@{Mrib}!Mrib@{Mrib}}
\subsubsection[{Mrib}]{\setlength{\rightskip}{0pt plus 5cm}Mrib::Mrib (
\begin{DoxyParamCaption}
\item[{const {\bf Mrib} \&}]{mrib}
\end{DoxyParamCaption}
)}}
\label{classMrib_ad91bfcfc41afe11ae7f8bd970473b78a}


Copy constructor for a given \hyperlink{classMrib}{Mrib} entry. 


\begin{DoxyParams}{Parameters}
{\em mrib} & \hyperlink{protocolthe-p}{the} \hyperlink{classMrib}{Mrib} entry to copy. \\
\hline
\end{DoxyParams}


\subsection{Member Function Documentation}
\hypertarget{classMrib_a2dd18c32b60a69ff6ab868ec4b1fbcab}{
\index{Mrib@{Mrib}!dest\_\-prefix@{dest\_\-prefix}}
\index{dest\_\-prefix@{dest\_\-prefix}!Mrib@{Mrib}}
\subsubsection[{dest\_\-prefix}]{\setlength{\rightskip}{0pt plus 5cm}const {\bf IPvXNet}\& Mrib::dest\_\-prefix (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classMrib_a2dd18c32b60a69ff6ab868ec4b1fbcab}


Get \hyperlink{protocolthe-p}{the} network prefix address. 

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} network prefix address. 
\end{DoxyReturn}
\hypertarget{classMrib_a1d62ed7b853ee8fa502045b561c7a2b2}{
\index{Mrib@{Mrib}!metric@{metric}}
\index{metric@{metric}!Mrib@{Mrib}}
\subsubsection[{metric}]{\setlength{\rightskip}{0pt plus 5cm}uint32\_\-t Mrib::metric (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classMrib_a1d62ed7b853ee8fa502045b561c7a2b2}


Get \hyperlink{protocolthe-p}{the} metric value. 

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} metric value. 
\end{DoxyReturn}
\hypertarget{classMrib_a09f405c7ba5dac76f9719750459875c3}{
\index{Mrib@{Mrib}!metric\_\-preference@{metric\_\-preference}}
\index{metric\_\-preference@{metric\_\-preference}!Mrib@{Mrib}}
\subsubsection[{metric\_\-preference}]{\setlength{\rightskip}{0pt plus 5cm}uint32\_\-t Mrib::metric\_\-preference (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classMrib_a09f405c7ba5dac76f9719750459875c3}


Get \hyperlink{protocolthe-p}{the} metric preference value. 

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} metric preference value. 
\end{DoxyReturn}
\hypertarget{classMrib_af223717a6905d8eb5d264b57d36fe7e6}{
\index{Mrib@{Mrib}!next\_\-hop\_\-router\_\-addr@{next\_\-hop\_\-router\_\-addr}}
\index{next\_\-hop\_\-router\_\-addr@{next\_\-hop\_\-router\_\-addr}!Mrib@{Mrib}}
\subsubsection[{next\_\-hop\_\-router\_\-addr}]{\setlength{\rightskip}{0pt plus 5cm}const {\bf IPvX}\& Mrib::next\_\-hop\_\-router\_\-addr (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classMrib_af223717a6905d8eb5d264b57d36fe7e6}


Get \hyperlink{protocolthe-p}{the} next-\/hop router address. 

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} next-\/hop router address. 
\end{DoxyReturn}
\hypertarget{classMrib_a824c585f1e1844f3ecbd885c75bf01e2}{
\index{Mrib@{Mrib}!next\_\-hop\_\-vif\_\-index@{next\_\-hop\_\-vif\_\-index}}
\index{next\_\-hop\_\-vif\_\-index@{next\_\-hop\_\-vif\_\-index}!Mrib@{Mrib}}
\subsubsection[{next\_\-hop\_\-vif\_\-index}]{\setlength{\rightskip}{0pt plus 5cm}uint32\_\-t Mrib::next\_\-hop\_\-vif\_\-index (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classMrib_a824c585f1e1844f3ecbd885c75bf01e2}


Get \hyperlink{protocolthe-p}{the} vif index of \hyperlink{protocolthe-p}{the} interface toward \hyperlink{protocolthe-p}{the} next-\/hop router. 

\begin{DoxyReturn}{Returns}
\hyperlink{protocolthe-p}{the} vif index of \hyperlink{protocolthe-p}{the} interface toward \hyperlink{protocolthe-p}{the} next-\/hop router. 
\end{DoxyReturn}
\hypertarget{classMrib_a09dee2fec97c847624d46c478cbd8b7e}{
\index{Mrib@{Mrib}!operator==@{operator==}}
\index{operator==@{operator==}!Mrib@{Mrib}}
\subsubsection[{operator==}]{\setlength{\rightskip}{0pt plus 5cm}bool Mrib::operator== (
\begin{DoxyParamCaption}
\item[{const {\bf Mrib} \&}]{other}
\end{DoxyParamCaption}
) const}}
\label{classMrib_a09dee2fec97c847624d46c478cbd8b7e}


Equality Operator. 


\begin{DoxyParams}{Parameters}
{\em other} & \hyperlink{protocolthe-p}{the} right-\/hand operand to compare against. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if \hyperlink{protocolthe-p}{the} left-\/hand operand is numerically same as \hyperlink{protocolthe-p}{the} right-\/hand operand. 
\end{DoxyReturn}
\hypertarget{classMrib_ab6c87d23e09cf875f539c0f84b3ae307}{
\index{Mrib@{Mrib}!set\_\-dest\_\-prefix@{set\_\-dest\_\-prefix}}
\index{set\_\-dest\_\-prefix@{set\_\-dest\_\-prefix}!Mrib@{Mrib}}
\subsubsection[{set\_\-dest\_\-prefix}]{\setlength{\rightskip}{0pt plus 5cm}void Mrib::set\_\-dest\_\-prefix (
\begin{DoxyParamCaption}
\item[{const {\bf IPvXNet} \&}]{v}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classMrib_ab6c87d23e09cf875f539c0f84b3ae307}


Set \hyperlink{protocolthe-p}{the} network prefix address. 


\begin{DoxyParams}{Parameters}
{\em v} & \hyperlink{protocolthe-p}{the} value of \hyperlink{protocolthe-p}{the} network prefix address to set. \\
\hline
\end{DoxyParams}
\hypertarget{classMrib_a7350dea69ee1f3e4a31a4fefe8e0f772}{
\index{Mrib@{Mrib}!set\_\-metric@{set\_\-metric}}
\index{set\_\-metric@{set\_\-metric}!Mrib@{Mrib}}
\subsubsection[{set\_\-metric}]{\setlength{\rightskip}{0pt plus 5cm}void Mrib::set\_\-metric (
\begin{DoxyParamCaption}
\item[{uint32\_\-t}]{v}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classMrib_a7350dea69ee1f3e4a31a4fefe8e0f772}


Set \hyperlink{protocolthe-p}{the} metric value. 


\begin{DoxyParams}{Parameters}
{\em v} & \hyperlink{protocolthe-p}{the} value of \hyperlink{protocolthe-p}{the} metric to set. \\
\hline
\end{DoxyParams}
\hypertarget{classMrib_afd2bceb4becadf89a2b19c9486509055}{
\index{Mrib@{Mrib}!set\_\-metric\_\-preference@{set\_\-metric\_\-preference}}
\index{set\_\-metric\_\-preference@{set\_\-metric\_\-preference}!Mrib@{Mrib}}
\subsubsection[{set\_\-metric\_\-preference}]{\setlength{\rightskip}{0pt plus 5cm}void Mrib::set\_\-metric\_\-preference (
\begin{DoxyParamCaption}
\item[{uint32\_\-t}]{v}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classMrib_afd2bceb4becadf89a2b19c9486509055}


Set \hyperlink{protocolthe-p}{the} metric preference value. 


\begin{DoxyParams}{Parameters}
{\em v} & \hyperlink{protocolthe-p}{the} value of \hyperlink{protocolthe-p}{the} metric preference to set. \\
\hline
\end{DoxyParams}
\hypertarget{classMrib_a5160671ab19868f36c9cf07cc7a07b61}{
\index{Mrib@{Mrib}!set\_\-next\_\-hop\_\-router\_\-addr@{set\_\-next\_\-hop\_\-router\_\-addr}}
\index{set\_\-next\_\-hop\_\-router\_\-addr@{set\_\-next\_\-hop\_\-router\_\-addr}!Mrib@{Mrib}}
\subsubsection[{set\_\-next\_\-hop\_\-router\_\-addr}]{\setlength{\rightskip}{0pt plus 5cm}void Mrib::set\_\-next\_\-hop\_\-router\_\-addr (
\begin{DoxyParamCaption}
\item[{const {\bf IPvX} \&}]{v}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classMrib_a5160671ab19868f36c9cf07cc7a07b61}


Set \hyperlink{protocolthe-p}{the} next-\/hop router address. 


\begin{DoxyParams}{Parameters}
{\em v} & \hyperlink{protocolthe-p}{the} value of \hyperlink{protocolthe-p}{the} next-\/hop router address to set. \\
\hline
\end{DoxyParams}
\hypertarget{classMrib_a04894c88dd14e8c7355c22dbffdc99d2}{
\index{Mrib@{Mrib}!set\_\-next\_\-hop\_\-vif\_\-index@{set\_\-next\_\-hop\_\-vif\_\-index}}
\index{set\_\-next\_\-hop\_\-vif\_\-index@{set\_\-next\_\-hop\_\-vif\_\-index}!Mrib@{Mrib}}
\subsubsection[{set\_\-next\_\-hop\_\-vif\_\-index}]{\setlength{\rightskip}{0pt plus 5cm}void Mrib::set\_\-next\_\-hop\_\-vif\_\-index (
\begin{DoxyParamCaption}
\item[{uint32\_\-t}]{v}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily  \mbox{[}inline\mbox{]}}}}
\label{classMrib_a04894c88dd14e8c7355c22dbffdc99d2}


Set \hyperlink{protocolthe-p}{the} vif index of \hyperlink{protocolthe-p}{the} interface toward \hyperlink{protocolthe-p}{the} next-\/hop router. 


\begin{DoxyParams}{Parameters}
{\em v} & \hyperlink{protocolthe-p}{the} value of \hyperlink{protocolthe-p}{the} vif index to set. \\
\hline
\end{DoxyParams}
\hypertarget{classMrib_aa104ca53e379bbefbe7396e1262323ff}{
\index{Mrib@{Mrib}!str@{str}}
\index{str@{str}!Mrib@{Mrib}}
\subsubsection[{str}]{\setlength{\rightskip}{0pt plus 5cm}string Mrib::str (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
) const}}
\label{classMrib_aa104ca53e379bbefbe7396e1262323ff}


Convert this entry from binary form to presentation format. 

\begin{DoxyReturn}{Returns}
C++ string with \hyperlink{protocolthe-p}{the} human-\/readable ASCII representation of \hyperlink{protocolthe-p}{the} entry. 
\end{DoxyReturn}


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